Abstract definition of a Sensor collector for a Dashboard. More...

Inheritance diagram for AbstractDashboard:

[legend]

Collaboration diagram for AbstractDashboard:

[legend]

Public Member Functions
	Alert (_.Library.String Sensor, _.Library.String Item, _.Library.String Value)
	Sensors which have reached their CriticalValue will call here to post an Alert. More...

Public Member Functions inherited from AbstractSensor
_.Library.Integer	ClearNotifications ()
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Integer	ClearSensors ()
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Status	GetSensors ()
	USER MUST IMPLEMENT THIS METHOD. More...

_.Library.Status	LogCon (_.Library.String Msg, _.Library.Integer Severity)
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Status	LogMsg (_.Library.String msg)
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Integer	Notify (_.Library.String Sensor, _.Library.Integer Severity, _.Library.String Msg)
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Status	OpenLog ()
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Integer	SetSensor (_.Library.String Sensor, _.Library.String Value, _.Library.String Qualifier)
	USER DOES NOT IMPLEMENT THIS METHOD. More...

_.Library.Status	Start ()
	USER MAY IMPLEMENT THIS METHOD. More...

Static Public Member Functions
_.Library.Status	CreateSensor (_.Library.String Sensor, _.Library.String Item, _.Library.String CriticalValue, _.Library.String WarningValue, _.Library.String Alert, _.Library.String Units, _.Library.String Operator, _.Library.String Description)
	Create (or update) a Dashboard Sensor definition. More...

Public Attributes
	ReadTime
	Time that the collection was started. More...

Public Attributes inherited from AbstractSensor
	Notifications
	More...

	State
	Runtime state. More...

Detailed Description

Abstract definition of a Sensor collector for a Dashboard.

This a special instance of a Sensor, which will collect the Sensors defined by calling CreateSensor() and then store the collected values in SYS.Monitor.Sensor.Readings. The graphic Dashboard API will then be able to fetch the Sensor data from there for display.

User may implement Dashboard Sensors by inheriting from this class and implementing the Start() method (to create the Sensor definitions) and the GetSensors() method (to store the data).

Member Function Documentation

◆ Alert()

Alert	(	_.Library.String	Sensor,
		_.Library.String	Item,
		_.Library.String	Value
	)

Sensors which have reached their CriticalValue will call here to post an Alert.

By default this will post a message to messages.log which will trigger an alert by the System Monitor. User-defined Sensors may override that behavior by replacing this method.

◆ CreateSensor()

_.Library.Status CreateSensor	(	_.Library.String	Sensor,
		_.Library.String	Item,
		_.Library.String	CriticalValue,
		_.Library.String	WarningValue,
		_.Library.String	Alert,
		_.Library.String	Units,
		_.Library.String	Operator,
		_.Library.String	Description
	)

static

Create (or update) a Dashboard Sensor definition.

User-defined Sensors should call this in Start().

See SYS.Monitor.Sensor for an explanation of each argument (property), but users should call here rather than use the class API so the Sensor is correctly associated with their Dashboard collector Class. This only creates the Sensor if it doesn't already exist. Updating Critical/Warning Values or other properties can be done through the Class API once the Sensor is created.

Member Data Documentation

◆ ReadTime

ReadTime

Time that the collection was started.

This may be set by the child class so that

all Readings are recorded at the same time. If it's left null, then AddDashboardEntry will fill in the current time for each Sensor/Item recorded.

Public Member Functions