gmslLibrary.Model.tReference Class Reference

The class tReference records individual component references in the source code. More...

Public Member Functions
	tReference ()
	The tReference constuctor with no parameters merely initializes a tReference instant with zero field values. More...
	tReference (int symbolRoot, tPostSet PostSet)
	The tReference constructor with a specified symbolRoot returns the first reference record for a given symbol or for any symbol as stored earlier. More...
	tReference (tPostSet PostSet)
	The tReference constructor with a single PostSet parameter iterates forward in the references record set once a call to FirstReference has established a starting record. During compilation symbol references are stored in a reference record set sorted in ascending order by the root of the symbol being referenced. More...
void	Store ()
	The method Store stores the reference record in the current storage area. The storage area maintains a sorted list of reference records sorted by the offset of the symbol being referenced. During the compilation process symbols are encountered by a referencing component. This method is used to order them by the component being referenced so that those references can be used by the analyser. More...

Properties
int	MakesRef [get, set]
	The integer MakesRef property specifies the root of the component containing the reference. More...
int	BeingRefd [get, set]
	The integer BeingRefd property specifies the root of the component being referenced. More...
int	RecNumber [get, set]
	The integer RecNumber property specifies the text record number in the host file of the reference. More...
int	CodeOffset [get, set]
	The integer CodeOffset property specifies the offset in the compiled code of the referencing code. More...
int	HostFile [get, set]
	The integer HostFile property specifies the root of the information file containing the subprogram. More...
int	Terminal [get, set]
	If the reference treated the component as terminal then the integer property Terminal is one, else it is zero. More...

Detailed Description

The class tReference records individual component references in the source code.

Constructor & Destructor Documentation

tReference() [1/3]

gmslLibrary.Model.tReference.tReference

(

)

The tReference constuctor with no parameters merely initializes a tReference instant with zero field values.

tReference() [2/3]

gmslLibrary.Model.tReference.tReference	(	int	symbolRoot,
		tPostSet	PostSet
	)

The tReference constructor with a specified symbolRoot returns the first reference record for a given symbol or for any symbol as stored earlier.

Parameters

symbolRoot	specifies the offset of the symbol for which references are desired. If it is zero, then all references are returned sorted by symbol referenced.
PostSet	receives the information needed to control the search. It is a small scratch storage area which must be allocated by the caller. This area must be passed to the NextReference method to obtain additional reference records.

tReference() [3/3]

gmslLibrary.Model.tReference.tReference

(

tPostSet

PostSet

)

The tReference constructor with a single PostSet parameter iterates forward in the references record set once a call to FirstReference has established a starting record. During compilation symbol references are stored in a reference record set sorted in ascending order by the root of the symbol being referenced.

Parameters

PostSet

This PostSet parameter must have been previously initialized by the FirstReference method.

Member Function Documentation

Store()

void gmslLibrary.Model.tReference.Store

(

)

The method Store stores the reference record in the current storage area. The storage area maintains a sorted list of reference records sorted by the offset of the symbol being referenced. During the compilation process symbols are encountered by a referencing component. This method is used to order them by the component being referenced so that those references can be used by the analyser.

Property Documentation

BeingRefd

int gmslLibrary.Model.tReference.BeingRefd

getset

The integer BeingRefd property specifies the root of the component being referenced.

CodeOffset

int gmslLibrary.Model.tReference.CodeOffset

getset

The integer CodeOffset property specifies the offset in the compiled code of the referencing code.

HostFile

int gmslLibrary.Model.tReference.HostFile

getset

The integer HostFile property specifies the root of the information file containing the subprogram.

MakesRef

int gmslLibrary.Model.tReference.MakesRef

getset

The integer MakesRef property specifies the root of the component containing the reference.

RecNumber

int gmslLibrary.Model.tReference.RecNumber

getset

The integer RecNumber property specifies the text record number in the host file of the reference.

Terminal

int gmslLibrary.Model.tReference.Terminal

getset

If the reference treated the component as terminal then the integer property Terminal is one, else it is zero.

---

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

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