COVISE Core
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
covise::coConfigRoot Class Referenceabstract

#include <coConfigRoot.h>

Inheritance diagram for covise::coConfigRoot:
Inheritance graph
[legend]
Collaboration diagram for covise::coConfigRoot:
Collaboration graph
[legend]

Public Member Functions

 coConfigRoot (const QString &name, const QString &filename, bool create=false, coConfigGroup *group=NULL)
 
virtual ~coConfigRoot ()
 
virtual coConfigEntryStringList getScopeList (const QString &section=0, const QString &variableName=0) const
 
virtual coConfigEntryStringList getVariableList (const QString &section=0) const
 
virtual coConfigEntryString getValue (const QString &variable, const QString &section, const QString &defaultValue) const
 
virtual coConfigEntryString getValue (const QString &variable, const QString &section) const
 
virtual coConfigEntryString getValue (const QString &simpleVariable) const
 
virtual const char * getEntry (const char *simpleVariable) const
 
virtual bool isOn (const QString &variable, const QString &section, bool defaultValue) const
 
virtual bool isOn (const QString &variable, const QString &section) const
 
virtual bool isOn (const QString &simpleVariable, bool defaultValue) const
 
virtual bool isOn (const QString &simpleVariable) const
 
virtual void setValue (const QString &variable, const QString &value, const QString &section, const QString &targetHost=0, bool move=false)
 
virtual bool deleteValue (const QString &variable, const QString &section, const QString &targetHost=0)
 
virtual bool deleteSection (const QString &section, const QString &targetHost=0)
 
virtual QStringList getHostnameList () const
 
virtual QString getActiveHost () const
 
virtual bool setActiveHost (const QString &host)
 
virtual QStringList getClusterList () const
 
virtual QString getActiveCluster () const
 
virtual bool setActiveCluster (const QString &master)
 
virtual const QString & getConfigName () const
 
virtual void reload ()
 
virtual bool save (const QString &filename=QString()) const
 
void setGroup (coConfigGroup *group)
 
void setReadOnly (bool ro)
 
bool isReadOnly () const
 
QStringList getHosts ()
 
coConfigEntrygetConfigForHost (const QString &hostname)
 
coConfigEntrygetConfigForCluster (const QString &masterhost)
 
coConfigEntrygetGlobalConfig ()
 
virtual coConfigRootclone () const =0
 
virtual void merge (const coConfigRoot *with)=0
 

Static Public Member Functions

static coConfigRootcreateNew (const QString &name, const QString &filename, bool create=false, coConfigGroup *group=NULL)
 

Protected Member Functions

virtual void load (bool create=false)=0
 
void init ()
 
QString findConfigFile (const QString &filename, bool preferGlobal=false)
 
void findLocalConfig (const QString &filename, QFile &target)
 
void findGlobalConfig (const QString &filename, QFile &target)
 
void clear ()
 
virtual void createGlobalConfig ()=0
 
virtual void createHostConfig (const QString &hostname)=0
 
virtual void createClusterConfig (const QString &mastername)=0
 

Protected Attributes

coConfigGroupgroup
 
QString filename
 
QString activeHostname
 
QStringList hostnames
 
QString activeCluster
 
QStringList masternames
 
QString configName
 
coConfigEntryglobalConfig
 
coConfigEntryclusterConfig
 
coConfigEntryhostConfig
 
QHash< QString, coConfigEntry * > hostConfigs
 
QHash< QString, coConfigEntry * > clusterConfigs
 
bool create
 
bool readOnly
 
QSet< QString > included
 

Friends

class coConfigXercesRoot
 

Constructor & Destructor Documentation

◆ coConfigRoot()

coConfigRoot::coConfigRoot ( const QString &  name,
const QString &  filename,
bool  create = false,
coConfigGroup group = NULL 
)

◆ ~coConfigRoot()

coConfigRoot::~coConfigRoot ( )
virtual

Member Function Documentation

◆ clear()

void coConfigRoot::clear ( )
protected

◆ clone()

virtual coConfigRoot * covise::coConfigRoot::clone ( ) const
pure virtual

Implemented in covise::coConfigXercesRoot.

◆ createClusterConfig()

virtual void covise::coConfigRoot::createClusterConfig ( const QString &  mastername)
protectedpure virtual

Implemented in covise::coConfigXercesRoot.

◆ createGlobalConfig()

virtual void covise::coConfigRoot::createGlobalConfig ( )
protectedpure virtual

Implemented in covise::coConfigXercesRoot.

◆ createHostConfig()

virtual void covise::coConfigRoot::createHostConfig ( const QString &  hostname)
protectedpure virtual

Implemented in covise::coConfigXercesRoot.

◆ createNew()

coConfigRoot * coConfigRoot::createNew ( const QString &  name,
const QString &  filename,
bool  create = false,
coConfigGroup group = NULL 
)
static

◆ deleteSection()

bool coConfigRoot::deleteSection ( const QString &  section,
const QString &  targetHost = 0 
)
virtual

◆ deleteValue()

bool coConfigRoot::deleteValue ( const QString &  variable,
const QString &  section,
const QString &  targetHost = 0 
)
virtual

◆ findConfigFile()

QString coConfigRoot::findConfigFile ( const QString &  filename,
bool  preferGlobal = false 
)
protected

◆ findGlobalConfig()

void coConfigRoot::findGlobalConfig ( const QString &  filename,
QFile &  target 
)
protected

◆ findLocalConfig()

void coConfigRoot::findLocalConfig ( const QString &  filename,
QFile &  target 
)
protected

◆ getActiveCluster()

QString coConfigRoot::getActiveCluster ( ) const
virtual

◆ getActiveHost()

QString coConfigRoot::getActiveHost ( ) const
virtual

◆ getClusterList()

QStringList coConfigRoot::getClusterList ( ) const
virtual

◆ getConfigForCluster()

coConfigEntry * coConfigRoot::getConfigForCluster ( const QString &  masterhost)

◆ getConfigForHost()

coConfigEntry * coConfigRoot::getConfigForHost ( const QString &  hostname)

◆ getConfigName()

const QString & coConfigRoot::getConfigName ( ) const
virtual

◆ getEntry()

const char * coConfigRoot::getEntry ( const char *  simpleVariable) const
virtual

◆ getGlobalConfig()

coConfigEntry * covise::coConfigRoot::getGlobalConfig ( )
inline

◆ getHostnameList()

QStringList coConfigRoot::getHostnameList ( ) const
virtual

◆ getHosts()

QStringList coConfigRoot::getHosts ( )

◆ getScopeList()

coConfigEntryStringList coConfigRoot::getScopeList ( const QString &  section = 0,
const QString &  variableName = 0 
) const
virtual

◆ getValue() [1/3]

coConfigEntryString coConfigRoot::getValue ( const QString &  simpleVariable) const
virtual

◆ getValue() [2/3]

coConfigEntryString coConfigRoot::getValue ( const QString &  variable,
const QString &  section 
) const
virtual

◆ getValue() [3/3]

coConfigEntryString coConfigRoot::getValue ( const QString &  variable,
const QString &  section,
const QString &  defaultValue 
) const
virtual

◆ getVariableList()

coConfigEntryStringList coConfigRoot::getVariableList ( const QString &  section = 0) const
virtual

◆ init()

void coConfigRoot::init ( )
protected

◆ isOn() [1/4]

bool coConfigRoot::isOn ( const QString &  simpleVariable) const
virtual

◆ isOn() [2/4]

bool coConfigRoot::isOn ( const QString &  simpleVariable,
bool  defaultValue 
) const
virtual

◆ isOn() [3/4]

bool coConfigRoot::isOn ( const QString &  variable,
const QString &  section 
) const
virtual

◆ isOn() [4/4]

bool coConfigRoot::isOn ( const QString &  variable,
const QString &  section,
bool  defaultValue 
) const
virtual

◆ isReadOnly()

bool coConfigRoot::isReadOnly ( ) const

◆ load()

virtual void covise::coConfigRoot::load ( bool  create = false)
protectedpure virtual

Implemented in covise::coConfigXercesRoot.

◆ merge()

virtual void covise::coConfigRoot::merge ( const coConfigRoot with)
pure virtual

Implemented in covise::coConfigXercesRoot.

◆ reload()

void coConfigRoot::reload ( )
virtual

◆ save()

bool coConfigRoot::save ( const QString &  filename = QString()) const
virtual

◆ setActiveCluster()

bool coConfigRoot::setActiveCluster ( const QString &  master)
virtual

◆ setActiveHost()

bool coConfigRoot::setActiveHost ( const QString &  host)
virtual

◆ setGroup()

void coConfigRoot::setGroup ( coConfigGroup group)

◆ setReadOnly()

void coConfigRoot::setReadOnly ( bool  ro)

◆ setValue()

void coConfigRoot::setValue ( const QString &  variable,
const QString &  value,
const QString &  section,
const QString &  targetHost = 0,
bool  move = false 
)
virtual

Friends And Related Function Documentation

◆ coConfigXercesRoot

friend class coConfigXercesRoot
friend

Member Data Documentation

◆ activeCluster

QString covise::coConfigRoot::activeCluster
protected

◆ activeHostname

QString covise::coConfigRoot::activeHostname
protected

◆ clusterConfig

coConfigEntry* covise::coConfigRoot::clusterConfig
protected

◆ clusterConfigs

QHash<QString, coConfigEntry *> covise::coConfigRoot::clusterConfigs
protected

◆ configName

QString covise::coConfigRoot::configName
protected

◆ create

bool covise::coConfigRoot::create
protected

◆ filename

QString covise::coConfigRoot::filename
protected

◆ globalConfig

coConfigEntry* covise::coConfigRoot::globalConfig
protected

◆ group

coConfigGroup* covise::coConfigRoot::group
protected

◆ hostConfig

coConfigEntry* covise::coConfigRoot::hostConfig
protected

◆ hostConfigs

QHash<QString, coConfigEntry *> covise::coConfigRoot::hostConfigs
protected

◆ hostnames

QStringList covise::coConfigRoot::hostnames
protected

◆ included

QSet<QString> covise::coConfigRoot::included
protected

◆ masternames

QStringList covise::coConfigRoot::masternames
protected

◆ readOnly

bool covise::coConfigRoot::readOnly
protected

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