Class NSSaintConfiguration

Definition of the three periods for status monitors and some other settings per saint entity.

Syntax

Constructors

NSSaintConfiguration()

Initializes a new instance of the NSSaintConfiguration class.

Introduced or updated in version: 8.5R08

Declaration

NSSaintConfiguration

Methods

GetEnabled()

Introduced or updated in version: 8.5R08

Declaration

Bool GetEnabled()

Returns

Type	Description
Bool	On/off switch for Saint functionality for this entity.

Examples

NSSaintConfiguration thing;
Bool enabled = thing.GetEnabled();

GetGenerationEnd()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetGenerationEnd()

Returns

Type	Description
DateTime	When was the last regeneration finished.

Examples

NSSaintConfiguration thing;
DateTime generationEnd = thing.GetGenerationEnd();

GetGenerationStart()

Introduced or updated in version: 8.5R08

Declaration

DateTime GetGenerationStart()

Returns

Type	Description
DateTime	When was the last regeneration started.

Examples

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

GetOwnerTable()

Introduced or updated in version: 8.5R08

Declaration

Integer GetOwnerTable()

Returns

Type	Description
Integer	The table that is the owning entity.

Examples

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

GetPeriod1()

Introduced or updated in version: 8.5R08

Declaration

Integer GetPeriod1()

Returns

Type	Description
Integer	Length of the first counter period.

Examples

NSSaintConfiguration thing;
Integer period1 = thing.GetPeriod1();

GetPeriod2()

Introduced or updated in version: 8.5R08

Declaration

Integer GetPeriod2()

Returns

Type	Description
Integer	Length of the second counter period.

Examples

NSSaintConfiguration thing;
Integer period2 = thing.GetPeriod2();

GetPeriod3()

Introduced or updated in version: 8.5R08

Declaration

Integer GetPeriod3()

Returns

Type	Description
Integer	Length of the third counter period.

Examples

NSSaintConfiguration thing;
Integer period3 = thing.GetPeriod3();

GetRowsGenerated()

Introduced or updated in version: 8.5R08

Declaration

Integer GetRowsGenerated()

Returns

Type	Description
Integer	Number of CounterValue rows generated for this entity.

Examples

NSSaintConfiguration thing;
Integer rowsGenerated = thing.GetRowsGenerated();

SetEnabled(Bool)

Introduced or updated in version: 8.5R08

Declaration

Void SetEnabled(Bool enabled)

Parameters

Type	Name	Description
Bool	enabled	On/off switch for Saint functionality for this entity.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
Bool enabled;
thing.SetEnabled(enabled);

SetGenerationEnd(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetGenerationEnd(DateTime generationEnd)

Parameters

Type	Name	Description
DateTime	generationEnd	When was the last regeneration finished.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
DateTime generationEnd;
thing.SetGenerationEnd(generationEnd);

SetGenerationStart(DateTime)

Introduced or updated in version: 8.5R08

Declaration

Void SetGenerationStart(DateTime generationStart)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetOwnerTable(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetOwnerTable(Integer ownerTable)

Parameters

Type	Name	Description
Integer	ownerTable	The table that is the owning entity.

Returns

Type	Description
Void

Examples

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

SetPeriod1(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetPeriod1(Integer period1)

Parameters

Type	Name	Description
Integer	period1	Length of the first counter period.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
Integer period1;
thing.SetPeriod1(period1);

SetPeriod2(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetPeriod2(Integer period2)

Parameters

Type	Name	Description
Integer	period2	Length of the second counter period.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
Integer period2;
thing.SetPeriod2(period2);

SetPeriod3(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetPeriod3(Integer period3)

Parameters

Type	Name	Description
Integer	period3	Length of the third counter period.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
Integer period3;
thing.SetPeriod3(period3);

SetRowsGenerated(Integer)

Introduced or updated in version: 8.5R08

Declaration

Void SetRowsGenerated(Integer rowsGenerated)

Parameters

Type	Name	Description
Integer	rowsGenerated	Number of CounterValue rows generated for this entity.

Returns

Type	Description
Void

Examples

NSSaintConfiguration thing;
Integer rowsGenerated;
thing.SetRowsGenerated(rowsGenerated);