ACE  6.3.3
Public Member Functions | Private Member Functions | Private Attributes | List of all members
ACE_Env_Value< T > Class Template Reference

Environment Variable Value. More...

#include <Env_Value_T.h>

Inheritance diagram for ACE_Env_Value< T >:
Inheritance graph
[legend]
Collaboration diagram for ACE_Env_Value< T >:
Collaboration graph
[legend]

Public Member Functions

 ACE_Env_Value (void)
 
 ACE_Env_Value (const ACE_TCHAR *varname, const T &vardefault)
 Constructor that calls open(). More...
 
 ~ACE_Env_Value (void)
 Destroy the value. More...
 
 operator T (void)
 Returns the value as type T. More...
 
void open (const ACE_TCHAR *varname, const T &defval)
 
const ACE_TCHARvarname (void) const
 Returns the name of the variable being tracked. More...
 

Private Member Functions

void fetch_value (void)
 
- Private Member Functions inherited from ACE_Copy_Disabled
 ACE_Copy_Disabled (void)
 Default constructor. More...
 

Private Attributes

const ACE_TCHARvarname_
 
value_
 

Detailed Description

template<class T>
class ACE_Env_Value< T >

Environment Variable Value.

Reads a variable from the user environment, providing a default value.

Constructor & Destructor Documentation

template<class T >
ACE_Env_Value< T >::ACE_Env_Value ( void  )
inline

Default constructor which isn't bound to a specific environment variable name or a default value. Before being useful it must open()'d.

template<class T >
ACE_Env_Value< T >::ACE_Env_Value ( const ACE_TCHAR varname,
const T &  vardefault 
)
inline

Constructor that calls open().

template<class T >
ACE_Env_Value< T >::~ACE_Env_Value ( void  )
inline

Destroy the value.

Member Function Documentation

template<class T >
void ACE_Env_Value< T >::fetch_value ( void  )
inlineprivate
template<class T >
void ACE_Env_Value< T >::open ( const ACE_TCHAR varname,
const T &  defval 
)
inline

The constructor, read varname from the environment, using defval as its value if it is not defined.

template<class T >
ACE_Env_Value< T >::operator T ( void  )
inline

Returns the value as type T.

template<class T >
const ACE_TCHAR * ACE_Env_Value< T >::varname ( void  ) const
inline

Returns the name of the variable being tracked.

Member Data Documentation

template<class T >
T ACE_Env_Value< T >::value_
private
template<class T >
const ACE_TCHAR* ACE_Env_Value< T >::varname_
private

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