OS  2.10.2
Public Member Functions | Public Attributes | List of all members
MatrixProgramming Class Reference

The in-memory representation of the <matrixProgramming> element. More...

#include <OSInstance.h>

+ Collaboration diagram for MatrixProgramming:

Public Member Functions

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

Public Attributes

MatrixVariablesmatrixVariables
 a pointer to the matrixVariables object More...
 
MatrixObjectivesmatrixObjectives
 a pointer to the matrixObjectives object More...
 
MatrixConstraintsmatrixConstraints
 a pointer to the matrixConstraints object More...
 
MatrixExpressionsmatrixExpressions
 a pointer to the matrixExpressions object More...
 

Detailed Description

The in-memory representation of the <matrixProgramming> element.

Definition at line 1882 of file OSInstance.h.

Constructor & Destructor Documentation

◆ MatrixProgramming()

MatrixProgramming::MatrixProgramming ( )

The MatrixProgramming class constructor.

◆ ~MatrixProgramming()

MatrixProgramming::~MatrixProgramming ( )

The MatrixProgramming class destructor.

Member Function Documentation

◆ IsEqual()

bool MatrixProgramming::IsEqual ( MatrixProgramming that)

A function to check for the equality of two objects.

◆ setRandom()

bool MatrixProgramming::setRandom ( double  density,
bool  conformant,
int  iMin,
int  iMax 
)

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)
iMinlowest index value (inclusive) that a variable reference in this matrix can take
iMaxgreatest index value (inclusive) that a variable reference in this matrix can take

◆ deepCopyFrom()

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

◆ matrixVariables

MatrixVariables* MatrixProgramming::matrixVariables

a pointer to the matrixVariables object

Definition at line 1892 of file OSInstance.h.

◆ matrixObjectives

MatrixObjectives* MatrixProgramming::matrixObjectives

a pointer to the matrixObjectives object

Definition at line 1895 of file OSInstance.h.

◆ matrixConstraints

MatrixConstraints* MatrixProgramming::matrixConstraints

a pointer to the matrixConstraints object

Definition at line 1898 of file OSInstance.h.

◆ matrixExpressions

MatrixExpressions* MatrixProgramming::matrixExpressions

a pointer to the matrixExpressions object

Definition at line 1901 of file OSInstance.h.


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