Copy link to this section Properties
Copy link to this section
property DocKey as %Integer ;
This holds the document key
Property methods: DocKeyDisplayToLogical(), DocKeyGet(), DocKeyIsValid(), DocKeyLogicalToDisplay(), DocKeyNormalize(), DocKeyOnlyDisplayToLogical(), DocKeyOnlyGet(), DocKeyOnlyIsValid(), DocKeyOnlyLogicalToDisplay(), DocKeyOnlyNormalize(), DocKeyOnlySet(), DocKeySet()
Copy link to this section
property DocKeyOnly as %Boolean ;
Quit after discovering the DocKey
Property methods: DocKeyOnlyDisplayToLogical(), DocKeyOnlyGet(), DocKeyOnlyIsValid(), DocKeyOnlyLogicalToDisplay(), DocKeyOnlyNormalize(), DocKeyOnlySet()
Copy link to this section
property Error as %Status [ InitialExpression = $$$OK ];
This holds error messages
Property methods: Error(), ErrorGet(), ErrorIsValid(), ErrorLogicalToOdbc(), ErrorSet()
Copy link to this section
property Line as %String ;
This holds the current line
Property methods: LineDisplayToLogical(), LineGet(), LineIsValid(), LineLogicalToDisplay(), LineLogicalToOdbc(), LineNormalize(), LineNumberDisplayToLogical(), LineNumberGet(), LineNumberIsValid(), LineNumberLogicalToDisplay(), LineNumberNormalize(), LineNumberSet(), LineSet()
Copy link to this section
property LineNumber as %Integer [ InitialExpression = 0 ];
This holds the current line number
Property methods: LineNumberDisplayToLogical(), LineNumberGet(), LineNumberIsValid(), LineNumberLogicalToDisplay(), LineNumberNormalize(), LineNumberSet()
Copy link to this section
property NextState as %String ;
This holds the next state of the machine
Property methods: NextStateDisplayToLogical(), NextStateGet(), NextStateIsValid(), NextStateLogicalToDisplay(), NextStateLogicalToOdbc(), NextStateNormalize(), NextStateSet()
Copy link to this section
property PrevState as %String ;
This holds the previous state of the machine
Property methods: PrevStateDisplayToLogical(), PrevStateGet(), PrevStateIsValid(), PrevStateLogicalToDisplay(), PrevStateLogicalToOdbc(), PrevStateNormalize(), PrevStateSet()
Copy link to this section
property PrivateSection as %Integer [ InitialExpression = 0 ];
This holds the PRIVATE section flag
Property methods: PrivateSectionDisplayToLogical(), PrivateSectionGet(), PrivateSectionIsValid(), PrivateSectionLogicalToDisplay(), PrivateSectionNormalize(), PrivateSectionSet()
Copy link to this section
property Sections as %String [ MultiDimensional ];
This holds the allowed sections in this file
Property methods: SectionsDisplayToLogical(), SectionsGet(), SectionsIsValid(), SectionsLogicalToDisplay(), SectionsLogicalToOdbc(), SectionsNormalize(), SectionsSet()
Copy link to this section
property Status as %Integer [ InitialExpression = $$$StateRunning ];
This holds the status of the machine
Property methods: StatusDisplayToLogical(), StatusGet(), StatusIsValid(), StatusLogicalToDisplay(), StatusNormalize(), StatusSet()
This holds the File Stream
Property methods: StreamDelete(), StreamGet(), StreamGetObject(), StreamGetObjectId(), StreamGetSwizzled(), StreamIsValid(), StreamNewObject(), StreamOid(), StreamOpen(), StreamSet(), StreamSetObject(), StreamSetObjectId(), StreamUnSwizzle()
Copy link to this section
property Trace as %Boolean [ InitialExpression = 0 ];
This holds the Trace flag. Set to 1 to output trace to console
Property methods: TraceDisplayToLogical(), TraceGet(), TraceIsValid(), TraceLogicalToDisplay(), TraceNormalize(), TraceSet()
Copy link to this section
property Version as %String [ InitialExpression = "1.0" ];
This holds the version
Property methods: VersionDisplayToLogical(), VersionGet(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
Copy link to this section Methods
Inherited description: This callback method is invoked by the
%New() method to
provide notification that a new instance of an object is being created.
If this method returns an error then the object will not be created.
It is passed the arguments provided in the %New call.
When customizing this method, override the arguments with whatever variables and types you expect to receive from %New().
For example, if you're going to call %New, passing 2 arguments, %OnNew's signature could be:
Method %OnNew(dob as %Date = "", name as %Name = "") as %Status
If instead of returning a %Status code this returns an oref and this oref is a subclass of the current
class then this oref will be the one returned to the caller of %New method.
Copy link to this section
method CODES(pPrevState As %String )
This handes the CODES section
Copy link to this section
method CODESLINE() as %Status
This is the processor for a single CODES line
Copy link to this section
method COMS(pPrevState As %String )
This method handles the COMS section
Copy link to this section
method COMSLINE() as %Status
This is the processor for a single COMS line
Copy link to this section
method Dispatch() as %String
Read a line and dispatch to the section
Copy link to this section
method ELMS(pPrevState As %String )
This handes the ELMS section
Copy link to this section
method ELMSLINE() as %Status
This is the processor for a single ELMS line
Copy link to this section
method EOF(pPrevState As %String )
This handles the EOF state
Copy link to this section
method Error(pPrevState As %String )
This handles the Error state
Copy link to this section
method INI(pPrevState As %String )
This handles the INI section
Import the named file
Copy link to this section
method NextStateSet(pState As %String ) as %Status
Copy link to this section
method OBJVARS(pPrevState As %String )
This method handles the OBJVARS section
Copy link to this section
method OBJVARSLINE() as %Status
This is the processor for a single OBJVARS line
Copy link to this section
method OVERHEAD(pPrevState As %String )
This method handes the OVERHEAD section
Copy link to this section
method OVERHEADLINE() as %Status
This is the processor for a single OBJVARS line
Copy link to this section
method PRIVATE(pPrevState As %String )
This method handles the PRIVATE section
Copy link to this section
method PRIVATELINE() as %Status
This is the processor for a single PRIVATE line
Copy link to this section
method PUBLIC(pPrevState As %String )
This method handles a PUBLIC declaration if no PRIVATE is present in the file
Copy link to this section
method ProcessSectionBody(pLineHandler As %String ) as %String
This method processes a section by reading lines, validating them
and returning the next state to invoke
Copy link to this section
method ReadLine(ByRef pStatus As %Status ) as %Boolean
This Reads the next line from the file
Copy link to this section
method SEGS(pPrevState As %String )
This method handles the SEGS section
Copy link to this section
method SEGSLINE() as %Status
This is the processor for a single SEGS line
Copy link to this section
method SEMREFS(pPrevState As %String )
This method handes the SEMREFS section
Copy link to this section
method SEMREFSLINE() as %Status
This is the processor for a single SEMREFS line
Copy link to this section
method SETS(pPrevState As %String )
This method handles the SETS section
Copy link to this section
method SETSLINE() as %Status
This is the processor for a single SETS line
Copy link to this section
method STD(pPrevState As %String )
This method handes the STD section
Copy link to this section
method Section(ByRef pSection As %String ) as %Status
Copy link to this section
method Start(pPrevState As %String )
Copy link to this section
method Stop(pPrevState As %String )
This handles the Stop state
Copy link to this section
method TEXTCOMS(pPrevState As %String )
This method handes the TEXTCOMS section
Copy link to this section
method TEXTCOMSLINE() as %Status
This is the processor for a single TEXTCOMS line
Copy link to this section
method TEXTELMS(pPrevState As %String )
This method handes the TEXTELMS section
Copy link to this section
method TEXTELMSLINE() as %Status
This is the processor for a single TEXTELMS line
Copy link to this section
method TEXTSEGS(pPrevState As %String )
This method handes the TEXTSEGS section
Copy link to this section
method TEXTSEGSLINE() as %Status
This is the processor for a single TEXTSEGS line
Copy link to this section
method TEXTSETS(pPrevState As %String )
This method handes the TEXTSETS section
Copy link to this section
method TEXTSETSLINE() as %Status
This is the processor for a single TEXTSETS line
Copy link to this section
method VALLISTS(pPrevState As %String )
This method handes the VALLISTS section
Copy link to this section
method VALREFS(pPrevState As %String )
This method handes the VALREFS section
Copy link to this section
method VALREFSLINE() as %Status
This is the processor for a single VALREFS line
Copy link to this section
method VER(pPrevState As %String )
This method handles the VER state