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

This construct determines threshold values for managed elements and the actions to take when those thresholds are crossed. More...

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

Public Member Functions

object Clone ()
 Creates a new object that is a copy of the current 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...
 

Static Public Member Functions

static string BuildDescription (ThresholdBoundary boundary, decimal value, decimal limit, string name)
 Builds a uniform description of the threshold status. 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

short ConfigId [get, set]
 Gets or sets the config id. More...
 
uint ElementId [get, set]
 Gets or sets the element id. More...
 
bool IsActive [get, set]
 Gets or sets a value indicating whether this instance is active. More...
 
string MeaurementType [get, set]
 Gets or sets the type of the meaurement. More...
 
decimal UpperBound [get, set]
 Gets or sets the upper bound. More...
 
decimal LowerBound [get, set]
 Gets or sets the lower bound. More...
 
uint UpperBoundBreakEventId [get, set]
 Gets or sets the upper bound break event id. More...
 
uint UpperBoundNormalEventId [get, set]
 Gets or sets the upper bound normal event id. More...
 
EventDef UpperBoundBreakEvent [get, set]
 Gets or sets the upper bound break event. More...
 
EventDef UpperBoundNormalEvent [get, set]
 Gets or sets the upper bound normal event. More...
 
uint LowerBoundBreakEventId [get, set]
 Gets or sets the lower bound break event id. More...
 
uint LowerBoundNormalEventId [get, set]
 Gets or sets the lower bound normal event id. More...
 
EventDef LowerBoundBreakEvent [get, set]
 Gets or sets the lower bound break event. More...
 
EventDef LowerBoundNormalEvent [get, set]
 Gets or sets the lower bound normal event. 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

This construct determines threshold values for managed elements and the actions to take when those thresholds are crossed.

Member Function Documentation

◆ BuildDescription()

static string Apac.Monitoring.Threshold.BuildDescription ( ThresholdBoundary  boundary,
decimal  value,
decimal  limit,
string  name 
)
inlinestatic

Builds a uniform description of the threshold status.

Parameters
boundaryThe boundary that was broken.
valueThe current value.
limitThe limit value.
nameThe name of the limit that was broken.
Returns
Returns a string description of a threshold status.

◆ Clone()

object Apac.Monitoring.Threshold.Clone ( )
inline

Creates a new object that is a copy of the current instance.

Returns
A new object that is a copy of this instance.

◆ OnReadXml()

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

Called when deserializing via XML.

Parameters
readerThe reader.

Implements Apac.Monitoring.Persistable.

◆ OnWriteXml()

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

Called when serializing via XML.

Parameters
writerThe writer.

Implements Apac.Monitoring.Persistable.

Property Documentation

◆ ConfigId

short Apac.Monitoring.Threshold.ConfigId
getset

Gets or sets the config id.

The config id.

◆ ElementId

uint Apac.Monitoring.Threshold.ElementId
getset

Gets or sets the element id.

The element id.

◆ IsActive

bool Apac.Monitoring.Threshold.IsActive
getset

Gets or sets a value indicating whether this instance is active.

true if this instance is active; otherwise, false.

◆ LowerBound

decimal Apac.Monitoring.Threshold.LowerBound
getset

Gets or sets the lower bound.

The lower bound.

◆ LowerBoundBreakEvent

EventDef Apac.Monitoring.Threshold.LowerBoundBreakEvent
getset

Gets or sets the lower bound break event.

The lower bound break event.

◆ LowerBoundBreakEventId

uint Apac.Monitoring.Threshold.LowerBoundBreakEventId
getset

Gets or sets the lower bound break event id.

The lower bound break event id.

◆ LowerBoundNormalEvent

EventDef Apac.Monitoring.Threshold.LowerBoundNormalEvent
getset

Gets or sets the lower bound normal event.

The lower bound normal event.

◆ LowerBoundNormalEventId

uint Apac.Monitoring.Threshold.LowerBoundNormalEventId
getset

Gets or sets the lower bound normal event id.

The lower bound normal event id.

◆ MeaurementType

string Apac.Monitoring.Threshold.MeaurementType
getset

Gets or sets the type of the meaurement.

The type of the meaurement.

◆ UpperBound

decimal Apac.Monitoring.Threshold.UpperBound
getset

Gets or sets the upper bound.

The upper bound.

◆ UpperBoundBreakEvent

EventDef Apac.Monitoring.Threshold.UpperBoundBreakEvent
getset

Gets or sets the upper bound break event.

The upper bound break event.

◆ UpperBoundBreakEventId

uint Apac.Monitoring.Threshold.UpperBoundBreakEventId
getset

Gets or sets the upper bound break event id.

The upper bound break event id.

◆ UpperBoundNormalEvent

EventDef Apac.Monitoring.Threshold.UpperBoundNormalEvent
getset

Gets or sets the upper bound normal event.

The upper bound normal event.

◆ UpperBoundNormalEventId

uint Apac.Monitoring.Threshold.UpperBoundNormalEventId
getset

Gets or sets the upper bound normal event id.

The upper bound normal event id.


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