OtherConstraintOption Class Reference

the OtherConstraintOption class. More...

#include <OSOption.h>

Collaboration diagram for OtherConstraintOption:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 OtherConstraintOption ()
 Default constructor.
 ~OtherConstraintOption ()
 Class destructor.
bool IsEqual (OtherConstraintOption *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 setCon (int numberOfCon, OtherConOption **con)
 A function to set an array of <con> elements.
bool addCon (int idx, std::string value, std::string lbValue, std::string ubValue)
 A function to add a <con> element.

Public Attributes

int numberOfCon
 number of <con> children
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
OtherConOption ** con
 array of option values
OtherOptionEnumeration ** enumeration

Detailed Description

the OtherConstraintOption class.

Author:
Robert Fourer, Gus Gassmann, Jun Ma, Kipp Martin
Version:
1.0, 21/07/2008
Since:
OS 1.1
Remarks:
A data structure class that corresponds to an xml element in the OSoL schema.

Definition at line 2731 of file OSOption.h.


Constructor & Destructor Documentation

OtherConstraintOption::OtherConstraintOption (  ) 

Default constructor.

Definition at line 1093 of file OSOption.cpp.

OtherConstraintOption::~OtherConstraintOption (  ) 

Class destructor.

Definition at line 1110 of file OSOption.cpp.


Member Function Documentation

bool OtherConstraintOption::IsEqual ( OtherConstraintOption that  ) 

A function to check for the equality of two objects.

Definition at line 10842 of file OSOption.cpp.

bool OtherConstraintOption::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" atrbutes and <XXX> children)

Definition at line 12043 of file OSOption.cpp.

bool OtherConstraintOption::setCon ( int  numberOfCon,
OtherConOption **  con 
)

A function to set an array of <con> elements.

Parameters:
numberOfCon,: number of <con> elements to be set
obj,: the array of <con> elements that are to be set

Definition at line 6419 of file OSOption.cpp.

bool OtherConstraintOption::addCon ( int  idx,
std::string  value,
std::string  lbValue,
std::string  ubValue 
)

A function to add a <con> element.

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

Definition at line 6458 of file OSOption.cpp.


Member Data Documentation

number of <con> children

Definition at line 2736 of file OSOption.h.

number of <enumeration> child elements

Definition at line 2739 of file OSOption.h.

name of the option

Definition at line 2742 of file OSOption.h.

value of the option

Definition at line 2745 of file OSOption.h.

name of the solver to which this option applies

Definition at line 2748 of file OSOption.h.

name of the category into which this option falls

Definition at line 2751 of file OSOption.h.

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

Definition at line 2754 of file OSOption.h.

description of the option

Definition at line 2757 of file OSOption.h.

array of option values

Definition at line 2760 of file OSOption.h.

Definition at line 2766 of file OSOption.h.


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

Generated on 16 Feb 2012 by  doxygen 1.6.1