Status property icons

Status property of CurrentValue

The VtrinLib CurrentValue class presents the status information only with an unsigned 64 integer bitmask number. C# programs that have access to VtrinLib can interprete this with the following enum definition in namespace ABB.Vtrin.

cValueStatus Enumeration

Icon	Name	bitmask number	Description
	OK	0x0000000000000000UL	Status indicating that current value status is okay and value is good quality.
	ManuallySet	0x0000000000000100UL	Status for value that has been manually set.
	Increasing	0x0000000000000200UL	Status indicating that current value has increased from previous value.
	Decreasing	0x0000000000000400UL	Status indicating that current value has decreased from previous value.
	StartOfSlice	0x0000000000000800UL	Filter type status that is used when referred to starting time of a certain time period (E.g. start time when engine was running).
	EndOfSlice	0x0000000000001000UL	Filter type status that is used when referred to ending time of a certain time period (E.g. end time when engine stopped running).
	Interpolated	0x0000000000002000UL	Status indicating that there is an interpolated value in between two real history values.
	Extrapolated	0x0000000000004000UL	Status indicating that an extra value is added after a certain history time period. May be described as prediction value.
	Fake	0x0000000000006000UL	Created value to history that has not been created naturally. Fake value could be added e.g. through a filter.
	LastInSequence	0x0000004000000000UL	Status that indicates last value of a time period. Data collection ends and the value expires at this point.
	HistorySubstituted	0x0000008000000000UL	Status related to history maintenance. Indicates that a value in history has been fixed or overwritten. Calculation cannot overwrite this HistorySubstituted value.
	Uninitialised	0x0000020000000000UL	Status to indicate a value that only a filter could produce.
	AccessDenied	0x00000A0000000000UL	Displayed when user does not have right to access value information.
	Frozen	0x0000100000000000UL	Status indicating that a value has been frozen or locked. Prevents overwriting the value. Weaker than HistorySubstituted.
	Incomplete	0x0000200000000000UL	Status indicating that current value is imperfect.
	Substituted	0x0000800000000000UL	Value has been overwritten, could be manually set.
	SupressedAlarm	0x0001000000000000UL	Status indicating an alarm that has been supressed. Includes InformativeAlarm, WarningAlarm,ErrorAlarm and CriticalAlarm. Icons are on table below.
	Questionable	0x0002000000000000UL	Status indicating that current value is not defined yet or cannot be sure of the quality the value.
	AlarmLevel	0x0FFC000000000000UL	Status indicating that current value has reached level that has raised alarm. Includes statuses InformativeAlarm, WarningAlarm,ErrorAlarm and CriticalAlarm.Icons are on table below.
	Bad	0x1000000000000000UL	Status shown when producer of current value indicates the value is broken.
	Disabled	0x2000000000000000UL	Status indicating that current value has been disabled.
	Invalid	0x4000000000000000UL	Current value is not set or the value is otherwise invalid.

Example for updating value with timestamp and status

Below is an example for updating property value with timestamp and status. The update is done through CurrentValue table.

cDbClassInstance instance = GetDriver().Classes["Path"].Instances.GetInstanceByName("My New Instance");
object property = GetDriver().Classes["Path_My Equipment Type"].GetProperty("My New Property").GetLowLevelValue(instance);
cDbClassInstance tempInstance = GetDriver().Classes["CurrentValue"].Instances[property].BeginUpdate();

tempInstance.Value = 8;
tempInstance.TimeUTC = DateTime.UtcNow.AddDays(-5);
tempInstance.Status = cValueStatus.Fake;
tempInstance.CommitChanges(true);

cValueStatusResolved Enumeration

Icon	Name	Value	Description
	NoStatus	-1	No status available for current value.
	OK	0	Status indicating that current value status is okay and value is good quality.
	Substituted	1	Value has been overwritten, could be manually set.
	SupressedInformativeAlarm	2	Information alarm, that has been supressed.
	SupressedWarningAlarm	3	Warning alarm, that has been supressed.
	SupressedErrorAlarm	4	Error Alarm, that has been supressed.
	SupressedCriticalAlarm	5	Critical alarm, that has been supressed.
	Questionable	6	Status indicating that current value is not defined or cannot be sure of the quality of the value.
	InformativeAlarm	7
	WarningAlarm	8
	ErrorAlarm	9
	CriticalAlarm	10
	Invalid	11	Invalid current value.
	Uninitialized	12	Known value has not been given.