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

Provides an in-memory representation of an element that is being acted on by the system. More...

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

Public Member Functions

string ColorAsHex ()
 Converts the Color to hexidecimal. More...
 
void ColorFromHex (string argb)
 Converts the Color from hexidecimal. More...
 
void ClearMappings ()
 
void AddMapping (MeasurementMapping mapping)
 
void RemoveMapping (MeasurementMapping mapping)
 
void RemoveMappingAt (int index)
 
MeasurementMapping MappingAt (int index)
 
void SetMappingAt (int index, MeasurementMapping mapping)
 
ManagedElement Clone ()
 
override string ToString ()
 
- 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

uint Id [get, set]
 The unique key for the managed element. More...
 
string Name [get, set]
 The name of the managed element. More...
 
string Description [get, set]
 A verbose description of the managed element. More...
 
bool IsSource [get, set]
 Indicates the number of phases in the circuit being measured. This is only applicable to circuit-type measurements (ECOP v1). More...
 
System.Drawing.Color Color [get, set]
 The presentation color for the element. More...
 
string HexColor [get, set]
 Gets or sets the hexidecimal value for the color of element. More...
 
string PlotStyle [get, set]
 The nominal circuit amperage. This is only applicable to circuit-type measurements (ECOP v1). More...
 
string FormulaType [get, set]
 
Data.IMeasurementFormula Formula [get]
 
string Category [get, set]
 Gets or sets a value useful for sorting elements and their associated measurements into cache buckets. More...
 
string CategoryCompare [get]
 Gets a cached upper-case version of Category. More...
 
List< MeasurementMappingMappings [get, set]
 
int? NumberOfMappings [get]
 
bool IsActive [get, set]
 
List< ThresholdThresholds [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

Provides an in-memory representation of an element that is being acted on by the system.

Member Function Documentation

◆ ColorAsHex()

string Apac.Monitoring.ManagedElement.ColorAsHex ( )
inline

Converts the Color to hexidecimal.

Returns

◆ ColorFromHex()

void Apac.Monitoring.ManagedElement.ColorFromHex ( string  argb)
inline

Converts the Color from hexidecimal.

◆ OnReadXml()

override void Apac.Monitoring.ManagedElement.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.ManagedElement.OnWriteXml ( System.Xml.XmlWriter  writer)
inlineprotectedvirtual

Serializes a mapping to XML.

Parameters
writerThe writer to which XML is written.

Implements Apac.Monitoring.Persistable.

Property Documentation

◆ Category

string Apac.Monitoring.ManagedElement.Category
getset

Gets or sets a value useful for sorting elements and their associated measurements into cache buckets.

◆ CategoryCompare

string Apac.Monitoring.ManagedElement.CategoryCompare
get

Gets a cached upper-case version of Category.

◆ Color

System.Drawing.Color Apac.Monitoring.ManagedElement.Color
getset

The presentation color for the element.

◆ Description

string Apac.Monitoring.ManagedElement.Description
getset

A verbose description of the managed element.

◆ HexColor

string Apac.Monitoring.ManagedElement.HexColor
getset

Gets or sets the hexidecimal value for the color of element.

◆ Id

uint Apac.Monitoring.ManagedElement.Id
getset

The unique key for the managed element.

◆ IsSource

bool Apac.Monitoring.ManagedElement.IsSource
getset

Indicates the number of phases in the circuit being measured. This is only applicable to circuit-type measurements (ECOP v1).

Indicates that the measurement is for a power source rather than a power load.

◆ Name

string Apac.Monitoring.ManagedElement.Name
getset

The name of the managed element.

◆ PlotStyle

string Apac.Monitoring.ManagedElement.PlotStyle
getset

The nominal circuit amperage. This is only applicable to circuit-type measurements (ECOP v1).

Determines the style of line intersection to use when plotting data for the managed element.


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