gmslAPI  0.1
gmslAPI: An API for Developing Upgrade Solutions using Great Migrations Technology
gmslLibrary.Services.CodePattern Class Reference

The CodePattern class processes decriptions of operation sequences stored within compiled tCodeBlock code sequences. It contains methods to process a notation for doing code sequence content tests. More...

Static Public Member Functions

static int Match (int icode, tCodeBlock codeBlock)
 The Match method checks if a sequence of operation codes in the main code storage area matches a code pattern. More...
 
static tCodeBlock Read (string source, ref int nCode)
 The Read method reads a simplified representation of a code pattern into a block. More...
 

Detailed Description

The CodePattern class processes decriptions of operation sequences stored within compiled tCodeBlock code sequences. It contains methods to process a notation for doing code sequence content tests.

Member Function Documentation

◆ Match()

static int gmslLibrary.Services.CodePattern.Match ( int  icode,
tCodeBlock  codeBlock 
)
static

The Match method checks if a sequence of operation codes in the main code storage area matches a code pattern.

Parameters
icodespecifies the start of the actual operation codes in main code block to be matched.
codeBlockcontains the operation code pattern to be matched.
Returns
If a match is made, then the method returns the offset of the first byte in the main code block beyond the end of the match. If no match is made, the method returns zero.

◆ Read()

static tCodeBlock gmslLibrary.Services.CodePattern.Read ( string  source,
ref int  nCode 
)
static

The Read method reads a simplified representation of a code pattern into a block.

Parameters
sourcecontains the source representation of the code pattern.
nCodereturns the length of the compiled code pattern or a negative error code.
Returns
The method tCodeBlock instance that contains the compilerd form of the code pattern.

The documentation for this class was generated from the following file: