Inheritance diagram for Apac.Ecop.DataManagerConfig:

Public Member Functions
	DataManagerConfig ()
	Initializes a new instance of the DataManagerConfig class. More...

	DataManagerConfig (bool regenDetailGraphs, double regenInterval, string docOutputRootDir, string docOutputDir, string historyRootDir, string dataStoreRef, string settingsStoreRef, string compilerRef, string urlBase, string name, string configType, string type, string description, bool prioritized)
	Initializes a new instance of the DataManagerConfig 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...

Properties
bool	RegenDetailGraphs `[get, set]`
	Gets or sets a value indicating whether detail graphs should be regenerated. More...

double	RegenerationIntervalMinutes `[get, set]`
	Gets or sets the regeneration interval in minutes, which determines how often the dynamic web content is updated by the data manager. More...

string	DocumentOutputRootDirectory `[get, set]`
	Gets or sets the base directory to which dynamic content is generated. This value controls the physical location from which the website is served. More...

string	DocumentOutputDirectory `[get, set]`
	Gets or sets the directory, relative to the DocumentOutputRootDirectory, to which the dynamic content is written. More...

string	OutputPath `[get]`
	A helper that formulates the data output path for the manager based on the root directory and the relative output directory. More...

string	HistoryRootDirectory `[get, set]`
	Gets or sets the history root directory, which determines where the historical report content gets saved. More...

string	DataStoreRef `[get, set]`
	Gets or sets the name of the supervisable component providing data store services. More...

string	SettingsStoreRef `[get, set]`
	Gets or sets the name of the supervisable component providing setting store services. More...

string	CompilerRef `[get, set]`
	Gets or sets the name of the supervisable component providing compiler services. More...

string	UrlBase `[get, set]`
	Gets or sets the base of the URL the is served by the datamanager for clients' use when connecting. The default value is 'https://‍/', meaning 'listen on any local IP address, port 443, and only accept HTTPS connections. A very good option for testing would be 'http://.8888/'. 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...

Constructor & Destructor Documentation

◆ DataManagerConfig() [1/2]

Apac.Ecop.DataManagerConfig.DataManagerConfig ( )

inline

Initializes a new instance of the DataManagerConfig class.

◆ DataManagerConfig() [2/2]

Apac.Ecop.DataManagerConfig.DataManagerConfig	(	bool	regenDetailGraphs,
		double	regenInterval,
		string	docOutputRootDir,
		string	docOutputDir,
		string	historyRootDir,
		string	dataStoreRef,
		string	settingsStoreRef,
		string	compilerRef,
		string	urlBase,
		string	name,
		string	configType,
		string	type,
		string	description,
		bool	prioritized
	)

inline

Initializes a new instance of the DataManagerConfig class.

Parameters

regenDetailGraphs	See RegenDetailGraphs.
regenInterval	See RegenerationIntervalMinutes.
docOutputRootDir	See DocumentOutputRootDirectory.
docOutputDir	See DocumentOutputDirectory.
historyRootDir	See HistoryRootDirectory.
dataStoreRef	See DataStoreRef.
settingsStoreRef	See SettingsStoreRef.
compilerRef	See CompilerRef.
urlBase	See UrlBase.
name	See SupervisableConfig.Name.
configType	See SupervisableConfig.ConfigType.
type	See SupervisableConfig.Type.
description	See SupervisableConfig.Description.
prioritized	See SupervisableConfig.Prioritized.

Member Function Documentation

◆ OnReadXml()

override void Apac.Ecop.DataManagerConfig.OnReadXml ( System.Xml.XmlReader reader )

inlineprotectedvirtual

Called when deserializing via XML.

Parameters

reader The reader.

Reimplemented from Apac.Configuration.SupervisableConfig.

◆ OnWriteXml()

override void Apac.Ecop.DataManagerConfig.OnWriteXml ( System.Xml.XmlWriter writer )

inlineprotectedvirtual

Called when serializing via XML.

Parameters

writer The writer.

Reimplemented from Apac.Configuration.SupervisableConfig.

Property Documentation

◆ CompilerRef

string Apac.Ecop.DataManagerConfig.CompilerRef

getset

Gets or sets the name of the supervisable component providing compiler services.

The compiler reference.

◆ DataStoreRef

string Apac.Ecop.DataManagerConfig.DataStoreRef

getset

Gets or sets the name of the supervisable component providing data store services.

The data store reference.

◆ DocumentOutputDirectory

string Apac.Ecop.DataManagerConfig.DocumentOutputDirectory

getset

Gets or sets the directory, relative to the DocumentOutputRootDirectory, to which the dynamic content is written.

The document output directory.

This should always be a relative path, never an abolute path.

◆ DocumentOutputRootDirectory

string Apac.Ecop.DataManagerConfig.DocumentOutputRootDirectory

getset

Gets or sets the base directory to which dynamic content is generated. This value controls the physical location from which the website is served.

The document output base directory.

If this is a relative path, then the location will be within the hosting applications execution path.

◆ HistoryRootDirectory

string Apac.Ecop.DataManagerConfig.HistoryRootDirectory

getset

Gets or sets the history root directory, which determines where the historical report content gets saved.

The history root directory.

◆ OutputPath

string Apac.Ecop.DataManagerConfig.OutputPath

get

A helper that formulates the data output path for the manager based on the root directory and the relative output directory.

The output path.

◆ RegenDetailGraphs

bool Apac.Ecop.DataManagerConfig.RegenDetailGraphs

getset

Gets or sets a value indicating whether detail graphs should be regenerated.

true if detail graphs should be regenerated; otherwise, false.

◆ RegenerationIntervalMinutes

double Apac.Ecop.DataManagerConfig.RegenerationIntervalMinutes

getset

Gets or sets the regeneration interval in minutes, which determines how often the dynamic web content is updated by the data manager.

The regeneration interval minutes.

◆ SettingsStoreRef

string Apac.Ecop.DataManagerConfig.SettingsStoreRef

getset

Gets or sets the name of the supervisable component providing setting store services.

The settings store reference.

◆ UrlBase

string Apac.Ecop.DataManagerConfig.UrlBase

getset

Gets or sets the base of the URL the is served by the datamanager for clients' use when connecting. The default value is 'https://*‍/', meaning 'listen on any local IP address, port 443, and only accept HTTPS connections. A very good option for testing would be 'http://*.8888/'.

The URL base.

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

/var/lib/jenkins/workspace/apac/APAC/Ecop/DataManagerConfig.cs

Public Member Functions

Protected Member Functions

Properties

Constructor & Destructor Documentation

◆ DataManagerConfig() [1/2]

◆ DataManagerConfig() [2/2]

Member Function Documentation

◆ OnReadXml()

◆ OnWriteXml()

Property Documentation

◆ CompilerRef

◆ DataStoreRef

◆ DocumentOutputDirectory

◆ DocumentOutputRootDirectory

◆ HistoryRootDirectory

◆ OutputPath

◆ RegenDetailGraphs

◆ RegenerationIntervalMinutes

◆ SettingsStoreRef

◆ UrlBase