The Sequence class offers simple read-only access to sequences stored in long memory. A "sequence" is an open ended list of entries. In this case the entries themselves all consist of a single integer value. Entries in the sequence are numbered starting at one. More...

Public Member Functions
int	Access (int iEntry)
	The access method returns the value stored at a specified entry number within the sequence. More...

void	Close ()
	The Close method closes the sequence and returns any system resources being used by it. This method should be called when ever the application has completed its use of the sequence. More...

int	GetLength ()
	The GetLength method returns the number of entries currently in the sequence. More...

	Sequence (int root)
	The Sequence constructor initiates access to a sequence stored in the current storage area starting at a known root offset. Sequences do use system resourses and should always be explicitly closed when no longer needed. More...

Detailed Description

The Sequence class offers simple read-only access to sequences stored in long memory. A "sequence" is an open ended list of entries. In this case the entries themselves all consist of a single integer value. Entries in the sequence are numbered starting at one.

Constructor & Destructor Documentation

◆ Sequence()

gmslLibrary.Services.Sequence.Sequence ( int root )

The Sequence constructor initiates access to a sequence stored in the current storage area starting at a known root offset. Sequences do use system resourses and should always be explicitly closed when no longer needed.

Parameters

root	specifies the root offset of the sequence in the current storage area.

Member Function Documentation

◆ Access()

int gmslLibrary.Services.Sequence.Access ( int iEntry )

The access method returns the value stored at a specified entry number within the sequence.

Parameters

iEntry specifies the entry number, relative to one, of the desired value.

◆ Close()

void gmslLibrary.Services.Sequence.Close ( )

The Close method closes the sequence and returns any system resources being used by it. This method should be called when ever the application has completed its use of the sequence.

◆ GetLength()

int gmslLibrary.Services.Sequence.GetLength ( )

The GetLength method returns the number of entries currently in the sequence.

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

C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/Sequence.cs