epics::pvAccess::Configuration Class Reference

Configuration. More...

#include <utils/pv/configuration.h>

Inheritance diagram for epics::pvAccess::Configuration:

Public Types
typedef std::tr1::shared_ptr< Configuration >	shared_pointer
typedef std::tr1::shared_ptr< const Configuration >	const_shared_pointer
typedef std::tr1::weak_ptr< Configuration >	weak_pointer
typedef std::tr1::weak_ptr< const Configuration >	const_weak_pointer
typedef std::set< std::string >	keys_t

Public Member Functions
bool	getPropertyAsBoolean (const std::string &name, const bool defaultValue) const
	Get the environment variable specified by name or return default value if it does not exist.
epics::pvData::int32	getPropertyAsInteger (const std::string &name, const epics::pvData::int32 defaultValue) const
	Get the environment variable specified by name or return default value if it does not exist.
float	getPropertyAsFloat (const std::string &name, const float defaultValue) const
	Get the environment variable specified by name or return default value if it does not exist.
double	getPropertyAsDouble (const std::string &name, const double defaultValue) const
	Get the environment variable specified by name or return default value if it does not exist.
std::string	getPropertyAsString (const std::string &name, const std::string &defaultValue) const
	Get the environment variable specified by name or return default value if it does not exist.
bool	getPropertyAsAddress (const std::string &name, osiSockAddr *addr) const
	Fetch and parse as a socket address and port number (address family set accordingly).
bool	hasProperty (const std::string &name) const
keys_t	keys () const
	Return a (partial) list of available key names.

Protected Member Functions
virtual bool	tryGetPropertyAsString (const std::string &name, std::string *val) const =0
virtual void	addKeys (keys_t &) const

Friends
class	ConfigurationStack

Detailed Description

Configuration.

Definition at line 45 of file configuration.h.

Member Typedef Documentation

const_shared_pointer

std::tr1::shared_ptr<const Configuration> epics::pvAccess::Configuration::const_shared_pointer

Definition at line 49 of file configuration.h.

const_weak_pointer

std::tr1::weak_ptr<const Configuration> epics::pvAccess::Configuration::const_weak_pointer

Definition at line 49 of file configuration.h.

keys_t

std::set<std::string> epics::pvAccess::Configuration::keys_t

Definition at line 117 of file configuration.h.

shared_pointer

std::tr1::shared_ptr<Configuration> epics::pvAccess::Configuration::shared_pointer

Definition at line 49 of file configuration.h.

weak_pointer

std::tr1::weak_ptr<Configuration> epics::pvAccess::Configuration::weak_pointer

Definition at line 49 of file configuration.h.

Constructor & Destructor Documentation

Configuration()

epics::pvAccess::Configuration::Configuration ( )

inline

Definition at line 51 of file configuration.h.

Member Function Documentation

addKeys()

virtual void epics::pvAccess::Configuration::addKeys ( keys_t & ) const

inlineprotectedvirtual

Definition at line 131 of file configuration.h.

getPropertyAsAddress()

bool epics::pvAccess::Configuration::getPropertyAsAddress	(	const std::string &	name,
		osiSockAddr *	addr ) const

Fetch and parse as a socket address and port number (address family set accordingly).

At present only numeric addresses are parsed (eg. "127.0.0.1:4242").

The storage pointed to be addr should be initialized with a default value, or zeroed.

Parameters

name	name of the environment variable to return. @pram addr pointer to the address struct to be filled in

Returns

true if addr now contains an address, false otherwise

getPropertyAsBoolean()

bool epics::pvAccess::Configuration::getPropertyAsBoolean	(	const std::string &	name,
		const bool	defaultValue ) const

Get the environment variable specified by name or return default value if it does not exist.

Parameters

name	name of the environment variable to return.
defualtValue	default value to return if environment variable does not exists.

Returns

environment variable value as bool or default value if it does not exist.

getPropertyAsDouble()

double epics::pvAccess::Configuration::getPropertyAsDouble	(	const std::string &	name,
		const double	defaultValue ) const

Get the environment variable specified by name or return default value if it does not exist.

Parameters

name	name of the environment variable to return.
defualtValue	default value to return if environment variable does not exists.

Returns

environment variable value as double or default value if it does not exist.

getPropertyAsFloat()

float epics::pvAccess::Configuration::getPropertyAsFloat	(	const std::string &	name,
		const float	defaultValue ) const

Get the environment variable specified by name or return default value if it does not exist.

Parameters

name	name of the environment variable to return.
defualtValue	default value to return if environment variable does not exists.

Returns

environment variable value as float or default value if it does not exist.

getPropertyAsInteger()

epics::pvData::int32 epics::pvAccess::Configuration::getPropertyAsInteger	(	const std::string &	name,
		const epics::pvData::int32	defaultValue ) const

Get the environment variable specified by name or return default value if it does not exist.

Parameters

name	name of the environment variable to return.
defualtValue	default value to return if environment variable does not exists.

Returns

environment variable value as int32 or default value if it does not exist.

getPropertyAsString()

std::string epics::pvAccess::Configuration::getPropertyAsString	(	const std::string &	name,
		const std::string &	defaultValue ) const

Get the environment variable specified by name or return default value if it does not exist.

Parameters

name	name of the environment variable to return.
defualtValue	default value to return if environment variable does not exists.

Returns

environment variable value as std::string or default value if it does not exist.

keys()

keys_t epics::pvAccess::Configuration::keys ( ) const

inline

Return a (partial) list of available key names.

Does not include key names from the ConfigurationEnviron

Definition at line 121 of file configuration.h.

Friends And Related Symbol Documentation

ConfigurationStack

friend class ConfigurationStack

friend

Definition at line 129 of file configuration.h.

---

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

• utils/pv/configuration.h