#include "configuration.h"

Inheritance diagram for epics::pvAccess::Configuration:

Public Types
typedef std::set< std::string >	keys_t

Public Member Functions
	POINTER_DEFINITIONS (Configuration)

	Configuration ()

virtual	~Configuration ()=0

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

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

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

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

std::string	getPropertyAsString (const std::string &name, const std::string &defaultValue) const

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

bool	hasProperty (const std::string &name) const

keys_t	keys () const

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

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

Definition at line 117 of file configuration.h.

Constructor & Destructor Documentation

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

inline

Definition at line 51 of file configuration.h.

51 {}

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

pure virtual

Definition at line 29 of file configuration.cpp.

29 {}

Member Function Documentation

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

inlineprotectedvirtual

Definition at line 131 of file configuration.h.

131 {}

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. addr pointer to the address struct to be filled in

Returns: true if addr now contains an address, false otherwise

Definition at line 84 of file configuration.cpp.

 {
     unsigned short dftport=0;
     if(addr->sa.sa_family==AF_INET)
         dftport = ntohs(addr->ia.sin_port);
 
     std::string val(getPropertyAsString(name, ""));
 
     if(val.empty()) return false;
 
     memset(addr, 0, sizeof(*addr));
     addr->ia.sin_family = AF_INET;
     if(aToIPAddr(val.c_str(), dftport, &addr->ia))
         return false;
     return true;
 }

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.

Definition at line 31 of file configuration.cpp.

 {
     string value = getPropertyAsString(name, defaultValue ? "1" : "0");
     std::transform(value.begin(), value.end(), value.begin(), ::tolower);
 
     bool isTrue = (value == "1") || (value == "true") || (value == "yes");
     if (isTrue)
         return true;
 
     bool isFalse = (value == "0") || (value == "false") || (value == "no");
     if (isFalse)
         return false;
 
     // invalid value
     return defaultValue;
 }

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.

Definition at line 66 of file configuration.cpp.

 {
     try {
         return castUnsafe<double>(getPropertyAsString(name, ""));
     } catch(std::runtime_error&) {
         return defaultValue;
     }
 }

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.

Definition at line 57 of file configuration.cpp.

 {
     try {
         return castUnsafe<float>(getPropertyAsString(name, ""));
     } catch(std::runtime_error&) {
         return defaultValue;
     }
 }

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.

Definition at line 48 of file configuration.cpp.

 {
     try {
         return castUnsafe<epics::pvData::int32>(getPropertyAsString(name, ""));
     } catch(std::runtime_error&) {
         return defaultValue;
     }
 }

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.

Definition at line 75 of file configuration.cpp.

 {
     std::string val;
     if(tryGetPropertyAsString(name, &val))
         return val;
     else
         return defaultValue;
 }

bool epics::pvAccess::Configuration::hasProperty ( const std::string & name ) const

Definition at line 101 of file configuration.cpp.

 {
     return tryGetPropertyAsString(name, NULL);
 }

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.

     {
         keys_t ret;
         addKeys(ret);
         return ret;
     }

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

virtual bool epics::pvAccess::Configuration::tryGetPropertyAsString	(	const std::string &	name,
		std::string *	val
	)		const

protectedpure virtual

Friends And Related Function Documentation

friend class ConfigurationStack

friend

Definition at line 129 of file configuration.h.

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

modules/pvAccess/src/utils/pv/configuration.h
modules/pvAccess/src/utils/configuration.cpp

Public Types

Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation