InitConstraintValues Class Reference

the InitConstraintValues class. More...

#include <OSOption.h>

Collaboration diagram for InitConstraintValues:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 InitConstraintValues ()
 Default constructor.
 ~InitConstraintValues ()
 Class destructor.
bool IsEqual (InitConstraintValues *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, InitConValue **con)
 A function to set an array of <con> elements.
bool setCon (int numberOfCon, int *idx, double *value, std::string *name)
 Alternative signature for this function.
bool addCon (int idx, double value)
 A function to add a <con> element.

Public Attributes

int numberOfCon
 number of <con> children
InitConValue ** con
 initial value for each constraint

Detailed Description

the InitConstraintValues 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 2465 of file OSOption.h.


Constructor & Destructor Documentation

InitConstraintValues::InitConstraintValues (  ) 

Default constructor.

Definition at line 998 of file OSOption.cpp.

InitConstraintValues::~InitConstraintValues (  ) 

Class destructor.

Definition at line 1007 of file OSOption.cpp.


Member Function Documentation

bool InitConstraintValues::IsEqual ( InitConstraintValues that  ) 

A function to check for the equality of two objects.

Definition at line 10669 of file OSOption.cpp.

bool InitConstraintValues::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 11965 of file OSOption.cpp.

bool InitConstraintValues::setCon ( int  numberOfCon,
InitConValue **  con 
)

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

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

Definition at line 6201 of file OSOption.cpp.

bool InitConstraintValues::setCon ( int  numberOfCon,
int *  idx,
double *  value,
std::string *  name 
)

Alternative signature for this function.

Parameters:
numberOfCon,: number of <con> elements to be set
idx,: the array of indices
value,: the array of corresponding values
name,: the array of constraint names

Definition at line 6232 of file OSOption.cpp.

bool InitConstraintValues::addCon ( int  idx,
double  value 
)

A function to add a <con> element.

Parameters:
idx,: the index of the constraint to be given an initial value
value,: the initial value to be added
idx,: the index of the constraint to be given an inital value
value,: the initial value to be added

Definition at line 6265 of file OSOption.cpp.


Member Data Documentation

number of <con> children

Definition at line 2470 of file OSOption.h.

initial value for each constraint

Definition at line 2473 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