OS  2.10.1
Public Member Functions | Public Attributes | List of all members
BranchingWeight Class Reference

the BranchingWeight class. More...

#include <OSOption.h>

+ Collaboration diagram for BranchingWeight:

Public Member Functions

 BranchingWeight ()
 Default constructor. More...
 
 ~BranchingWeight ()
 Class destructor. More...
 
bool IsEqual (BranchingWeight *that)
 A function to check for the equality of two objects. More...
 
bool setRandom (double density, bool conformant)
 A function to make a random instance of this class. More...
 
bool deepCopyFrom (BranchingWeight *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

int idx
 index of the variable More...
 
std::string name
 optional variable name More...
 
double value
 branching weight More...
 

Detailed Description

the BranchingWeight class.

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

Definition at line 1611 of file OSOption.h.

Constructor & Destructor Documentation

§ BranchingWeight()

BranchingWeight::BranchingWeight ( )

Default constructor.

§ ~BranchingWeight()

BranchingWeight::~BranchingWeight ( )

Class destructor.

Member Function Documentation

§ IsEqual()

bool BranchingWeight::IsEqual ( BranchingWeight that)

A function to check for the equality of two objects.

§ setRandom()

bool BranchingWeight::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)

§ deepCopyFrom()

bool BranchingWeight::deepCopyFrom ( BranchingWeight 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

Member Data Documentation

§ idx

int BranchingWeight::idx

index of the variable

Definition at line 1616 of file OSOption.h.

§ name

std::string BranchingWeight::name

optional variable name

Definition at line 1619 of file OSOption.h.

§ value

double BranchingWeight::value

branching weight

Definition at line 1622 of file OSOption.h.


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