OtherVariableOption Class Reference

the OtherVariableOption class. More...

#include <OSOption.h>

Collaboration diagram for OtherVariableOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OtherVariableOption ()
 Default constructor.
 ~OtherVariableOption ()
 Class destructor.
bool IsEqual (OtherVariableOption *that)
 A function to check for the equality of two objects.
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class.
bool deepCopyFrom (OtherVariableOption *that)
 A function to make a deep copy of an instance of this class.
bool setVar (int numberOfVar, OtherVarOption **var)
 A function to set an array of elements.
bool addVar (int idx, std::string value, std::string lbValue, std::string ubValue)
 A function to add a element.

Public Attributes

int numberOfVar
 number of child elements
int numberOfEnumerations
 number of <enumeration> child elements
std::string name
 name of the option
std::string value
 value of the option
std::string solver
 name of the solver to which this option applies
std::string category
 name of the category into which this option falls
std::string type
 type of the option value (integer, double, boolean, string)
std::string description
 description of the option
OtherVarOption ** var
 array of option values
std::string varType
 type of the values in the var array
OtherOptionEnumeration ** enumeration
std::string enumType
 type of the values in the enumeration array

Detailed Description

the OtherVariableOption class.

Remarks:
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 1990 of file OSOption.h.


Constructor & Destructor Documentation

OtherVariableOption::OtherVariableOption (  ) 

Default constructor.

Definition at line 692 of file OSOption.cpp.

OtherVariableOption::~OtherVariableOption (  ) 

Class destructor.

Definition at line 712 of file OSOption.cpp.


Member Function Documentation

bool OtherVariableOption::IsEqual ( OtherVariableOption that  ) 

A function to check for the equality of two objects.

Definition at line 11203 of file OSOption.cpp.

bool OtherVariableOption::setRandom ( double  density,
bool  conformant 
)

A function to make a random instance of this class.

Parameters:
density,: corresponds to the probability that a particular child element is created
conformant,: if true enforces side constraints not enforceable in the schema (e.g., agreement of "numberOfXXX" attributes and <XXX> children)

Definition at line 12812 of file OSOption.cpp.

bool OtherVariableOption::deepCopyFrom ( OtherVariableOption that  ) 

A function to make a deep copy of an instance of this class.

Parameters:
that,: the instance from which information is to be copied
Returns:
whether the copy was created successfully

Definition at line 13924 of file OSOption.cpp.

bool OtherVariableOption::setVar ( int  numberOfVar,
OtherVarOption **  var 
)

A function to set an array of elements.

Parameters:
numberOfVar,: number of elements to be set
var,: the array of elements that are to be set

Definition at line 5910 of file OSOption.cpp.

bool OtherVariableOption::addVar ( int  idx,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

A function to add a element.

Parameters:
idx,: the index of the variable
value,: the value associated with this variable
lbValue,: a lower bound associated with this variable
ubValue,: an upper bound associated with this variable

Definition at line 5948 of file OSOption.cpp.


Member Data Documentation

number of child elements

Definition at line 1995 of file OSOption.h.

number of <enumeration> child elements

Definition at line 1998 of file OSOption.h.

name of the option

Definition at line 2001 of file OSOption.h.

value of the option

Definition at line 2004 of file OSOption.h.

name of the solver to which this option applies

Definition at line 2007 of file OSOption.h.

name of the category into which this option falls

Definition at line 2010 of file OSOption.h.

type of the option value (integer, double, boolean, string)

Definition at line 2013 of file OSOption.h.

description of the option

Definition at line 2016 of file OSOption.h.

array of option values

Definition at line 2019 of file OSOption.h.

type of the values in the var array

Definition at line 2022 of file OSOption.h.

Definition at line 2028 of file OSOption.h.

type of the values in the enumeration array

Definition at line 2031 of file OSOption.h.


The documentation for this class was generated from the following files:

Generated on 24 Jul 2013 by  doxygen 1.6.1