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

CStringArrayparam Class Reference

#include <CStringArrayparam.h>

Inheritance diagram for CStringArrayparam:

Inheritance graph
[legend]
Collaboration diagram for CStringArrayparam:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 CStringArrayparam (const string &rKey, int nSize)
virtual ~CStringArrayparam ()
 CStringArrayparam (const CStringArrayparam &rhs)
CStringArrayparam & operator= (const CStringArrayparam &rhs)
int operator== (const CStringArrayparam &rhs) const
int operator!= (const CStringArrayparam &rhs) const
const string * getStrings () const
string & operator[] (int n)
virtual int SetValue (CTCLInterpreter &rInterp, CTCLResult &rResult, const char *pValue)
virtual string GetParameterFormat ()
 CStringArrayparam (const string &rKey, int nSize)
virtual ~CStringArrayparam ()
 CStringArrayparam (const CStringArrayparam &rhs)
CStringArrayparam & operator= (const CStringArrayparam &rhs)
int operator== (const CStringArrayparam &rhs) const
int operator!= (const CStringArrayparam &rhs) const
const string * getStrings () const
string & operator[] (int n)
virtual int SetValue (CTCLInterpreter &rInterp, CTCLResult &rResult, const char *pValue)
virtual string GetParameterFormat ()

Protected Member Functions

void setStrings (string *aStrings)
void setStrings (string *aStrings)

Private Attributes

string * m_aStrings
int m_nSize
string * m_aStrings

Constructor & Destructor Documentation

CStringArrayparam::CStringArrayparam (  const string &  rKey,
int  nSize
) 
 

Construct a string array parameter.

Parameters:
rKey (const string& [in]): The name of the parameter.
nSize (int [in]): Size of the array.

Definition at line 15 of file CStringArrayparam.cpp.

References m_aStrings, and m_nSize.

CStringArrayparam::~CStringArrayparam (   )  [virtual]
 

Destroy a string array parameter. The array needs to be deleted.

Definition at line 26 of file CStringArrayparam.cpp.

References m_aStrings.

CStringArrayparam::CStringArrayparam (  const CStringArrayparam &  rhs  ) 
 

Copy construction. The big work is copying the string array.

Definition at line 34 of file CStringArrayparam.cpp.

References m_aStrings, and m_nSize.

CStringArrayparam::CStringArrayparam (  const string &  rKey,
int  nSize
) 
 

virtual CStringArrayparam::~CStringArrayparam (   )  [virtual]
 

CStringArrayparam::CStringArrayparam (  const CStringArrayparam &  rhs  ) 
 

Member Function Documentation

virtual string CStringArrayparam::GetParameterFormat (   )  [virtual]
 

Implements CConfigurationParameter.

string CStringArrayparam::GetParameterFormat (   )  [virtual]
 

Get the format string for the parameter which is : string[m_nSize]

Implements CConfigurationParameter.

Definition at line 154 of file CStringArrayparam.cpp.

References m_nSize.

const string* CStringArrayparam::getStrings (   )  const [inline]
 

Definition at line 37 of file include/CStringArrayparam.h.

References m_aStrings.

const string* CStringArrayparam::getStrings (   )  const [inline]
 

Definition at line 37 of file CStringArrayparam.h.

References m_aStrings.

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

Definition at line 29 of file include/CStringArrayparam.h.

References operator==().

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

Definition at line 29 of file CStringArrayparam.h.

References operator==().

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

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

Assignment operator. The main work is deleting any existing string array, allocating a new one and copying the rhs's string array in.

Definition at line 50 of file CStringArrayparam.cpp.

References m_aStrings, and m_nSize.

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

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

Equality comparison. Two parameters are equal if and only if:

  • The keywords are the same (base class compares).
  • The size of the two string arrays is equal.
  • The string arrays are element for element equal.

Definition at line 67 of file CStringArrayparam.cpp.

References m_aStrings, m_nSize, and CConfigurationParameter::operator==().

Referenced by operator!=().

string& CStringArrayparam::operator[] (  int  n  ) 
 

string & CStringArrayparam::operator[] (  int  n  ) 
 

Returns the contents of the string indexed by the parameter or throws a CRangeError exception if the index is invalid.

Definition at line 88 of file CStringArrayparam.cpp.

References m_aStrings, and m_nSize.

void CStringArrayparam::setStrings (  string *  aStrings  )  [inline, protected]
 

Definition at line 44 of file include/CStringArrayparam.h.

References m_aStrings.

void CStringArrayparam::setStrings (  string *  aStrings  )  [inline, protected]
 

Definition at line 44 of file CStringArrayparam.h.

References m_aStrings.

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

Implements CConfigurationParameter.

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

Purpose:

Sets the value as parsed from the command argument. The argument is assumed to be a list of strings to be put into the array elements

Parameters:
rInterp (CTCLInterpreter& [in]) The interpreter running the config command
rResult (CTCLResult& [out]) The result string that will be filled in.
pValue (char* [in]) A C-string that is a correctly formatted Tcl list.

Implements CConfigurationParameter.

Definition at line 112 of file CStringArrayparam.cpp.

References CConfigurationParameter::getSwitch(), m_aStrings, and m_nSize.

Member Data Documentation

string* CStringArrayparam::m_aStrings [private]
 

Definition at line 20 of file include/CStringArrayparam.h.

string* CStringArrayparam::m_aStrings [private]
 

Definition at line 20 of file CStringArrayparam.h.

Referenced by CStringArrayparam(), getStrings(), operator=(), operator==(), operator[](), setStrings(), SetValue(), and ~CStringArrayparam().

int CStringArrayparam::m_nSize [private]
 

Definition at line 21 of file include/CStringArrayparam.h.

Referenced by CStringArrayparam(), GetParameterFormat(), operator=(), operator==(), operator[](), and SetValue().

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