ifw-ccf 4.0.0
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
ccf::common::Setup Class Reference

Global setup class for CCF applications. An Initialisation Setup, containing all the parameters shall be loaded before using the class. More...

#include <setup.hpp>

Inheritance diagram for ccf::common::Setup:
ccf::Base

Public Member Functions

 Setup ()
 
 ~Setup ()
 
elt::configng::CiiConfigInstanceNode & GetNode (const std::vector< std::string > &names)
 Get the reference to a specific node in the Installed Setup.
 
elt::configng::CiiConfigInstanceNode & GetStagingNode (const std::vector< std::string > &names)
 Get the reference to a specific node in the Staging Setup.
 
elt::configng::CiiConfigInstanceNode & GetNode (const elt::configng::CiiConfigDocument *doc, const std::vector< std::string > &names)
 Get the reference to a specific node in the referenced CII Cfg Service doc object.
 
const std::string & GetRootNodeName () const
 Return the name of the setup document root node name.
 
template<class TYPE >
bool HasPar (const std::vector< std::string > &names, TYPE &value)
 
bool ParDefined (const std::string &name)
 Check if the given parameter is defined in the Reference Setup.
 
template<class TYPE >
bool HasStagingPar (const std::vector< std::string > &names, TYPE &value)
 
bool HasStagingNodeKey (const std::string &name)
 Probe if a given parameter is defined among the Setup Staging Parameters.
 
template<class TYPE >
bool HasStagingParKey (const std::string &name, TYPE &value)
 
void ResetStagingSetup ()
 Reset the internal Staging Setup.
 
template<class TYPE >
void AddStagingPar (const std::string &name, const TYPE value)
 
const std::map< std::string, std::string > & GetSetupCmdStagingPars ()
 Return list of staging pars, provided via the Setup command.
 
void GetPars (std::map< std::string, std::string > &pars, const std::string &pattern="*")
 Return map with all parameters in the object. Staging pars take precedence.
 
template<class TYPE >
TYPE GetValue (const std::vector< std::string > &names)
 Get value from either the 1) Staging Setup, or 2) Installed Setup.
 
template<class TYPE >
TYPE GetValueKey (const std::string &name)
 Get value from either the 1) Staging Setup, or 2) Installed Setup from the SPF key.
 
void LoadStagingSetup (const std::string &filename)
 Load a Setup File into the Staging Setup object.
 
void AcceptStagingSetup ()
 Merge the parameters in the Staging Setup into the Installed Setup set of parameters.
 
std::string SetupFileToString () const
 Return string representation of the setup file loaded.
 
std::vector< std::string > CheckNodeNames (const std::vector< std::string > &names) const
 
std::string CheckNodeName (const std::string &name) const
 
const elt::configng::CiiConfigDocument & GetRefSetup () const
 
- Public Member Functions inherited from ccf::Base
 Base ()
 
 ~Base ()
 
const std::string & GetClassName () const
 Return the allocated name of the class.
 

Static Public Member Functions

static Setup & Instance ()
 Return reference to unique instance of the application class.
 
- Static Public Member Functions inherited from ccf::Base
static ccf::mptk::Manager & Mptk ()
 Return reference to internal MPTK instance (singleton).
 

Static Public Attributes

static Setup * s_instance = nullptr
 Singleton instance.
 

Additional Inherited Members

- Protected Member Functions inherited from ccf::Base
void SetClassName (const std::string &class_name)
 Set the name of the class in question.
 

Detailed Description

Global setup class for CCF applications. An Initialisation Setup, containing all the parameters shall be loaded before using the class.

Constructor & Destructor Documentation

◆ Setup()

ccf::common::Setup::Setup ( )

◆ ~Setup()

ccf::common::Setup::~Setup ( )

Member Function Documentation

◆ AcceptStagingSetup()

void ccf::common::Setup::AcceptStagingSetup ( )

Merge the parameters in the Staging Setup into the Installed Setup set of parameters.

◆ AddStagingPar()

template<class TYPE >
void ccf::common::Setup::AddStagingPar ( const std::string &  name,
const TYPE  value 
)
inline

Add a Staging Setup Parameter in the object given on SPF format ("<key el 1>.<key el 2>. ...").

◆ CheckNodeName()

std::string ccf::common::Setup::CheckNodeName ( const std::string &  name) const

◆ CheckNodeNames()

std::vector< std::string > ccf::common::Setup::CheckNodeNames ( const std::vector< std::string > &  names) const

◆ GetNode() [1/2]

elt::configng::CiiConfigInstanceNode & ccf::common::Setup::GetNode ( const elt::configng::CiiConfigDocument *  doc,
const std::vector< std::string > &  names 
)

Get the reference to a specific node in the referenced CII Cfg Service doc object.

◆ GetNode() [2/2]

elt::configng::CiiConfigInstanceNode & ccf::common::Setup::GetNode ( const std::vector< std::string > &  names)

Get the reference to a specific node in the Installed Setup.

◆ GetPars()

void ccf::common::Setup::GetPars ( std::map< std::string, std::string > &  pars,
const std::string &  pattern = "*" 
)

Return map with all parameters in the object. Staging pars take precedence.

◆ GetRefSetup()

const elt::configng::CiiConfigDocument & ccf::common::Setup::GetRefSetup ( ) const

◆ GetRootNodeName()

const std::string & ccf::common::Setup::GetRootNodeName ( ) const

Return the name of the setup document root node name.

◆ GetSetupCmdStagingPars()

const std::map< std::string, std::string > & ccf::common::Setup::GetSetupCmdStagingPars ( )

Return list of staging pars, provided via the Setup command.

◆ GetStagingNode()

elt::configng::CiiConfigInstanceNode & ccf::common::Setup::GetStagingNode ( const std::vector< std::string > &  names)

Get the reference to a specific node in the Staging Setup.

◆ GetValue()

template<class TYPE >
TYPE ccf::common::Setup::GetValue ( const std::vector< std::string > &  names)
inline

Get value from either the 1) Staging Setup, or 2) Installed Setup.

◆ GetValueKey()

template<class TYPE >
TYPE ccf::common::Setup::GetValueKey ( const std::string &  name)
inline

Get value from either the 1) Staging Setup, or 2) Installed Setup from the SPF key.

◆ HasPar()

template<class TYPE >
bool ccf::common::Setup::HasPar ( const std::vector< std::string > &  names,
TYPE &  value 
)
inline

Probe if a given parameter is defined in the set. Return true if yes and set the value to the value of the parameter.

◆ HasStagingNodeKey()

bool ccf::common::Setup::HasStagingNodeKey ( const std::string &  name)

Probe if a given parameter is defined among the Setup Staging Parameters.

◆ HasStagingPar()

template<class TYPE >
bool ccf::common::Setup::HasStagingPar ( const std::vector< std::string > &  names,
TYPE &  value 
)
inline

Probe if a given parameter is defined among the Setup Staging Parameters. Return true if yes and set the value to the value of the parameter.

◆ HasStagingParKey()

template<class TYPE >
bool ccf::common::Setup::HasStagingParKey ( const std::string &  name,
TYPE &  value 
)
inline

Probe if a given parameter is defined among the Setup Staging Parameters. Return true if yes and set the value to the value of the parameter.

◆ Instance()

Setup & ccf::common::Setup::Instance ( )
static

Return reference to unique instance of the application class.

◆ LoadStagingSetup()

void ccf::common::Setup::LoadStagingSetup ( const std::string &  filename)

Load a Setup File into the Staging Setup object.

◆ ParDefined()

bool ccf::common::Setup::ParDefined ( const std::string &  name)

Check if the given parameter is defined in the Reference Setup.

Returns
True if parameter is defined.

◆ ResetStagingSetup()

void ccf::common::Setup::ResetStagingSetup ( )

Reset the internal Staging Setup.

◆ SetupFileToString()

std::string ccf::common::Setup::SetupFileToString ( ) const

Return string representation of the setup file loaded.

Member Data Documentation

◆ s_instance

Setup * ccf::common::Setup::s_instance = nullptr
static

Singleton instance.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.6