AbstractSubscriber Class Reference

Abstract class for a Subscriber. More...

Inheritance diagram for AbstractSubscriber:

Collaboration diagram for AbstractSubscriber:

Public Member Functions
_.Library.Integer	ClearNotifications ()
	USER DOES NOT IMPLEMENT THIS METHOD. More...
_.Library.Integer	ClearSensors ()
	USER DOES NOT IMPLEMENT THIS METHOD. More...
_.Library.Integer	GetAllSensors (_.Library.Binary qHandle, _.Library.String Sensor, _.Library.String Qualifier, _.Library.String Value)
	Query method to traverse the SensorReading property. More...
_.Library.Integer	GetNextSensor (_.Library.String Sensor, _.Library.Binary qHandle, _.Library.String Qualifier, _.Library.String Value)
	USER DOES NOT IMPLEMENT THIS METHOD. More...
_.Library.Status	GetNextSensorName (_.Library.String Sensor)
	USER DOES NOT IMPLEMENT THIS METHOD. More...
_.Library.Integer	GetSensor (_.Library.String Sensor, _.Library.String Qualifier, _.Library.String Value)
	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	Receive ()
	USER MUST IMPLEMENT THIS METHOD. More...
_.Library.Status	Start ()
	USER MAY IMPLEMENT THIS METHOD. More...

Public Attributes
	Notifications
	More...
	SensorName
	Sensor subscription lists. More...
	SensorReading
	Sensor readings passed from Sensor classes. More...
	State
	Runtime state. More...

Detailed Description

Abstract class for a Subscriber.

User classes inherit from this class to become a Subscriber 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.

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

GetAllSensors()

_.Library.Integer GetAllSensors	(	_.Library.Binary	qHandle,
		_.Library.String	Sensor,
		_.Library.String	Qualifier,
		_.Library.String	Value
	)

Query method to traverse the SensorReading property.

Starting from a null Sensor, returns Sensor, Qualifier, Value, and Sensor Name.

Returns 0 when there are no more sensor readings.

GetNextSensor()

_.Library.Integer GetNextSensor	(	_.Library.String	Sensor,
		_.Library.Binary	qHandle,
		_.Library.String	Qualifier,
		_.Library.String	Value
	)

USER DOES NOT IMPLEMENT THIS METHOD.

This method is called to get sensor readings. For a given sensor / qualifier pair, returns the next qualifier and the associated value.
Returns 1 if value, 0 if no more values, -1 if invalid Sensor.

GetNextSensorName()

_.Library.Status GetNextSensorName

(

_.Library.String

Sensor

)

USER DOES NOT IMPLEMENT THIS METHOD.

This method is called to get sensor names. For a given sensor, returns the next sensor.
Returns sensor name or "" if no more sensors.

GetSensor()

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

USER DOES NOT IMPLEMENT THIS METHOD.

This method is called to get sensor readings. For a given sensor / qualifier pair, returns the value.
Returns 1 if value, 0 if no value, -1 if invalid Sensor.

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

Receive()

_.Library.Status Receive

(

)

USER MUST IMPLEMENT THIS METHOD.

This method is called when the sensor array is filled.

Reimplemented in SampleSubscriber.

Start()

_.Library.Status Start

(

)

USER MAY IMPLEMENT THIS METHOD.

This method is called when the subscriber class is created.

Reimplemented in SampleSubscriber.

Member Data Documentation

Notifications

Notifications

 

 

SensorName

SensorName

Sensor subscription lists.

If Subscription(type)=1 OR Subscription(name)=1

Subscription(<sensor>)= 1  

SensorReading

SensorReading

Sensor readings passed from Sensor classes.

Sensor(<sensor>, <qualifier>) = value  

State

State

Runtime state.