Parameters::ParamSetDef

NAME
SYNOPSIS
Detailed Description
Member Enumeration Documentation
Constructor & Destructor Documentation
Member Function Documentation
Member Data Documentation
Author

NAME

Parameters::ParamSetDef −

SYNOPSIS

#include <ParamSetDef.h>

Public Types

enum paramTypesEnum { BOOL, DOUBLE, DOUBLE_ARRAY, INT, INT_ARRAY, STRING, STRING_ARRAY }

Public Member Functions

ParamSetDef (const string &xmlParamSetDef)

virtual ~ParamSetDef ()

paramTypesEnum getParamTypeForName (string paramName)

BoolParamDef getBoolParamDef (string paramName)

IntParamDef getIntParamDef (string paramName)

DoubleParamDef getDoubleParamDef (string paramName)

StringParamDef getStringParamDef (string paramName)

IntArrayParamDef getIntArrayParamDef (string paramName)

DoubleArrayParamDef getDoubleArrayParamDef (string paramName)

StringArrayParamDef getStringArrayParamDef (string paramName)

auto_ptr< vector< BoolParamDef > > getBoolParamDefs ()

auto_ptr< vector< IntParamDef > > getIntParamDefs ()

auto_ptr< vector< StringParamDef > > getStringParamDefs ()

auto_ptr< vector< DoubleParamDef > > getDoubleParamDefs ()

auto_ptr< vector< IntArrayParamDef > > getIntArrayParamDefs ()

auto_ptr< vector< DoubleArrayParamDef > > getDoubleArrayParamDefs ()

auto_ptr< vector< StringArrayParamDef > > getStringArrayParamDefs ()

Private Member Functions

int parseFile (const string &xmlFile)

int parseDOM (const string &xmlFile)

int parseSAX (const string &xmlFile)

void processParamDefNodes (DOMNodeList *paramNodes)

void handleBoolParamDef (DOMElement *paramElem)

void handleIntParamDef (DOMElement *paramElem)

void handleIntArrayParamDef (DOMElement *paramElem)

void handleDoubleParamDef (DOMElement *paramElem)

void handleDoubleArrayParamDef (DOMElement *paramElem)

void handleStringParamDef (DOMElement *paramElem)

void handleStringArrayParamDef (DOMElement *paramElem)

void setSchemaLocation (DOMBuilder *parser)

Private Attributes

map< string, BoolParamDef > boolParamDefMap

map< string, IntParamDef > intParamDefMap

map< string, DoubleParamDef > doubleParamDefMap

map< string, StringParamDef > stringParamDefMap

map< string, IntArrayParamDef > intArrayParamDefMap

map< string, DoubleArrayParamDef > doubleArrayParamDefMap

map< string, StringArrayParamDef > stringArrayParamDefMap

XMLCh * PARAMETER_TAG_NAME

XMLCh * NAME_TAG_NAME

XMLCh * REQUIRED_TAG_NAME

XMLCh * PROMPT_TAG_NAME

XMLCh * HELP_TAG_NAME

XMLCh * DEFAULT_TAG_NAME

XMLCh * STRING_DEFAULT_TAG_NAME

XMLCh * LENGTH_TAG_NAME

XMLCh * VALID_VALUES_TAG_NAME

XMLCh * VALUE_TAG_NAME

XMLCh * MAX_TAG_NAME

XMLCh * MIN_TAG_NAME

XMLCh * UNITS_TAG_NAME

XMLCh * MAXLEN_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

Detailed Description

ParamSetDef class used to support OFFLINE tasks

Member Enumeration Documentation

enum Parameters::ParamSetDef::paramTypesEnum

Enumerator:

BOOL

DOUBLE

DOUBLE_ARRAY

INT

INT_ARRAY

STRING

STRING_ARRAY

Constructor & Destructor Documentation

Parameters::ParamSetDef::ParamSetDef (const string & xmlParamSetDef) Constructor

Parameters:

xmlParamSetDef the parameter set definition as an XML string

virtual Parameters::ParamSetDef::~ParamSetDef () [virtual] Destructor

Member Function Documentation

BoolParamDef Parameters::ParamSetDef::getBoolParamDef (string paramName) get a bool param by name.

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<BoolParamDef> > Parameters::ParamSetDef::getBoolParamDefs () gets all the bool param defs for this psetdef

DoubleArrayParamDef Parameters::ParamSetDef::getDoubleArrayParamDef (string paramName) get an array of double params by name

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<DoubleArrayParamDef> > Parameters::ParamSetDef::getDoubleArrayParamDefs () gets all the double array param defs for this psetdef

DoubleParamDef Parameters::ParamSetDef::getDoubleParamDef (string paramName) get a double param by name.

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<DoubleParamDef> > Parameters::ParamSetDef::getDoubleParamDefs () gets all the double param defs for this psetdef

IntArrayParamDef Parameters::ParamSetDef::getIntArrayParamDef (string paramName) get an array of int params by name

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<IntArrayParamDef> > Parameters::ParamSetDef::getIntArrayParamDefs () gets all the int array param defs for this psetdef

IntParamDef Parameters::ParamSetDef::getIntParamDef (string paramName) get an int param by name.

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<IntParamDef> > Parameters::ParamSetDef::getIntParamDefs () gets all the int param defs for this psetdef

paramTypesEnum Parameters::ParamSetDef::getParamTypeForName (string paramName) Gets the type of a parameter by name.

Parameters:

paramName the name of the parameter for which the type is desired.

Exceptions:

domain_error

Returns:

the type as a ParamSetDef::paramType enum.

StringArrayParamDef Parameters::ParamSetDef::getStringArrayParamDef (string paramName) get an array of string params by name

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<StringArrayParamDef> > Parameters::ParamSetDef::getStringArrayParamDefs () gets all the string array param defs for this psetdef

StringParamDef Parameters::ParamSetDef::getStringParamDef (string paramName) get a string param by name.

Parameters:

paramName the name of the parameter desired.

Exceptions:

domain_error

auto_ptr< vector<StringParamDef> > Parameters::ParamSetDef::getStringParamDefs () gets all the string param defs for this psetdef

void Parameters::ParamSetDef::handleBoolParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleDoubleArrayParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleDoubleParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleIntArrayParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleIntParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleStringArrayParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::handleStringParamDef (DOMElement * paramElem) [private] Exceptions:

domain_error

int Parameters::ParamSetDef::parseDOM (const string & xmlFile) [private]

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

int Parameters::ParamSetDef::parseSAX (const string & xmlFile) [private]

void Parameters::ParamSetDef::processParamDefNodes (DOMNodeList * paramNodes) [private] Exceptions:

domain_error

void Parameters::ParamSetDef::setSchemaLocation (DOMBuilder * parser) [private]

Member Data Documentation

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

map<string, BoolParamDef> Parameters::ParamSetDef::boolParamDefMap [private]

XMLCh* Parameters::ParamSetDef::DEFAULT_TAG_NAME [private]

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

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

map<string, DoubleArrayParamDef> Parameters::ParamSetDef::doubleArrayParamDefMap [private]

map<string, DoubleParamDef> Parameters::ParamSetDef::doubleParamDefMap [private]

XMLCh* Parameters::ParamSetDef::HELP_TAG_NAME [private]

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

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

map<string, IntArrayParamDef> Parameters::ParamSetDef::intArrayParamDefMap [private]

map<string, IntParamDef> Parameters::ParamSetDef::intParamDefMap [private]

XMLCh* Parameters::ParamSetDef::LENGTH_TAG_NAME [private]

XMLCh* Parameters::ParamSetDef::MAX_TAG_NAME [private]

XMLCh* Parameters::ParamSetDef::MAXLEN_TAG_NAME [private]

XMLCh* Parameters::ParamSetDef::MIN_TAG_NAME [private]

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

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

XMLCh* Parameters::ParamSetDef::PROMPT_TAG_NAME [private]

XMLCh* Parameters::ParamSetDef::REQUIRED_TAG_NAME [private]

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

XMLCh* Parameters::ParamSetDef::STRING_DEFAULT_TAG_NAME [private]

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

map<string, StringArrayParamDef> Parameters::ParamSetDef::stringArrayParamDefMap [private]

map<string, StringParamDef> Parameters::ParamSetDef::stringParamDefMap [private]

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

XMLCh* Parameters::ParamSetDef::VALID_VALUES_TAG_NAME [private]

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

Author

Generated automatically by Doxygen for ACS-2015.2 C++ API from the source code.