AbstractSensor Class Reference

Abstract class for a Sensor. More...

Inheritance diagram for AbstractSensor:

Collaboration diagram for AbstractSensor:

Public Member Functions
_.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...

Public Attributes
	Notifications
	More...
	State
	Runtime state. More...

Detailed Description

Abstract class for a Sensor.

User classes inherit from this class to become a Sensor for System Monitor.

Member Function Documentation

ClearNotifications()

_.Library.Integer ClearNotifications

(

)

USER DOES NOT IMPLEMENT THIS METHOD.

This method is called to clear notifications for the SYS.Monitor Controller

ClearSensors()

_.Library.Integer ClearSensors

(

)

USER DOES NOT IMPLEMENT THIS METHOD.

The controller calls this to initialize the SensorReadings array.

GetSensors()

_.Library.Status GetSensors

(

)

USER MUST IMPLEMENT THIS METHOD.

The System Monitor Controller calls this method to get sensor readings. It is called every 10 seconds by default.

Users may return readings for multiple sensors (but only one reading per sensor on each call). User calls SetSensor(sensorname, value[,type]) for every sensor reading. The sensors are kept in the property SensorReading(sensor)=value, and SensorType(sensor)=type. The controller picks up the sensors and their values after the return from GetSensors().

A return code of $$$OK indicates there were no errors. A return code of 0 indicates a failure.

LogCon()

_.Library.Status LogCon	(	_.Library.String	Msg,
		_.Library.Integer	Severity
	)

USER DOES NOT IMPLEMENT THIS METHOD.

User may call this method to post alerts directly to the messages.log file.

LogMsg()

_.Library.Status LogMsg

(

_.Library.String

msg

)

USER DOES NOT IMPLEMENT THIS METHOD.

User may call this method to log information to the SystemMonitor.log file in the mgr directory.

Notify()

_.Library.Integer Notify	(	_.Library.String	Sensor,
		_.Library.Integer	Severity,
		_.Library.String	Msg
	)

USER DOES NOT IMPLEMENT THIS METHOD.

This method is called to post a notification

OpenLog()

_.Library.Status OpenLog

(

)

USER DOES NOT IMPLEMENT THIS METHOD.

SetSensor()

_.Library.Integer SetSensor	(	_.Library.String	Sensor,
		_.Library.String	Value,
		_.Library.String	Qualifier
	)

USER DOES NOT IMPLEMENT THIS METHOD.

The user must call this method to set a sensor reading. Readings are picked up by the controller after GetSensors() returns.

Reimplemented in Abstract.

Start()

_.Library.Status Start

(

)

USER MAY IMPLEMENT THIS METHOD.

The System Monitor Controller calls this method once when it starts. The user may initialize the properties, counters, etc.

A return code of $$$OK indicates there were no errors. A return code of 0 indicates a failure.

Member Data Documentation

Notifications

Notifications

 

 

State

State

Runtime state.