A basic configuration needed for any Apac.ISupervisable component, which ends up being subordinate to a Apac.Supervisors.ISupervisor. More...

Inheritance diagram for Apac.Configuration.SupervisableConfig:

Public Member Functions
	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...

Properties
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

A basic configuration needed for any Apac.ISupervisable component, which ends up being subordinate to a Apac.Supervisors.ISupervisor.

Constructor & Destructor Documentation

◆ SupervisableConfig() [1/2]

Apac.Configuration.SupervisableConfig.SupervisableConfig ( )

inline

Initializes a new instance of the SupervisableConfig class.

◆ SupervisableConfig() [2/2]

Apac.Configuration.SupervisableConfig.SupervisableConfig	(	string	name,
		string	configType,
		string	type,
		string	description,
		bool	prioritized
	)

inline

Initializes a new instance of the SupervisableConfig class.

Parameters

name	The name.
configType	Type of the config.
type	The type.
description	The description.
prioritized	if set to `true` [prioritized].

Member Function Documentation

◆ OnReadXml()

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

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader The reader.

Reimplemented from Apac.Configuration.ConfigElement.

Reimplemented in Apac.TcTec.Top16.Configuration.Top16DIOControllerConfig, Apac.PassiveHaus.PassiveHausConfig, Apac.Ecop.DataManagerConfig, Apac.Configuration.UdpNodeControllerConfig, and Apac.Configuration.SupervisorConfig.

◆ OnWriteXml()

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

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer The writer.

Reimplemented from Apac.Configuration.ConfigElement.

Reimplemented in Apac.TcTec.Top16.Configuration.Top16DIOControllerConfig, Apac.PassiveHaus.PassiveHausConfig, Apac.Ecop.DataManagerConfig, Apac.Configuration.UdpNodeControllerConfig, and Apac.Configuration.SupervisorConfig.

Property Documentation

◆ Prioritized

bool Apac.Configuration.SupervisableConfig.Prioritized

getset

Gets or sets a value indicating whether the Apac.ISupervisable is prioritized.

true if prioritized; otherwise, false.

◆ References

ReferenceConfigCollection Apac.Configuration.SupervisableConfig.References

get

Gets the references.

◆ TypeForConfig

string Apac.Configuration.SupervisableConfig.TypeForConfig

getset

Gets or sets the type for the SupervisableConfig.

The type for config.

◆ TypeName

string Apac.Configuration.SupervisableConfig.TypeName

getset

Gets or sets the name of the type of the supervisable component.

The name of the type.

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

/var/lib/jenkins/workspace/apac/APAC/APACCore/Configuration/SupervisableConfig.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SupervisableConfig() [1/2]

◆ SupervisableConfig() [2/2]

Member Function Documentation

◆ OnReadXml()

◆ OnWriteXml()

Property Documentation

◆ Prioritized

◆ References

◆ TypeForConfig

◆ TypeName