BranchingWeight Class Reference

the BranchingWeight class. More...

#include <OSOption.h>

Collaboration diagram for BranchingWeight:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 BranchingWeight ()
 Default constructor.
 ~BranchingWeight ()
 Class destructor.
bool IsEqual (BranchingWeight *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 (BranchingWeight *that)
 A function to make a deep copy of an instance of this class.

Public Attributes

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

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 1612 of file OSOption.h.


Constructor & Destructor Documentation

BranchingWeight::BranchingWeight (  ) 

Default constructor.

Definition at line 571 of file OSOption.cpp.

BranchingWeight::~BranchingWeight (  ) 

Class destructor.

Definition at line 581 of file OSOption.cpp.


Member Function Documentation

bool BranchingWeight::IsEqual ( BranchingWeight that  ) 

A function to check for the equality of two objects.

Definition at line 11156 of file OSOption.cpp.

bool BranchingWeight::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 12798 of file OSOption.cpp.

bool BranchingWeight::deepCopyFrom ( BranchingWeight 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 13913 of file OSOption.cpp.


Member Data Documentation

index of the variable

Definition at line 1617 of file OSOption.h.

std::string BranchingWeight::name

optional variable name

Definition at line 1620 of file OSOption.h.

branching weight

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