Apac.Monitoring.Persistable Class Reference

Provides the basic features for in-memory objects that need to be persisted. More...

Inheritance diagram for Apac.Monitoring.Persistable:

Public Member Functions
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
abstract void	OnReadXml (System.Xml.XmlReader reader)
	Called when deserializing via XML. More...
abstract void	OnWriteXml (System.Xml.XmlWriter writer)
	Called when serializing via XML. More...
virtual void	OnPropertyChanged (string name)
	Called when [property changed]. More...

Properties
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...

Events
PropertyChangedEventHandler	PropertyChanged
	Occurs when a property value changes. More...

Detailed Description

Provides the basic features for in-memory objects that need to be persisted.

Member Function Documentation

GetSchema()

System.Xml.Schema.XmlSchema Apac.Monitoring.Persistable.GetSchema ( )

inline

This property is reserved, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class instead.

Returns

An T:System.Xml.Schema.XmlSchema that describes the XML representation of the object that is produced by the M:System.Xml.Serialization.IXmlSerializable.WriteXml(System.Xml.XmlWriter) method and consumed by the M:System.Xml.Serialization.IXmlSerializable.ReadXml(System.Xml.XmlReader) method.

OnPropertyChanged()

virtual void Apac.Monitoring.Persistable.OnPropertyChanged ( string  name )

inlineprotectedvirtual

Called when [property changed].

Parameters

name

The name.

OnReadXml()

abstract void Apac.Monitoring.Persistable.OnReadXml ( System.Xml.XmlReader  reader )

protectedpure virtual

Called when deserializing via XML.

Parameters

reader

The reader.

Implemented in Apac.Monitoring.Threshold, Apac.Monitoring.Sensor, Apac.Monitoring.MeasurementMapping, Apac.Monitoring.ManagedElement, Apac.Monitoring.EventDef, Apac.Monitoring.Alert, Apac.Monitoring.ActionDef, and Apac.Auth.NotificationGroup.

OnWriteXml()

abstract void Apac.Monitoring.Persistable.OnWriteXml ( System.Xml.XmlWriter  writer )

protectedpure virtual

Called when serializing via XML.

Parameters

writer

The writer.

Implemented in Apac.Monitoring.Threshold, Apac.Monitoring.Sensor, Apac.Monitoring.MeasurementMapping, Apac.Monitoring.ManagedElement, Apac.Monitoring.EventDef, Apac.Monitoring.Alert, Apac.Monitoring.ActionDef, and Apac.Auth.NotificationGroup.

ReadXml()

void Apac.Monitoring.Persistable.ReadXml ( System.Xml.XmlReader  reader )

inline

Generates an object from its XML representation.

Parameters

reader

The T:System.Xml.XmlReader stream from which the object is deserialized.

This method delegates to subclasses through the OnReadXml method, but subclasses cannot override the basic XML this class creates, and to call back into this method would create infinite recursion.

WriteXml()

void Apac.Monitoring.Persistable.WriteXml ( System.Xml.XmlWriter  writer )

inline

Converts an object into its XML representation.

Parameters

writer

The T:System.Xml.XmlWriter stream to which the object is serialized.

This method delegates to subclasses through the OnReadXml method, but subclasses cannot override the basic XML this class creates, and to call back into this method would create infinite recursion.

Property Documentation

IsDeleted

bool Apac.Monitoring.Persistable.IsDeleted

getset

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

true if this instance is deleted; otherwise, false.

IsDirty

bool Apac.Monitoring.Persistable.IsDirty

getset

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

true if this instance is dirty; otherwise, false.

IsNew

bool Apac.Monitoring.Persistable.IsNew

getset

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

true if this instance is new; otherwise, false.

Tag

object Apac.Monitoring.Persistable.Tag

getset

Gets or sets an arbitrary value that application code can use to track application specific data on an instance of this type.

The tag is not cloned or explicitly serialized, but may be serialized by some providers.

Event Documentation

PropertyChanged

PropertyChangedEventHandler Apac.Monitoring.Persistable.PropertyChanged

Occurs when a property value changes.

---

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

• /var/lib/jenkins/workspace/apac/APAC/APACCore/Monitoring/Persistable.cs