My Project
OtherVariableOption Class Reference

the OtherVariableOption class. More...

#include <OSOption.h>

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
 
OtherOptionOrResultEnumeration ** 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 1989 of file OSOption.h.

Constructor & Destructor Documentation

◆ OtherVariableOption()

OtherVariableOption::OtherVariableOption ( )

Default constructor.

Definition at line 692 of file OSOption.cpp.

◆ ~OtherVariableOption()

OtherVariableOption::~OtherVariableOption ( )

Class destructor.

Definition at line 712 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool OtherVariableOption::IsEqual ( OtherVariableOption * that)

A function to check for the equality of two objects.

Definition at line 11206 of file OSOption.cpp.

◆ setRandom()

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

A function to make a random instance of this class.

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

Definition at line 12816 of file OSOption.cpp.

◆ deepCopyFrom()

bool OtherVariableOption::deepCopyFrom ( OtherVariableOption * that)

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

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

Definition at line 13928 of file OSOption.cpp.

◆ setVar()

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

A function to set an array of elements.

Parameters
numberOfVarnumber of elements to be set
varthe array of elements that are to be set

Definition at line 5910 of file OSOption.cpp.

◆ addVar()

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

A function to add a element.

Parameters
idxthe index of the variable
valuethe value associated with this variable
lbValuea lower bound associated with this variable
ubValuean upper bound associated with this variable

Definition at line 5948 of file OSOption.cpp.

Member Data Documentation

◆ numberOfVar

int OtherVariableOption::numberOfVar

number of child elements

Definition at line 1994 of file OSOption.h.

◆ numberOfEnumerations

int OtherVariableOption::numberOfEnumerations

number of <enumeration> child elements

Definition at line 1997 of file OSOption.h.

◆ name

std::string OtherVariableOption::name

name of the option

Definition at line 2000 of file OSOption.h.

◆ value

std::string OtherVariableOption::value

value of the option

Definition at line 2003 of file OSOption.h.

◆ solver

std::string OtherVariableOption::solver

name of the solver to which this option applies

Definition at line 2006 of file OSOption.h.

◆ category

std::string OtherVariableOption::category

name of the category into which this option falls

Definition at line 2009 of file OSOption.h.

◆ type

std::string OtherVariableOption::type

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

Definition at line 2012 of file OSOption.h.

◆ description

std::string OtherVariableOption::description

description of the option

Definition at line 2015 of file OSOption.h.

◆ var

OtherVarOption** OtherVariableOption::var

array of option values

Definition at line 2018 of file OSOption.h.

◆ varType

std::string OtherVariableOption::varType

type of the values in the var array

Definition at line 2021 of file OSOption.h.

◆ enumeration

OtherOptionOrResultEnumeration** OtherVariableOption::enumeration

Definition at line 2027 of file OSOption.h.

◆ enumType

std::string OtherVariableOption::enumType

type of the values in the enumeration array

Definition at line 2030 of file OSOption.h.


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