My Project
InitVarValue Class Reference

the InitVarValue class. More...

#include <OSOption.h>

Public Member Functions

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

Public Attributes

int idx
 variable index
 
std::string name
 optional variable name
 
double value
 initial value
 

Detailed Description

the InitVarValue 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.

Definition at line 1159 of file OSOption.h.

Constructor & Destructor Documentation

◆ InitVarValue()

InitVarValue::InitVarValue ( )

Default constructor.

Definition at line 436 of file OSOption.cpp.

◆ ~InitVarValue()

InitVarValue::~InitVarValue ( )

Class destructor.

Definition at line 446 of file OSOption.cpp.

Member Function Documentation

◆ IsEqual()

bool InitVarValue::IsEqual ( InitVarValue * that)

A function to check for the equality of two objects.

Definition at line 10751 of file OSOption.cpp.

◆ setRandom()

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

Definition at line 12679 of file OSOption.cpp.

◆ deepCopyFrom()

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

Definition at line 13804 of file OSOption.cpp.

Member Data Documentation

◆ idx

int InitVarValue::idx

variable index

Definition at line 1164 of file OSOption.h.

◆ name

std::string InitVarValue::name

optional variable name

Definition at line 1167 of file OSOption.h.

◆ value

double InitVarValue::value

initial value

Definition at line 1170 of file OSOption.h.


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