Skip to main content

Inventory.RoutineComponent

Class Inventory.RoutineComponent Extends (Component, Hashable) [ Inheritance = right ]

RoutineComponent is a subclass of Component. An instance represents a routine.

It contains properties representing the routine's name, size, an optional InventoryRecord, and a SHA1 hash of the routine's compiled code.

Parameters​

XMLNAME​

Parameter XMLNAME = "RoutineComponent";

The element name used in the XML representation of the component.

XMLTYPE​

Parameter XMLTYPE = "RoutineComponent";

The identifier used to distinguish the type of this component in the XML representation.

Properties​

InventoryRecord​

Property InventoryRecord As %String(MAXLEN = 256);

The contents of an optional tagged comment inside the routine represented by this RoutineComponent, used to track its origins.

Size​

Property Size As %Integer;

The size of the compiled code, in bytes, of the routine represented by this RoutineComponent.

Methods​

GenerateSHA1Hash​

Method GenerateSHA1Hash(string As %String)

Retrieve the system-generated CRC for the routine and store it as the SHA1Hash property of this object.
string is assumed to be the value of the ^rOBJ node of the routine.

FindInventoryRecord​

Method FindInventoryRecord(rtnData As %String)

Scans the routine represented by this RoutineComponent for a comment string beginning with ";; ISC-TAG:". If present, sets the InventoryRecord property of this object to the remainder of the string.

Strings​

Method Strings(data As %String, minLen As %String = 4, tag As %String = "") As %List [ Private ]

Extract strings from input data and return as a $LIST

minlen specifies how long the string must be to be selected

tag specifies the bytes that must be contained in the string to be selected