Class NSStatusMonitor

Definition of all properties for a status monitor.

Syntax

Constructors

NSStatusMonitor()

Initializes a new instance of the NSStatusMonitor class.

Declaration

NSStatusMonitor

Methods

GetDefaultTask()

Definition of all properties for a status monitor.

Declaration

Integer GetDefaultTask()

Returns

Type	Description
Integer	Default task type for this status.

Remarks

The default task text is in the text table (since it can be long), and may contain template variables

Examples

NSStatusMonitor thing;
Integer defaultTask = thing.GetDefaultTask();

GetDefaultTaskText()

Definition of all properties for a status monitor.

Declaration

String GetDefaultTaskText()

Returns

Type	Description
String	Default task text for this status.

Examples

NSStatusMonitor thing;
String defaultTaskText = thing.GetDefaultTaskText();

GetDeleted()

Definition of all properties for a status monitor.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	Deleted flag, 1 if this record is deleted (never from the database).

Examples

NSStatusMonitor thing;
Bool deleted = thing.GetDeleted();

GetDescription()

Definition of all properties for a status monitor.

Declaration

String GetDescription()

Returns

Type	Description
String	Description of the status monitor.

Examples

NSStatusMonitor thing;
String description = thing.GetDescription();

GetGenerationStart()

Definition of all properties for a status monitor.

Declaration

DateTime GetGenerationStart()

Returns

Type	Description
DateTime	When was the last regeneration started.

Examples

NSStatusMonitor thing;
DateTime generationStart = thing.GetGenerationStart();

GetIsVisual()

Definition of all properties for a status monitor.

Declaration

Bool GetIsVisual()

Returns

Type	Description
Bool	Should the status be visualized (active) in the client.

Examples

NSStatusMonitor thing;
Bool isVisual = thing.GetIsVisual();

GetLastGenerated()

Definition of all properties for a status monitor.

Declaration

DateTime GetLastGenerated()

Returns

Type	Description
DateTime	When was this status last generated (i.e., statusValue rows created).

Examples

NSStatusMonitor thing;
DateTime lastGenerated = thing.GetLastGenerated();

GetName()

Definition of all properties for a status monitor.

Declaration

String GetName()

Returns

Type	Description
String	Name of status monitor.

Examples

NSStatusMonitor thing;
String name = thing.GetName();

GetNeedsUpdate()

Definition of all properties for a status monitor.

Declaration

Bool GetNeedsUpdate()

Returns

Type	Description
Bool	Is the definition dirty, ie., ALL values are invalid until a recalculation; this flag is set when the status DEFINITION is changed, as opposed to the flag on StatusValue.

Examples

NSStatusMonitor thing;
Bool needsUpdate = thing.GetNeedsUpdate();

GetNumMatches()

Definition of all properties for a status monitor.

Declaration

Integer GetNumMatches()

Returns

Type	Description
Integer	Number of targets that have this status, this should be the number of rows in StatusValue pointing to this definition, and that have isSignalled set to 1

Examples

NSStatusMonitor thing;
Integer numMatches = thing.GetNumMatches();

GetNumNeedUpdate()

Definition of all properties for a status monitor.

Declaration

Integer GetNumNeedUpdate()

Returns

Type	Description
Integer	Number of targets that had this status, but have their needsUpdate bit set due to some change.

Examples

NSStatusMonitor thing;
Integer numNeedUpdate = thing.GetNumNeedUpdate();

GetOwnerTable()

Definition of all properties for a status monitor.

Declaration

Integer GetOwnerTable()

Returns

Type	Description
Integer	ID of table that owns the status monitor.

Examples

NSStatusMonitor thing;
Integer ownerTable = thing.GetOwnerTable();

GetPictureId()

Definition of all properties for a status monitor.

Declaration

Integer GetPictureId()

Returns

Type	Description
Integer	ID of BinaryObject row that contains image for status monitor.

Examples

NSStatusMonitor thing;
Integer pictureId = thing.GetPictureId();

GetRank()

Definition of all properties for a status monitor.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Priority rank, in case more than one status is signalled. Lowest wins.

Examples

NSStatusMonitor thing;
Integer rank = thing.GetRank();

GetStatusMonitorId()

Definition of all properties for a status monitor.

Declaration

Integer GetStatusMonitorId()

Returns

Type	Description
Integer	Primary key.

Examples

NSStatusMonitor thing;
Integer statusMonitorId = thing.GetStatusMonitorId();

SetDefaultTask(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetDefaultTask(Integer defaultTask)

Parameters

Type	Name	Description
Integer	defaultTask	Default task type for this status.

Returns

Type	Description
Void

Remarks

The default task text is in the text table (since it can be long), and may contain template variables

Examples

NSStatusMonitor thing;
Integer defaultTask;
thing.SetDefaultTask(defaultTask);

SetDefaultTaskText(String)

Definition of all properties for a status monitor.

Declaration

Void SetDefaultTaskText(String defaultTaskText)

Parameters

Type	Name	Description
String	defaultTaskText	Default task text for this status.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
String defaultTaskText;
thing.SetDefaultTaskText(defaultTaskText);

SetDeleted(Bool)

Definition of all properties for a status monitor.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	Deleted flag, 1 if this record is deleted (never from the database).

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDescription(String)

Definition of all properties for a status monitor.

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	Description of the status monitor.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
String description;
thing.SetDescription(description);

SetGenerationStart(DateTime)

Definition of all properties for a status monitor.

Declaration

Void SetGenerationStart(DateTime generationStart)

Parameters

Type	Name	Description
DateTime	generationStart	When was the last regeneration started.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
DateTime generationStart;
thing.SetGenerationStart(generationStart);

SetIsVisual(Bool)

Definition of all properties for a status monitor.

Declaration

Void SetIsVisual(Bool isVisual)

Parameters

Type	Name	Description
Bool	isVisual	Should the status be visualized (active) in the client.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Bool isVisual;
thing.SetIsVisual(isVisual);

SetLastGenerated(DateTime)

Definition of all properties for a status monitor.

Declaration

Void SetLastGenerated(DateTime lastGenerated)

Parameters

Type	Name	Description
DateTime	lastGenerated	When was this status last generated (i.e., statusValue rows created).

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
DateTime lastGenerated;
thing.SetLastGenerated(lastGenerated);

SetName(String)

Definition of all properties for a status monitor.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Name of status monitor.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
String name;
thing.SetName(name);

SetNeedsUpdate(Bool)

Definition of all properties for a status monitor.

Declaration

Void SetNeedsUpdate(Bool needsUpdate)

Parameters

Type	Name	Description
Bool	needsUpdate	Is the definition dirty, ie., ALL values are invalid until a recalculation; this flag is set when the status DEFINITION is changed, as opposed to the flag on StatusValue.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Bool needsUpdate;
thing.SetNeedsUpdate(needsUpdate);

SetNumMatches(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetNumMatches(Integer numMatches)

Parameters

Type	Name	Description
Integer	numMatches	Number of targets that have this status, this should be the number of rows in StatusValue pointing to this definition, and that have isSignalled set to 1

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer numMatches;
thing.SetNumMatches(numMatches);

SetNumNeedUpdate(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetNumNeedUpdate(Integer numNeedUpdate)

Parameters

Type	Name	Description
Integer	numNeedUpdate	Number of targets that had this status, but have their needsUpdate bit set due to some change.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer numNeedUpdate;
thing.SetNumNeedUpdate(numNeedUpdate);

SetOwnerTable(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetOwnerTable(Integer ownerTable)

Parameters

Type	Name	Description
Integer	ownerTable	ID of table that owns the status monitor.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer ownerTable;
thing.SetOwnerTable(ownerTable);

SetPictureId(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetPictureId(Integer pictureId)

Parameters

Type	Name	Description
Integer	pictureId	ID of BinaryObject row that contains image for status monitor.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer pictureId;
thing.SetPictureId(pictureId);

SetRank(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Priority rank, in case more than one status is signalled. Lowest wins.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer rank;
thing.SetRank(rank);

SetStatusMonitorId(Integer)

Definition of all properties for a status monitor.

Declaration

Void SetStatusMonitorId(Integer statusMonitorId)

Parameters

Type	Name	Description
Integer	statusMonitorId	Primary key.

Returns

Type	Description
Void

Examples

NSStatusMonitor thing;
Integer statusMonitorId;
thing.SetStatusMonitorId(statusMonitorId);