1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
|
.TH ACE_Env_Value 3 "1 Dec 2001" "ACE" \" -*- nroff -*-
.ad l
.nh
.SH NAME
ACE_Env_Value \- Enviroment Variable Value.
.SH SYNOPSIS
.br
.PP
\fC#include <Env_Value_T.h>\fR
.PP
.SS Public Methods
.in +1c
.ti -1c
.RI "\fBACE_Env_Value\fR (void)"
.br
.ti -1c
.RI "\fBACE_Env_Value\fR (const \fBACE_TCHAR\fR *varname, const T &vardefault)"
.br
.RI "\fIConstructor that calls <open>.\fR"
.ti -1c
.RI "\fB~ACE_Env_Value\fR (void)"
.br
.RI "\fIDestroy the value.\fR"
.ti -1c
.RI "\fBoperator T\fR (void)"
.br
.RI "\fIReturns the value as type T.\fR"
.ti -1c
.RI "void \fBopen\fR (const \fBACE_TCHAR\fR *varname, const T &defval)"
.br
.RI "\fIThe constructor, read <varname> from the enviroment, using <vardefault> as its value if it is not defined.\fR"
.ti -1c
.RI "const \fBACE_TCHAR\fR* \fBvarname\fR (void) const"
.br
.RI "\fIReturns the name of the variable being tracked.\fR"
.in -1c
.SS Private Methods
.in +1c
.ti -1c
.RI "\fBACE_Env_Value\fR (const ACE_Env_Value<T> &)"
.br
.RI "\fIDisallow copying and assignment.\fR"
.ti -1c
.RI "ACE_Env_Value<T> \fBoperator=\fR (const ACE_Env_Value<T> &)"
.br
.ti -1c
.RI "void \fBfetch_value\fR (void)"
.br
.in -1c
.SS Private Attributes
.in +1c
.ti -1c
.RI "const \fBACE_TCHAR\fR* \fBvarname_\fR"
.br
.ti -1c
.RI "T \fBvalue_\fR"
.br
.in -1c
.SH DETAILED DESCRIPTION
.PP
.SS template<class T> template class ACE_Env_Value
Enviroment Variable Value.
.PP
.PP
Reads a variable from the user enviroment, providing a default value. = AUTHOR Chris Cleeland, Carlos O'Ryan
.PP
.SH CONSTRUCTOR & DESTRUCTOR DOCUMENTATION
.PP
.SS template<classT> ACE_Env_Value<T>::ACE_Env_Value<T> (void)
.PP
Default constructor which isn't bound to a specific environment variable name or a default value. Before being useful it must <open>'d.
.SS template<classT> ACE_Env_Value<T>::ACE_Env_Value<T> (const \fBACE_TCHAR\fR * varname, const T & vardefault)
.PP
Constructor that calls <open>.
.PP
.SS template<classT> ACE_Env_Value<T>::~ACE_Env_Value<T> (void)
.PP
Destroy the value.
.PP
.SS template<classT> ACE_Env_Value<T>::ACE_Env_Value<T> (const ACE_Env_Value< T >&)\fC [private]\fR
.PP
Disallow copying and assignment.
.PP
.SH MEMBER FUNCTION DOCUMENTATION
.PP
.SS template<classT> void ACE_Env_Value<T>::fetch_value (void)\fC [private]\fR
.PP
.SS template<classT> void ACE_Env_Value<T>::open (const \fBACE_TCHAR\fR * varname, const T & defval)
.PP
The constructor, read <varname> from the enviroment, using <vardefault> as its value if it is not defined.
.PP
.SS template<classT> ACE_Env_Value<T>::operator T (void)
.PP
Returns the value as type T.
.PP
.SS template<classT> ACE_Env_Value<T> ACE_Env_Value<T>::operator= (const ACE_Env_Value< T >&)\fC [private]\fR
.PP
.SS template<classT> const \fBACE_TCHAR\fR * ACE_Env_Value<T>::varname (void) const
.PP
Returns the name of the variable being tracked.
.PP
.SH MEMBER DATA DOCUMENTATION
.PP
.SS template<classT> T ACE_Env_Value<T>::value_\fC [private]\fR
.PP
.SS template<classT> const \fBACE_TCHAR\fR * ACE_Env_Value<T>::varname_\fC [private]\fR
.PP
.SH AUTHOR
.PP
Generated automatically by Doxygen for ACE from the source code.
|