AP&C API Reference
Public Member Functions | Protected Member Functions | Properties | List of all members
Apac.Monitoring.MeasurementMapping Class Reference

Provides an in-memory representation of the mapping between a measurement source and the application-level identity for the entity being measured. More...

Inheritance diagram for Apac.Monitoring.MeasurementMapping:
Apac.Monitoring.Persistable

Public Member Functions

 MeasurementMapping ()
 Initializes a new instance of the MeasurementMapping class. More...
 
override bool Equals (object obj)
 Determines whether the specified System.Object is equal to this instance. More...
 
override int GetHashCode ()
 Returns a hash code for this instance. More...
 
override string ToString ()
 Returns a System.String that represents this instance. More...
 
MeasurementMapping 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)
 Deserializes a mapping from XML. More...
 
override void OnWriteXml (System.Xml.XmlWriter writer)
 Serializes a mapping to XML. More...
 
- Protected Member Functions inherited from Apac.Monitoring.Persistable
virtual void OnPropertyChanged (string name)
 Called when [property changed]. More...
 

Properties

ManagedElement Element [get, set]
 Gets or sets the element. More...
 
Sensor Sensor [get, set]
 Gets or sets the sensor. More...
 
uint Id [get, set]
 Gets or sets the unique key for the mapping. More...
 
uint SensorId [get, set]
 The unique key for the source from which the measurements are received. More...
 
uint ElementId [get, set]
 The unique key for the managed element to which the measurements are mapped. More...
 
short ConfigurationId [get, set]
 The unique key for the configuration to which the measurements are mapped. 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...
 
uint SourceElementId [get, set]
 The unique key for the managed element from which the measurement derives its value. Used for making complex measurements from the values of other measurements. More...
 
string InputTag [get, set]
 Gets or sets the tag used to mark the data the mapping points to so the compiler can identify it for specific formula inputs. See individual formula instructions for the names of tags. More...
 
decimal ConstantValue [get, set]
 Gets or sets the value to be returned by this mapping as a constant. More...
 
MappingType MappingType [get]
 
string Key [get]
 Gets the key. More...
 
- 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

Provides an in-memory representation of the mapping between a measurement source and the application-level identity for the entity being measured.

Constructor & Destructor Documentation

◆ MeasurementMapping()

Apac.Monitoring.MeasurementMapping.MeasurementMapping ( )
inline

Initializes a new instance of the MeasurementMapping class.

Member Function Documentation

◆ Clone()

MeasurementMapping Apac.Monitoring.MeasurementMapping.Clone ( )
inline

Clones this instance.

Returns
Returns a copy of this instance.

◆ Equals()

override bool Apac.Monitoring.MeasurementMapping.Equals ( object  obj)
inline

Determines whether the specified System.Object is equal to this instance.

Parameters
objThe System.Object to compare with this instance.
Returns
true if the specified System.Object is equal to this instance; otherwise, false.
Exceptions
T:System.NullReferenceExceptionThe obj parameter is null.

◆ GetHashCode()

override int Apac.Monitoring.MeasurementMapping.GetHashCode ( )
inline

Returns a hash code for this instance.

Returns
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

◆ OnReadXml()

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

Deserializes a mapping from XML.

Parameters
readerThe reader from which the XML data is read.

Implements Apac.Monitoring.Persistable.

◆ OnWriteXml()

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

Serializes a mapping to XML.

Parameters
writerThe writer to which XML is written.

Implements Apac.Monitoring.Persistable.

◆ ToString()

override string Apac.Monitoring.MeasurementMapping.ToString ( )
inline

Returns a System.String that represents this instance.

Returns
A System.String that represents this instance.

Property Documentation

◆ ConfigurationId

short Apac.Monitoring.MeasurementMapping.ConfigurationId
getset

The unique key for the configuration to which the measurements are mapped.

◆ ConstantValue

decimal Apac.Monitoring.MeasurementMapping.ConstantValue
getset

Gets or sets the value to be returned by this mapping as a constant.

◆ Description

string Apac.Monitoring.MeasurementMapping.Description
getset

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

◆ Element

ManagedElement Apac.Monitoring.MeasurementMapping.Element
getset

Gets or sets the element.

The element.

◆ ElementId

uint Apac.Monitoring.MeasurementMapping.ElementId
getset

The unique key for the managed element to which the measurements are mapped.

◆ Id

uint Apac.Monitoring.MeasurementMapping.Id
getset

Gets or sets the unique key for the mapping.

The id.

◆ InputTag

string Apac.Monitoring.MeasurementMapping.InputTag
getset

Gets or sets the tag used to mark the data the mapping points to so the compiler can identify it for specific formula inputs. See individual formula instructions for the names of tags.

◆ Key

string Apac.Monitoring.MeasurementMapping.Key
get

Gets the key.

◆ Sensor

Sensor Apac.Monitoring.MeasurementMapping.Sensor
getset

Gets or sets the sensor.

The sensor.

◆ SensorId

uint Apac.Monitoring.MeasurementMapping.SensorId
getset

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

◆ SourceElementId

uint Apac.Monitoring.MeasurementMapping.SourceElementId
getset

The unique key for the managed element from which the measurement derives its value. Used for making complex measurements from the values of other measurements.


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