Home > Class Reference > %SYS namespace > SYS.Monitor.Health.SensorObject


persistent class SYS.Monitor.Health.SensorObject extends %Library.Persistent, %XML.Adaptor

SQL Table Name: SYS_Monitor_Health.SensorObject

Storage for Health Monitor Sensors. Each Sensor may have multiple Charts attached (for different time Periods) to evaluate when a Sensor deviates from 'normal' values.

Property Inventory

Method Inventory


property AlertValue as %String [ InitialExpression = 0 ];
Property methods: AlertValueDisplayToLogical(), AlertValueGet(), AlertValueGetStored(), AlertValueIsValid(), AlertValueLogicalToDisplay(), AlertValueLogicalToOdbc(), AlertValueNormalize(), AlertValueSet()
relationship Charts as array of SYS.Monitor.Health.Chart [ InitialExpression = $listbuild("SYS.Monitor.Health.Chart","SensorObject",+$this,"many",1,1) , Transient , Inverse = SensorObject , Cardinality = many ];
Container Group
Property methods: ChartsGet(), ChartsGetObject(), ChartsGetObjectId(), ChartsGetSwizzled(), ChartsIsEmpty(), ChartsIsValid(), ChartsNewObject(), ChartsRClose(), ChartsRExec(), ChartsRFetch(), ChartsRelate(), ChartsSQLCompute(), ChartsSet(), ChartsUnRelate()
property MaxMult as %String [ InitialExpression = 0 ];
Property methods: MaxMultDisplayToLogical(), MaxMultGet(), MaxMultGetStored(), MaxMultIsValid(), MaxMultLogicalToDisplay(), MaxMultLogicalToOdbc(), MaxMultNormalize(), MaxMultSet()
property Sensor as %String [ Required ];
Property methods: SensorDisplayToLogical(), SensorGet(), SensorGetStored(), SensorIsValid(), SensorLogicalToDisplay(), SensorLogicalToOdbc(), SensorNormalize(), SensorSet(), SensorsClose(), SensorsExecute(), SensorsFetch(), SensorsFetchRows(), SensorsFunc(), SensorsGetInfo(), SensorsGetODBCInfo(), SensorsMaxValClose(), SensorsMaxValExecute(), SensorsMaxValFetch(), SensorsMaxValFetchRows(), SensorsMaxValFunc(), SensorsMaxValGetInfo(), SensorsMaxValGetODBCInfo(), SensorsMaxValPrepare(), SensorsMaxValSendODBC(), SensorsNotMaxValClose(), SensorsNotMaxValExecute(), SensorsNotMaxValFetch(), SensorsNotMaxValFetchRows(), SensorsNotMaxValFunc(), SensorsNotMaxValGetInfo(), SensorsNotMaxValGetODBCInfo(), SensorsNotMaxValPrepare(), SensorsNotMaxValSendODBC(), SensorsPrepare(), SensorsSendODBC()
property Threshold as %String [ InitialExpression = 0 ];
Property methods: ThresholdDisplayToLogical(), ThresholdGet(), ThresholdGetStored(), ThresholdIsValid(), ThresholdLogicalToDisplay(), ThresholdLogicalToOdbc(), ThresholdNormalize(), ThresholdSet()
property WarnMult as %String [ InitialExpression = 0 ];
Property methods: WarnMultDisplayToLogical(), WarnMultGet(), WarnMultGetStored(), WarnMultIsValid(), WarnMultLogicalToDisplay(), WarnMultLogicalToOdbc(), WarnMultNormalize(), WarnMultSet()
property WarnValue as %String [ InitialExpression = 0 ];
Property methods: WarnValueDisplayToLogical(), WarnValueGet(), WarnValueGetStored(), WarnValueIsValid(), WarnValueLogicalToDisplay(), WarnValueLogicalToOdbc(), WarnValueNormalize(), WarnValueSet()


method %OnNew(Sensor As %String, Threshold As %Integer = 0, MaxVal As %Integer = 0, MaxMult As %Integer = 0, WarnVal As %Integer = 0, WarnMult As %Integer = 0) as %Status [ Language = objectscript ]
Set the Sensor properties. WarnValue and WarnMult are optional. If present, there must also be a corresponding AlertValue or MaxMult
method %OnValidateObject() as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %ValidateObject() method to provide notification that the current object is being validated.

If this method returns an error then %ValidateObject() will fail.


query Sensors()
SQL Query:
SELECT Sensor,Threshold,AlertValue,MaxMult,WarnValue,WarnMult FROM SensorObject
A list of all sensors
query SensorsMaxVal()
SQL Query:
SELECT Sensor,AlertValue,WarnValue FROM SensorObject WHERE AlertValue <> 0
A list of all sensors with a AlertValue defined
query SensorsNotMaxVal()
SQL Query:
SELECT Sensor,Threshold,MaxMult,WarnMult FROM SensorObject WHERE AlertValue = 0
A list of sensors without AlertValue defined


index (IDKEY on Sensor) [IdKey, PrimaryKey, Type = key, Unique];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()

Inherited Members

Inherited Methods


Storage Model: Storage (SYS.Monitor.Health.SensorObject)