Apac.Monitoring.Sensor Class Reference

A definition class used to identify a specific sensor and its location in the physical world. More...

Inheritance diagram for Apac.Monitoring.Sensor:

Public Member Functions
override string	ToString ()
	Returns a System.String that represents this instance. More...
Sensor	Clone ()
	Clones this instance. More...
Public Member Functions inherited from Apac.Monitoring.Persistable
System.Xml.Schema.XmlSchema	GetSchema ()
	This property is reserved, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class instead. More...
void	ReadXml (System.Xml.XmlReader reader)
	Generates an object from its XML representation. More...
void	WriteXml (System.Xml.XmlWriter writer)
	Converts an object into its XML representation. More...

Protected Member Functions
override void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...
override void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
Protected Member Functions inherited from Apac.Monitoring.Persistable
virtual void	OnPropertyChanged (string name)
	Called when [property changed]. More...

Properties
uint	Id [get, set]
	Gets or sets the datastore identifier for the sensor. More...
short	ConfigurationId [get, set]
	Gets or sets the configuration id. More...
string	SupervisableName [get, set]
	The name of the controller that retrieves the readings being mapped to a managed element. More...
ulong	SensorId [get, set]
	The unique key for the source from which the measurements are received. More...
string	SensorIdStr [get]
Apac.Data.ValueRange	Range [get, set]
	The range of values that are available from the sensor. More...
string	Description [get, set]
	A value used to label the element being mapped. If this is not set then the element's name is used. More...
bool	InUse [get, set]
Properties inherited from Apac.Monitoring.Persistable
bool	IsNew [get, set]
	Gets or sets a value indicating whether this instance is new. More...
bool	IsDirty [get, set]
	Gets or sets a value indicating whether this instance is dirty. More...
bool	IsDeleted [get, set]
	Gets or sets a value indicating whether this instance is deleted. More...
object	Tag [get, set]
	Gets or sets an arbitrary value that application code can use to track application specific data on an instance of this type. More...

Additional Inherited Members
Events inherited from Apac.Monitoring.Persistable
PropertyChangedEventHandler	PropertyChanged
	Occurs when a property value changes. More...

Detailed Description

A definition class used to identify a specific sensor and its location in the physical world.

Member Function Documentation

Clone()

Sensor Apac.Monitoring.Sensor.Clone ( )

inline

Clones this instance.

Returns

Returns a copy of this object.

OnReadXml()

override void Apac.Monitoring.Sensor.OnReadXml ( System.Xml.XmlReader  reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader

The reader.

Implements Apac.Monitoring.Persistable.

OnWriteXml()

override void Apac.Monitoring.Sensor.OnWriteXml ( System.Xml.XmlWriter  writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer

The writer.

Implements Apac.Monitoring.Persistable.

ToString()

override string Apac.Monitoring.Sensor.ToString ( )

inline

Returns a System.String that represents this instance.

Returns

A System.String that represents this instance.

Property Documentation

ConfigurationId

short Apac.Monitoring.Sensor.ConfigurationId

getset

Gets or sets the configuration id.

The configuration id.

Description

string Apac.Monitoring.Sensor.Description

getset

A value used to label the element being mapped. If this is not set then the element's name is used.

Id

uint Apac.Monitoring.Sensor.Id

getset

Gets or sets the datastore identifier for the sensor.

The id.

Range

Apac.Data.ValueRange Apac.Monitoring.Sensor.Range

getset

The range of values that are available from the sensor.

SensorId

ulong Apac.Monitoring.Sensor.SensorId

getset

The unique key for the source from which the measurements are received.

SupervisableName

string Apac.Monitoring.Sensor.SupervisableName

getset

The name of the controller that retrieves the readings being mapped to a managed element.

---

The documentation for this class was generated from the following file:

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Monitoring/Sensor.cs