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

The configuration used to control the behavior of Apac.Data.IDataStores. More...

Inheritance diagram for Apac.Configuration.DataStoreConfig:
Apac.Configuration.SupervisableConfig Apac.Configuration.ConfigElement

Public Member Functions

 DataStoreConfig ()
 Initializes a new instance of the DataStoreConfig class. More...
 
 DataStoreConfig (string location, string type, string name, string description, bool prioritized, int liveMeasurementCacheMins, int liveMaeusrementArchiveDays)
 Initializes a new instance of the DataStoreConfig class. More...
 
- Public Member Functions inherited from Apac.Configuration.SupervisableConfig
 SupervisableConfig ()
 Initializes a new instance of the SupervisableConfig class. More...
 
 SupervisableConfig (string name, string configType, string type, string description, bool prioritized)
 Initializes a new instance of the SupervisableConfig class. More...
 
- Public Member Functions inherited from Apac.Configuration.ConfigElement
 ConfigElement ()
 Initializes a new instance of the ConfigElement class. More...
 
 ConfigElement (string name, string description, bool enabled)
 Initializes a new instance of the ConfigElement class. More...
 
override int GetHashCode ()
 Returns a hash code for this instance. More...
 
override bool Equals (object compareTo)
 Determines whether the specified System.Object is equal to this instance. More...
 
System.Xml.Schema.XmlSchema GetSchema ()
 This method is reserved and should not be used. When implementing the IXmlSerializable interface, you should return null (Nothing in Visual Basic) from this method, and instead, if specifying a custom schema is required, apply the T:System.Xml.Serialization.XmlSchemaProviderAttribute to the class. 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 OnWriteXml (System.Xml.XmlWriter writer)
 Called when serializing via XML. More...
 
override void OnReadXml (System.Xml.XmlReader reader)
 Called when deserializing via XML. More...
 
- Protected Member Functions inherited from Apac.Configuration.SupervisableConfig
override void OnWriteXml (System.Xml.XmlWriter writer)
 Called when serializing via XML. More...
 
override void OnReadXml (System.Xml.XmlReader reader)
 Called when deserializing via XML. More...
 

Properties

string Location [get, set]
 Gets or sets the location. More...
 
int LiveMeasurementArchiveDays [get, set]
 Gets or sets the live measurement archive days. More...
 
string MeasurementCacheLocation [get, set]
 Gets or sets the measurement cache location. More...
 
string FiveMinuteAvgCacheLocation [get, set]
 Gets or sets the five minute average cache location. More...
 
int LiveMeasurementCacheMinutes [get, set]
 Gets or sets the live measurement cache minutes. More...
 
- Properties inherited from Apac.Configuration.SupervisableConfig
string TypeName [get, set]
 Gets or sets the name of the type of the supervisable component. More...
 
string TypeForConfig [get, set]
 Gets or sets the type for the SupervisableConfig. More...
 
bool Prioritized [get, set]
 Gets or sets a value indicating whether the Apac.ISupervisable is prioritized. More...
 
ReferenceConfigCollection References [get]
 Gets the references. More...
 
- Properties inherited from Apac.Configuration.ConfigElement
virtual bool IsValid [get]
 Gives a way for subclasses to determine validity. More...
 
string Name [get, set]
 Gets or sets the name property setting. More...
 
string Description [get, set]
 Gets or sets the description property setting. More...
 
bool Enabled [get, set]
 Gets or sets a value indicating whether this ConfigElement is enabled. More...
 
log4net.ILog Log [get]
 Provides a log4net.ILog instance for use by the whole class hierarchy. More...
 

Detailed Description

The configuration used to control the behavior of Apac.Data.IDataStores.

Constructor & Destructor Documentation

◆ DataStoreConfig() [1/2]

Apac.Configuration.DataStoreConfig.DataStoreConfig ( )
inline

Initializes a new instance of the DataStoreConfig class.

◆ DataStoreConfig() [2/2]

Apac.Configuration.DataStoreConfig.DataStoreConfig ( string  location,
string  type,
string  name,
string  description,
bool  prioritized,
int  liveMeasurementCacheMins,
int  liveMaeusrementArchiveDays 
)
inline

Initializes a new instance of the DataStoreConfig class.

Parameters
locationThe location.
typeThe type.
nameThe name.
descriptionThe description.
prioritizedif set to true [prioritized].
liveMeasurementCacheMinsThe live measurement cache mins.
liveMaeusrementArchiveDaysThe live maeusrement archive days.

Member Function Documentation

◆ OnReadXml()

override void Apac.Configuration.DataStoreConfig.OnReadXml ( System.Xml.XmlReader  reader)
inlineprotectedvirtual

Called when deserializing via XML.

Parameters
readerThe reader.

Reimplemented from Apac.Configuration.ConfigElement.

◆ OnWriteXml()

override void Apac.Configuration.DataStoreConfig.OnWriteXml ( System.Xml.XmlWriter  writer)
inlineprotectedvirtual

Called when serializing via XML.

Parameters
writerThe writer.

Reimplemented from Apac.Configuration.ConfigElement.

Property Documentation

◆ FiveMinuteAvgCacheLocation

string Apac.Configuration.DataStoreConfig.FiveMinuteAvgCacheLocation
getset

Gets or sets the five minute average cache location.

The five minute average cache location.

◆ LiveMeasurementArchiveDays

int Apac.Configuration.DataStoreConfig.LiveMeasurementArchiveDays
getset

Gets or sets the live measurement archive days.

The live measurement archive days.

◆ LiveMeasurementCacheMinutes

int Apac.Configuration.DataStoreConfig.LiveMeasurementCacheMinutes
getset

Gets or sets the live measurement cache minutes.

The live measurement cache minutes.

◆ Location

string Apac.Configuration.DataStoreConfig.Location
getset

Gets or sets the location.

The location.

◆ MeasurementCacheLocation

string Apac.Configuration.DataStoreConfig.MeasurementCacheLocation
getset

Gets or sets the measurement cache location.

The measurement cache location.


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