dds::user_defaults_api::CUserDefaults Class Reference

#include <UserDefaults.h>

Public Member Functions
void	reinit (const boost::uuids::uuid &_sid, const std::string &_cfgFileName, bool _get_default=false)
std::string	getValueForKey (const std::string &_key) const
const SDDSUserDefaultsOptions_t	getOptions () const
std::string	getWrkDir () const
	Returns DDS working directory. For agents it is always $DDS_LOCATION. More...
std::string	getServerInfoFileLocationSrv () const
std::string	getServerInfoFileName () const
std::string	getServerInfoFileLocation () const
std::string	getWrkPkgDir () const
std::string	getWrkPkgPath () const
std::string	getWrkScriptPath () const
std::string	getUserEnvScript () const
std::string	getLogFile () const
std::string	getAgentLogStorageDir () const
pid_t	getScoutPid () const
std::string	getSMLeaderOutputName (uint64_t _protocolHeaderID) const
std::string	getSMLeaderInputName (uint64_t _protocolHeaderID) const
std::vector< std::string >	getSMLeaderInputNames () const
std::string	getPluginsRootDir () const
std::string	getMainSIDFile () const
	Returns the full path to the main Session ID file The function doesn't check wheather the file exists or not. More...
std::string	getSIDFile () const
	Returns Session ID full file path (return main SID if exists. If there is no main, it checks for a clone SID. If none of SID exist, the fucntions returns an empty string) More...
std::string	getLockedSID () const
std::string	getCurrentSID () const
std::string	getDefaultSIDLinkName () const
std::string	getDefaultSID () const
void	setDefaultSID (const boost::uuids::uuid &_sid) const noexcept
std::string	getSessionsRootDir () const
std::string	getSessionsHolderDirName () const
bool	IsSessionRunning (const boost::uuids::uuid &_sid=boost::uuids::nil_uuid()) const
std::string	getCommanderPidFileName () const
std::string	getCommanderPidFile (const boost::uuids::uuid &_sid=boost::uuids::nil_uuid()) const
std::string	getWnBinsDir () const
bool	isAgentInstance () const
std::string	getSlotsRootDir () const
std::string	getPluginDir (const std::string &_path, const std::string &_pluginName) const
	Returns path to the plugin's directory for specified plug-in name. More...

Static Public Member Functions
static CUserDefaults &	instance (const boost::uuids::uuid &_sid=CUserDefaults::getInitialSID())
	Return singleton instance. More...
static boost::uuids::uuid	getInitialSID ()
static void	printDefaults (std::ostream &_stream)
static std::string	currentUDFile ()
static std::string	getDDSPath ()
static std::string	getAgentIDFilePath ()
static std::string	getAgentIDFileName ()
static std::string	getTopologyXSDFilePath ()
static size_t	getNumLeaderFW ()

Member Function Documentation

currentUDFile()

string CUserDefaults::currentUDFile ( )

static

getAgentIDFileName()

string CUserDefaults::getAgentIDFileName ( )

static

getAgentIDFilePath()

string CUserDefaults::getAgentIDFilePath ( )

static

getAgentLogStorageDir()

string CUserDefaults::getAgentLogStorageDir

(

)

const

getCommanderPidFile()

string CUserDefaults::getCommanderPidFile

(

const boost::uuids::uuid &

_sid = boost::uuids::nil_uuid()

)

const

getCommanderPidFileName()

string CUserDefaults::getCommanderPidFileName

(

)

const

getCurrentSID()

string CUserDefaults::getCurrentSID

(

)

const

getDDSPath()

string CUserDefaults::getDDSPath ( )

static

getDefaultSID()

string CUserDefaults::getDefaultSID

(

)

const

getDefaultSIDLinkName()

string CUserDefaults::getDefaultSIDLinkName

(

)

const

getInitialSID()

boost::uuids::uuid CUserDefaults::getInitialSID ( )

static

getLockedSID()

string CUserDefaults::getLockedSID

(

)

const

getLogFile()

string CUserDefaults::getLogFile

(

)

const

getMainSIDFile()

string CUserDefaults::getMainSIDFile

(

)

const

Returns the full path to the main Session ID file The function doesn't check wheather the file exists or not.

getNumLeaderFW()

size_t CUserDefaults::getNumLeaderFW ( )

static

getOptions()

const SDDSUserDefaultsOptions_t CUserDefaults::getOptions

(

)

const

getPluginDir()

string CUserDefaults::getPluginDir	(	const std::string &	_path,
		const std::string &	_pluginName
	)		const

Returns path to the plugin's directory for specified plug-in name.

Parameters

[in]	_path	Path to the root plug-ins directory. If not specified (i.e. empty string is provided) than default root plug-ins directory is used.
[in]	_pluginName	Name of the plug-in.

getPluginsRootDir()

string CUserDefaults::getPluginsRootDir

(

)

const

getScoutPid()

pid_t CUserDefaults::getScoutPid

(

)

const

getServerInfoFileLocation()

string CUserDefaults::getServerInfoFileLocation

(

)

const

getServerInfoFileLocationSrv()

string CUserDefaults::getServerInfoFileLocationSrv

(

)

const

getServerInfoFileName()

string CUserDefaults::getServerInfoFileName

(

)

const

getSessionsHolderDirName()

string CUserDefaults::getSessionsHolderDirName

(

)

const

getSessionsRootDir()

string CUserDefaults::getSessionsRootDir

(

)

const

getSIDFile()

string CUserDefaults::getSIDFile

(

)

const

Returns Session ID full file path (return main SID if exists. If there is no main, it checks for a clone SID. If none of SID exist, the fucntions returns an empty string)

getSlotsRootDir()

std::string CUserDefaults::getSlotsRootDir

(

)

const

getSMLeaderInputName()

std::string CUserDefaults::getSMLeaderInputName

(

uint64_t

_protocolHeaderID

)

const

getSMLeaderInputNames()

std::vector< std::string > CUserDefaults::getSMLeaderInputNames

(

)

const

getSMLeaderOutputName()

std::string CUserDefaults::getSMLeaderOutputName

(

uint64_t

_protocolHeaderID

)

const

getTopologyXSDFilePath()

string CUserDefaults::getTopologyXSDFilePath ( )

static

getUserEnvScript()

string CUserDefaults::getUserEnvScript

(

)

const

getValueForKey()

string CUserDefaults::getValueForKey

(

const std::string &

_key

)

const

getWnBinsDir()

string CUserDefaults::getWnBinsDir

(

)

const

getWrkDir()

std::string CUserDefaults::getWrkDir

(

)

const

Returns DDS working directory. For agents it is always $DDS_LOCATION.

getWrkPkgDir()

string CUserDefaults::getWrkPkgDir

(

)

const

getWrkPkgPath()

string CUserDefaults::getWrkPkgPath

(

)

const

getWrkScriptPath()

string CUserDefaults::getWrkScriptPath

(

)

const

instance()

CUserDefaults & CUserDefaults::instance ( const boost::uuids::uuid &  _sid = CUserDefaults::getInitialSID() )

static

Return singleton instance.

isAgentInstance()

bool CUserDefaults::isAgentInstance

(

)

const

IsSessionRunning()

bool CUserDefaults::IsSessionRunning

(

const boost::uuids::uuid &

_sid = boost::uuids::nil_uuid()

)

const

printDefaults()

void CUserDefaults::printDefaults ( std::ostream &  _stream )

static

reinit()

void CUserDefaults::reinit	(	const boost::uuids::uuid &	_sid,
		const std::string &	_cfgFileName,
		bool	_get_default = false
	)

setDefaultSID()

void CUserDefaults::setDefaultSID ( const boost::uuids::uuid &  _sid ) const

noexcept

---

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

• UserDefaults.h
• UserDefaults.cpp