gmslLibrary.Services.PostingPair Class Reference

The PostingPair class manages a small integer SortPair used for looking up links and relationships betweeen components in storage based on their defining root offsets. The information structure associated with posting pairs itself is allocated locally on the stack and is never left open; therefore, posting pairs do not have handles and are controlled entirely via their root offsets. More...

Public Member Functions
	PostingPair (int Store)
	The constructure creates a Posting pair in a specified storage area. More...
int	Find (int Index)
	The Find method looks up the posting value associated with a posting index in a posting pair. More...
int	Write (int Index, int Posting)
	The Write method writes an index, posting pair to the posting set. More...

Detailed Description

The PostingPair class manages a small integer SortPair used for looking up links and relationships betweeen components in storage based on their defining root offsets. The information structure associated with posting pairs itself is allocated locally on the stack and is never left open; therefore, posting pairs do not have handles and are controlled entirely via their root offsets.

Constructor & Destructor Documentation

PostingPair()

gmslLibrary.Services.PostingPair.PostingPair

(

int

Store

)

The constructure creates a Posting pair in a specified storage area.

Parameters

Store

specifies the handle for the storage area that is to contain the posting pair.

Member Function Documentation

Find()

int gmslLibrary.Services.PostingPair.Find

(

int

Index

)

The Find method looks up the posting value associated with a posting index in a posting pair.

Parameters

Index

specifies the index value for which a corresponding posting value is desired.

Returns

If the posting pair contains an entry for the index, then its associated value is returned; else a zero is returned.

Write()

int gmslLibrary.Services.PostingPair.Write	(	int	Index,
		int	Posting
	)

The Write method writes an index, posting pair to the posting set.

Parameters

Index	specifies the index value of the pair.
Posting	specifies the post value of the pait.

---

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

• C:/gmProducts/gmStudio_dev/src/gmslAPI/gmslLibrary/PostingPair.cs