My Project
InitialBasisStatus Class Reference

the InitialBasisStatus class. More...

#include <OSOption.h>

Public Member Functions

 InitialBasisStatus ()
 Default constructor.
 
 ~InitialBasisStatus ()
 Class destructor.
 
bool IsEqual (InitialBasisStatus *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 (InitialBasisStatus *that)
 A function to make a deep copy of an instance of this class.
 
bool setVar (int numberOfVar, InitBasStatus **var)
 A function to set an array of elements.
 
bool addVar (int idx, std::string value)
 A function to add a element.
 

Public Attributes

int numberOfVar
 number of children
 
InitBasStatus ** var
 initial value for each variable
 

Detailed Description

the InitialBasisStatus class.

Author
Robert Fourer, Horand 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. As of OS version 2.3 this class has been superseded by the class BasisStatus (see OSGeneral.h)

Definition at line 1540 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitialBasisStatus()

InitialBasisStatus::InitialBasisStatus ( )

Default constructor.

Definition at line 544 of file OSOption.cpp.

◆ ~InitialBasisStatus()

InitialBasisStatus::~InitialBasisStatus ( )

Class destructor.

Definition at line 553 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitialBasisStatus::IsEqual ( InitialBasisStatus * that)

A function to check for the equality of two objects.

Definition at line 10894 of file OSOption.cpp.

◆ setRandom()

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

◆ setVar()

bool InitialBasisStatus::setVar ( int numberOfVar,
InitBasStatus ** var )

A function to set an array of elements.

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

Definition at line 5430 of file OSOption.cpp.

◆ addVar()

bool InitialBasisStatus::addVar ( int idx,
std::string value )

A function to add a element.

Parameters
idxthe index of the variable to be given an initial basis status
valuethe initial basis status to be added

Definition at line 5467 of file OSOption.cpp.

Member Data Documentation

◆ numberOfVar

int InitialBasisStatus::numberOfVar

number of children

Definition at line 1545 of file OSOption.h.

◆ var

InitBasStatus** InitialBasisStatus::var

initial value for each variable

Definition at line 1548 of file OSOption.h.


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