Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | File Members

CStringConfigParam Class Reference

#include <CStringConfigParam.h>

Inheritance diagram for CStringConfigParam:

Inheritance graph
[legend]
Collaboration diagram for CStringConfigParam:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CStringConfigParam (const string &keyword)
virtual ~CStringConfigParam ()
 CStringConfigParam (const CStringConfigParam &aCStringConfigParam)
CStringConfigParam & operator= (const CStringConfigParam &rhs)
int operator== (const CStringConfigParam &rhs) const
int operator!= (const CStringConfigParam &rhs) const
string getOptionValue ()
virtual int SetValue (CTCLInterpreter &rInterp, CTCLResult &rResult, const char *value)
virtual string GetParameterFormat ()
 CStringConfigParam (const string &keyword)
virtual ~CStringConfigParam ()
 CStringConfigParam (const CStringConfigParam &aCStringConfigParam)
CStringConfigParam & operator= (const CStringConfigParam &rhs)
int operator== (const CStringConfigParam &rhs) const
int operator!= (const CStringConfigParam &rhs) const
string getOptionValue ()
virtual int SetValue (CTCLInterpreter &rInterp, CTCLResult &rResult, const char *value)
virtual string GetParameterFormat ()

Detailed Description

Represents a string valued configuration parameter.

Definition at line 40 of file CStringConfigParam.h.

Constructor & Destructor Documentation

CStringConfigParam::CStringConfigParam (  const string &  rKey  ) 
 

Construct a string valued configuration parameter.

Parameters:
key (const string& [in]) The keyword that identifies this parameter.

Definition at line 12 of file CStringConfigParam.cpp.

CStringConfigParam::~CStringConfigParam (   )  [virtual]
 

Destructor: In this case it's a no-op.

Definition at line 20 of file CStringConfigParam.cpp.

CStringConfigParam::CStringConfigParam (  const CStringConfigParam &  rhs  ) 
 

Copy constructor. All we need to do is invoke the base class copy constructor.

Definition at line 26 of file CStringConfigParam.cpp.

CStringConfigParam::CStringConfigParam (  const string &  keyword  ) 
 

virtual CStringConfigParam::~CStringConfigParam (   )  [virtual]
 

CStringConfigParam::CStringConfigParam (  const CStringConfigParam &  aCStringConfigParam  ) 
 

Member Function Documentation

string CStringConfigParam::getOptionValue (   ) 
 

string CStringConfigParam::getOptionValue (   ) 
 

Returns the current value of the string. For a string valued parameter, we just get the value stored by the base class.

Definition at line 61 of file CStringConfigParam.cpp.

References CConfigurationParameter::getValue().

virtual string CStringConfigParam::GetParameterFormat (   )  [virtual]
 

Implements CConfigurationParameter.

string CStringConfigParam::GetParameterFormat (   )  [virtual]
 

Returns the format of the configuration parameter. In this case it's the text "string"

Implements CConfigurationParameter.

Definition at line 85 of file CStringConfigParam.cpp.

int CStringConfigParam::operator!= (  const CStringConfigParam &  rhs  )  const [inline]
 

Definition at line 52 of file include/CStringConfigParam.h.

References operator==().

int CStringConfigParam::operator!= (  const CStringConfigParam &  rhs  )  const [inline]
 

Definition at line 52 of file CStringConfigParam.h.

References operator==().

CStringConfigParam& CStringConfigParam::operator= (  const CStringConfigParam &  rhs  ) 
 

CStringConfigParam & CStringConfigParam::operator= (  const CStringConfigParam &  rhs  ) 
 

Assignment. The base class assignment operator does all the work.

Definition at line 34 of file CStringConfigParam.cpp.

References CConfigurationParameter::operator=().

int CStringConfigParam::operator== (  const CStringConfigParam &  rhs  )  const
 

int CStringConfigParam::operator== (  const CStringConfigParam &  rhs  )  const
 

Equality comparison. Base class does all the work.

Definition at line 46 of file CStringConfigParam.cpp.

References CConfigurationParameter::operator==().

Referenced by operator!=().

virtual int CStringConfigParam::SetValue (  CTCLInterpreter &  rInterp,
CTCLResult &  rResult,
const char *  value
)  [virtual]
 

Implements CConfigurationParameter.

int CStringConfigParam::SetValue (  CTCLInterpreter &  rInterp,
CTCLResult &  rResult,
const char *  value
)  [virtual]
 

Sets the value of the actual parameter from the stringified param (no-op here since we use the base class's string value.

Implements CConfigurationParameter.

Definition at line 74 of file CStringConfigParam.cpp.

The documentation for this class was generated from the following files:
Generated on Fri Mar 12 13:04:37 2004 for Scripted Readout by doxygen 1.3.4