Main Page | Modules | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Parameters::ParameterSet Class Reference

#include <ParameterSet.h>

List of all members.

Public Member Functions

 ParameterSet (string xmlFileName)
 ParameterSet (InMemoryXmlData *fileInfo)
virtual ~ParameterSet ()
IntParam getIntParam (string paramName)
DoubleParam getDoubleParam (string paramName)
StringParam getStringParam (string paramName)
BoolParam getBoolParam (string paramName)
IntArrayParam getIntArrayParam (string paramName)
DoubleArrayParam getDoubleArrayParam (string paramName)
StringArrayParam getStringArrayParam (string paramName)
void setParam (string paramName, IntParam value)
void setParam (string paramName, DoubleParam value)
void setParam (string paramName, StringParam value)
void setParam (string paramName, BoolParam value)
void setParam (string paramName, IntArrayParam value)
void setParam (string paramName, DoubleArrayParam value)
void setParam (string paramName, StringArrayParam value)
ParamSetDefgetParamSetDef ()
string getName ()
string toString ()

Private Member Functions

void setName (string psetName)
string getParamSetDefFileName ()
void validate ()
void validateBoolParams ()
void validateBoolParam (BoolParamDef pDef)
void validateIntParams ()
void validateIntParam (IntParamDef pDef)
void validateDoubleParams ()
void validateDoubleParam (DoubleParamDef pDef)
void validateStringParams ()
void validateStringParam (StringParamDef pDef)
void validateIntArrayParams ()
void validateIntArrayParam (IntArrayParamDef pDef)
void validateStringArrayParams ()
void validateStringArrayParam (StringArrayParamDef pDef)
void validateDoubleArrayParams ()
void validateDoubleArrayParam (DoubleArrayParamDef pDef)
int parseDOM (const char *xmlParamSet, InMemoryXmlData *fileInfo)
int parseFile (const string &xmlFile)
int parseSAX (const string &xmlParamSet)
void handleBoolParam (DOMElement *paramElem)
void handleIntParam (DOMElement *paramElem)
void handleIntArrayParam (DOMElement *paramElem)
void handleDoubleParam (DOMElement *paramElem)
void handleDoubleArrayParam (DOMElement *paramElem)
void handleStringParam (DOMElement *paramElem)
void handleStringArrayParam (DOMElement *paramElem)
void processParamNodes (DOMNodeList *paramNodes)
void initialize ()
void setSchemaLocation (DOMBuilder *parser)

Private Attributes

string name
string psetDefFileName
map< string, IntParamintParamMap
map< string, IntArrayParamintArrayParamMap
map< string, DoubleParamdoubleParamMap
map< string, DoubleArrayParamdoubleArrayParamMap
map< string, StringParamstringParamMap
map< string, StringArrayParamstringArrayParamMap
map< string, BoolParamboolParamMap
XMLCh * PSETDEF_TAG_NAME
XMLCh * PARAMETER_TAG_NAME
XMLCh * NAME_TAG_NAME
XMLCh * VALUE_TAG_NAME
XMLCh * UNITS_TAG_NAME
XMLCh * INT_PARAM_TYPE
XMLCh * DOUBLE_PARAM_TYPE
XMLCh * STRING_PARAM_TYPE
XMLCh * BOOL_PARAM_TYPE
XMLCh * INT_ARRAY_PARAM_TYPE
XMLCh * DOUBLE_ARRAY_PARAM_TYPE
XMLCh * STRING_ARRAY_PARAM_TYPE
auto_ptr< ParamSetDefParameterSetDef


Detailed Description

ParameterSet class used to support OFFLINE tasks


Constructor & Destructor Documentation

Parameters::ParameterSet::ParameterSet string  xmlFileName  ) 
 

Constructor

Parameters:
xmlFileName the name of the file containing the XML document defining the parameter set Note: the file name must exist on the machine where the Task component is running. If this is not the case, the file name will be meaningless and you should, instead, use the other constructor, below, deals with the data solely in memory.

Parameters::ParameterSet::ParameterSet InMemoryXmlData fileInfo  ) 
 

Constructor

Parameters:
InMemoryXmlData contains the XML data (as a InMemoryXmlData object) for the parameter set for a task.

virtual Parameters::ParameterSet::~ParameterSet  )  [virtual]
 

Destructor


Member Function Documentation

BoolParam Parameters::ParameterSet::getBoolParam string  paramName  ) 
 

get a bool param by name.

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

DoubleArrayParam Parameters::ParameterSet::getDoubleArrayParam string  paramName  ) 
 

get an array of double params by name

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

DoubleParam Parameters::ParameterSet::getDoubleParam string  paramName  ) 
 

get a double param by name.

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

IntArrayParam Parameters::ParameterSet::getIntArrayParam string  paramName  ) 
 

get an array of int params by name

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

IntParam Parameters::ParameterSet::getIntParam string  paramName  ) 
 

get an IntParam by name.

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

string Parameters::ParameterSet::getName  ) 
 

Returns the name of the parameter set as a string.

ParamSetDef* Parameters::ParameterSet::getParamSetDef  ) 
 

Returns the ParamSetDef, i.e. the parameter set definition for the ParameterSet. From the ParamSetDef, you can get things like the "help" and "prompt" text, etc.

string Parameters::ParameterSet::getParamSetDefFileName  )  [private]
 

Returns the file name for the psetdef associated with this ParameterSet, as defined by the <psetdef> tag in the ParameterSet XML instance document.

StringArrayParam Parameters::ParameterSet::getStringArrayParam string  paramName  ) 
 

get an array of string params by name

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

StringParam Parameters::ParameterSet::getStringParam string  paramName  ) 
 

get a string param by name.

Parameters:
paramName the name of the parameter desired.
Exceptions:
domain_error 

void Parameters::ParameterSet::handleBoolParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleDoubleArrayParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleDoubleParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleIntArrayParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleIntParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleStringArrayParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::handleStringParam DOMElement *  paramElem  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::initialize  )  [private]
 

Exceptions:
domain_error 

int Parameters::ParameterSet::parseDOM const char *  xmlParamSet,
InMemoryXmlData fileInfo
[private]
 

Exceptions:
domain_error 

int Parameters::ParameterSet::parseFile const string &  xmlFile  )  [private]
 

int Parameters::ParameterSet::parseSAX const string &  xmlParamSet  )  [private]
 

void Parameters::ParameterSet::processParamNodes DOMNodeList *  paramNodes  )  [private]
 

Exceptions:
domain_error 

void Parameters::ParameterSet::setName string  psetName  )  [private]
 

Sets the name for the parameter set.

void Parameters::ParameterSet::setParam string  paramName,
StringArrayParam  value
 

set a string array param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
DoubleArrayParam  value
 

set a double array param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
IntArrayParam  value
 

set an int array param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
BoolParam  value
 

set a bool param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
StringParam  value
 

set a string param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
DoubleParam  value
 

set a double param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setParam string  paramName,
IntParam  value
 

set an int param by name.

Parameters:
paramName the name of the parameter to be set.
value the value of the parameter.

void Parameters::ParameterSet::setSchemaLocation DOMBuilder *  parser  )  [private]
 

string Parameters::ParameterSet::toString  ) 
 

Converts the ParameterSet in-memory representation to an XML string.

void Parameters::ParameterSet::validate  )  [private]
 

Validates the parameter set

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateBoolParam BoolParamDef  pDef  )  [private]
 

Validates the bool parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateBoolParams  )  [private]
 

Validates the bool params

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateDoubleArrayParam DoubleArrayParamDef  pDef  )  [private]
 

Validates the double array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateDoubleArrayParams  )  [private]
 

Validates the double array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateDoubleParam DoubleParamDef  pDef  )  [private]
 

Validates the double parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateDoubleParams  )  [private]
 

Validates the double parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateIntArrayParam IntArrayParamDef  pDef  )  [private]
 

Validates the int array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateIntArrayParams  )  [private]
 

Validates the int array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateIntParam IntParamDef  pDef  )  [private]
 

Validates the int parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateIntParams  )  [private]
 

Validates the int parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateStringArrayParam StringArrayParamDef  pDef  )  [private]
 

Validates the string array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateStringArrayParams  )  [private]
 

Validates the string array parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateStringParam StringParamDef  pDef  )  [private]
 

Validates the string parameters

Exceptions:
invalid_argument 

void Parameters::ParameterSet::validateStringParams  )  [private]
 

Validates the string parameters

Exceptions:
invalid_argument 


Member Data Documentation

XMLCh* Parameters::ParameterSet::BOOL_PARAM_TYPE [private]
 

map<string, BoolParam> Parameters::ParameterSet::boolParamMap [private]
 

XMLCh* Parameters::ParameterSet::DOUBLE_ARRAY_PARAM_TYPE [private]
 

XMLCh* Parameters::ParameterSet::DOUBLE_PARAM_TYPE [private]
 

map<string, DoubleArrayParam> Parameters::ParameterSet::doubleArrayParamMap [private]
 

map<string, DoubleParam> Parameters::ParameterSet::doubleParamMap [private]
 

XMLCh* Parameters::ParameterSet::INT_ARRAY_PARAM_TYPE [private]
 

XMLCh* Parameters::ParameterSet::INT_PARAM_TYPE [private]
 

map<string, IntArrayParam> Parameters::ParameterSet::intArrayParamMap [private]
 

map<string, IntParam> Parameters::ParameterSet::intParamMap [private]
 

string Parameters::ParameterSet::name [private]
 

XMLCh* Parameters::ParameterSet::NAME_TAG_NAME [private]
 

XMLCh* Parameters::ParameterSet::PARAMETER_TAG_NAME [private]
 

auto_ptr<ParamSetDef> Parameters::ParameterSet::ParameterSetDef [private]
 

XMLCh* Parameters::ParameterSet::PSETDEF_TAG_NAME [private]
 

string Parameters::ParameterSet::psetDefFileName [private]
 

XMLCh* Parameters::ParameterSet::STRING_ARRAY_PARAM_TYPE [private]
 

XMLCh* Parameters::ParameterSet::STRING_PARAM_TYPE [private]
 

map<string, StringArrayParam> Parameters::ParameterSet::stringArrayParamMap [private]
 

map<string, StringParam> Parameters::ParameterSet::stringParamMap [private]
 

XMLCh* Parameters::ParameterSet::UNITS_TAG_NAME [private]
 

XMLCh* Parameters::ParameterSet::VALUE_TAG_NAME [private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 02:37:38 2009 for ACS C++ API by doxygen 1.3.8