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

The configuration used to control the behavior of an Apac.Supervisors.ExecutiveSupervisor. More...

Inheritance diagram for Apac.Configuration.ExecutiveSupervisorConfig:
Apac.Configuration.ConfigElement

Public Member Functions

 ExecutiveSupervisorConfig ()
 Initializes a new instance of the ExecutiveSupervisorConfig 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...
 

Static Public Attributes

static readonly string ElementName = "executiveSupervisor"
 The name of the element used to contain this configuration in XML. More...
 

Protected Member Functions

override void OnWriteXml (System.Xml.XmlWriter writer)
 Called when XML is being written. More...
 
override void OnReadXml (System.Xml.XmlReader reader)
 Called when XML is being read. More...
 

Properties

bool StrictRefs [get, set]
 Gets or sets a value indicating whether the executive supervisor enforces strict references. More...
 
ReferenceConfigCollection References [get]
 Gets the references. More...
 
List< SupervisorConfigSubordinateConfigs [get]
 Gets the configurations for subordinate supervisable components. 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 an Apac.Supervisors.ExecutiveSupervisor.

Constructor & Destructor Documentation

◆ ExecutiveSupervisorConfig()

Apac.Configuration.ExecutiveSupervisorConfig.ExecutiveSupervisorConfig ( )
inline

Initializes a new instance of the ExecutiveSupervisorConfig class.

Member Function Documentation

◆ OnReadXml()

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

Called when XML is being read.

Parameters
readerThe reader.

Reimplemented from Apac.Configuration.ConfigElement.

◆ OnWriteXml()

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

Called when XML is being written.

Parameters
writerThe writer.

Reimplemented from Apac.Configuration.ConfigElement.

Member Data Documentation

◆ ElementName

readonly string Apac.Configuration.ExecutiveSupervisorConfig.ElementName = "executiveSupervisor"
static

The name of the element used to contain this configuration in XML.

Property Documentation

◆ References

ReferenceConfigCollection Apac.Configuration.ExecutiveSupervisorConfig.References
get

Gets the references.

◆ StrictRefs

bool Apac.Configuration.ExecutiveSupervisorConfig.StrictRefs
getset

Gets or sets a value indicating whether the executive supervisor enforces strict references.

true if strict references are to be enforced; otherwise, false.

◆ SubordinateConfigs

List<SupervisorConfig> Apac.Configuration.ExecutiveSupervisorConfig.SubordinateConfigs
get

Gets the configurations for subordinate supervisable components.


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