Class NSSaintConfiguration
Definition of the three periods for status monitors and some other settings per saint entity.
Constructors
NSSaintConfiguration()
Initializes a new instance of the NSSaintConfiguration class.
Declaration
NSSaintConfigurationMethods
GetEnabled()
Declaration
Bool GetEnabled()Examples
NSSaintConfiguration thing;
Bool enabled = thing.GetEnabled();Returns
| Type | Description |
| Bool | On/off switch for Saint functionality for this entity. |
GetGenerationEnd()
Declaration
DateTime GetGenerationEnd()Examples
NSSaintConfiguration thing;
DateTime generationEnd = thing.GetGenerationEnd();Returns
| Type | Description |
| DateTime | When was the last regeneration finished. |
GetGenerationStart()
Declaration
DateTime GetGenerationStart()Examples
NSSaintConfiguration thing;
DateTime generationStart = thing.GetGenerationStart();Returns
| Type | Description |
| DateTime | When was the last regeneration started. |
GetOwnerTable()
Declaration
Integer GetOwnerTable()Examples
NSSaintConfiguration thing;
Integer ownerTable = thing.GetOwnerTable();Returns
| Type | Description |
| Integer | The table that is the owning entity. |
GetPeriod1()
Declaration
Integer GetPeriod1()Examples
NSSaintConfiguration thing;
Integer period1 = thing.GetPeriod1();Returns
| Type | Description |
| Integer | Length of the first counter period. |
GetPeriod2()
Declaration
Integer GetPeriod2()Examples
NSSaintConfiguration thing;
Integer period2 = thing.GetPeriod2();Returns
| Type | Description |
| Integer | Length of the second counter period. |
GetPeriod3()
Declaration
Integer GetPeriod3()Examples
NSSaintConfiguration thing;
Integer period3 = thing.GetPeriod3();Returns
| Type | Description |
| Integer | Length of the third counter period. |
GetRowsGenerated()
Declaration
Integer GetRowsGenerated()Examples
NSSaintConfiguration thing;
Integer rowsGenerated = thing.GetRowsGenerated();Returns
| Type | Description |
| Integer | Number of CounterValue rows generated for this entity. |
SetEnabled(Bool)
Declaration
Void SetEnabled(Bool enabled)Examples
NSSaintConfiguration thing;
Bool enabled;
thing.SetEnabled(enabled);Parameters
| Type | Name | Description |
| Bool | enabled | On/off switch for Saint functionality for this entity. |
Returns
| Type | Description |
| Void |
SetGenerationEnd(DateTime)
Declaration
Void SetGenerationEnd(DateTime generationEnd)Examples
NSSaintConfiguration thing;
DateTime generationEnd;
thing.SetGenerationEnd(generationEnd);Parameters
| Type | Name | Description |
| DateTime | generationEnd | When was the last regeneration finished. |
Returns
| Type | Description |
| Void |
SetGenerationStart(DateTime)
Declaration
Void SetGenerationStart(DateTime generationStart)Examples
NSSaintConfiguration thing;
DateTime generationStart;
thing.SetGenerationStart(generationStart);Parameters
| Type | Name | Description |
| DateTime | generationStart | When was the last regeneration started. |
Returns
| Type | Description |
| Void |
SetOwnerTable(Integer)
Declaration
Void SetOwnerTable(Integer ownerTable)Examples
NSSaintConfiguration thing;
Integer ownerTable;
thing.SetOwnerTable(ownerTable);Parameters
| Type | Name | Description |
| Integer | ownerTable | The table that is the owning entity. |
Returns
| Type | Description |
| Void |
SetPeriod1(Integer)
Declaration
Void SetPeriod1(Integer period1)Examples
NSSaintConfiguration thing;
Integer period1;
thing.SetPeriod1(period1);Parameters
| Type | Name | Description |
| Integer | period1 | Length of the first counter period. |
Returns
| Type | Description |
| Void |
SetPeriod2(Integer)
Declaration
Void SetPeriod2(Integer period2)Examples
NSSaintConfiguration thing;
Integer period2;
thing.SetPeriod2(period2);Parameters
| Type | Name | Description |
| Integer | period2 | Length of the second counter period. |
Returns
| Type | Description |
| Void |
SetPeriod3(Integer)
Declaration
Void SetPeriod3(Integer period3)Examples
NSSaintConfiguration thing;
Integer period3;
thing.SetPeriod3(period3);Parameters
| Type | Name | Description |
| Integer | period3 | Length of the third counter period. |
Returns
| Type | Description |
| Void |
SetRowsGenerated(Integer)
Declaration
Void SetRowsGenerated(Integer rowsGenerated)Examples
NSSaintConfiguration thing;
Integer rowsGenerated;
thing.SetRowsGenerated(rowsGenerated);Parameters
| Type | Name | Description |
| Integer | rowsGenerated | Number of CounterValue rows generated for this entity. |
Returns
| Type | Description |
| Void |