DataSource.NET  7.1.27.94946-7eb8eb54
Caplin.DataSource.Monitoring.MonitoringBean Class Reference

Base type for all monitoring beans. You should extend this class to add in your own monitoring attributes and/or methods. More...

Inherits INotifyPropertyChanged.

Public Member Functions

 MonitoringBean (string templateName, string description, string key)
 Constructor for generating a monitoring bean. More...
 

Protected Member Functions

virtual void OnPropertyChanged (string propertyName)
 Internal implementation. More...
 
bool SetField< T > (ref T field, T value, string propertyName)
 Method that should be called when a monitoring attribute has changed value. More...
 

Properties

string Description [get]
 Returns the human readable description of this monitoring bean. More...
 
string Key [get]
 Returns the instance name of this monitoring bean. More...
 
string TemplateName [get]
 Returns the template name of this monitoring bean. More...
 

Events

PropertyChangedEventHandler PropertyChanged
 Internal implementation. More...
 

Detailed Description

Base type for all monitoring beans. You should extend this class to add in your own monitoring attributes and/or methods.

Constructor & Destructor Documentation

Caplin.DataSource.Monitoring.MonitoringBean.MonitoringBean ( string  templateName,
string  description,
string  key 
)
inline

Constructor for generating a monitoring bean.

Parameters
templateNameThe name of the monitoring template.
descriptionA human readable description of the purpose of this bean.
keyThe name of this instance of the monitoring group.

Caplin's standard for monitoring is to use namespaced group names, such that all the beans for a component can sit under a single hierarchy.

A template represents a collection of operations and attributes.

Member Function Documentation

virtual void Caplin.DataSource.Monitoring.MonitoringBean.OnPropertyChanged ( string  propertyName)
inlineprotectedvirtual

Internal implementation.

Parameters
propertyName
bool Caplin.DataSource.Monitoring.MonitoringBean.SetField< T > ( ref T  field,
value,
string  propertyName 
)
inlineprotected

Method that should be called when a monitoring attribute has changed value.

Template Parameters
T
Parameters
fieldA reference to the value variable.
valueThe new value.
propertyNameThe name of the monitoring attribute.
Returns

Property Documentation

string Caplin.DataSource.Monitoring.MonitoringBean.Description
get

Returns the human readable description of this monitoring bean.

string Caplin.DataSource.Monitoring.MonitoringBean.Key
get

Returns the instance name of this monitoring bean.

string Caplin.DataSource.Monitoring.MonitoringBean.TemplateName
get

Returns the template name of this monitoring bean.

Event Documentation

PropertyChangedEventHandler Caplin.DataSource.Monitoring.MonitoringBean.PropertyChanged

Internal implementation.


Generated on Wed Jan 4 2023 17:00:07 for DataSource.NET