pvAccessCPP  7.1.7
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | Protected Member Functions | List of all members
epics::pvAccess::ConfigurationEnviron Class Reference

Lookup configuration strings from the process environment. More...

#include <utils/pv/configuration.h>

Inheritance diagram for epics::pvAccess::ConfigurationEnviron:
Inheritance graph
[legend]
Collaboration diagram for epics::pvAccess::ConfigurationEnviron:
Collaboration graph
[legend]

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::stringkeys_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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
bool getPropertyAsAddress (const std::string &name, osiSockAddr *addr) const
 Fetch and parse as a socket address and port number (address family set accordingly). More...
 
bool hasProperty (const std::string &name) const
 
keys_t keys () const
 Return a (partial) list of available key names. More...
 

Protected Member Functions

virtual void addKeys (keys_t &) const
 

Detailed Description

Lookup configuration strings from the process environment.

Definition at line 150 of file configuration.h.

Member Function Documentation

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

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
namename 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
bool epics::pvAccess::Configuration::getPropertyAsBoolean ( const std::string name,
const bool  defaultValue 
) const
inherited

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

Parameters
namename of the environment variable to return.
defualtValuedefault value to return if environment variable does not exists.
Returns
environment variable value as bool or default value if it does not exist.
double epics::pvAccess::Configuration::getPropertyAsDouble ( const std::string name,
const double  defaultValue 
) const
inherited

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

Parameters
namename of the environment variable to return.
defualtValuedefault value to return if environment variable does not exists.
Returns
environment variable value as double or default value if it does not exist.
float epics::pvAccess::Configuration::getPropertyAsFloat ( const std::string name,
const float  defaultValue 
) const
inherited

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

Parameters
namename of the environment variable to return.
defualtValuedefault value to return if environment variable does not exists.
Returns
environment variable value as float or default value if it does not exist.
epics::pvData::int32 epics::pvAccess::Configuration::getPropertyAsInteger ( const std::string name,
const epics::pvData::int32  defaultValue 
) const
inherited

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

Parameters
namename of the environment variable to return.
defualtValuedefault value to return if environment variable does not exists.
Returns
environment variable value as int32 or default value if it does not exist.
std::string epics::pvAccess::Configuration::getPropertyAsString ( const std::string name,
const std::string defaultValue 
) const
inherited

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

Parameters
namename of the environment variable to return.
defualtValuedefault 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_t epics::pvAccess::Configuration::keys ( ) const
inlineinherited

Return a (partial) list of available key names.

Does not include key names from the ConfigurationEnviron

Definition at line 121 of file configuration.h.


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