My Project
Matrices Class Reference

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

#include <OSInstance.h>

Public Member Functions

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

Public Attributes

int numberOfMatrices
 numberOfMatrices is the number of <nl> elements in the <matrices> element.
 
OSMatrix ** matrix
 matrix is a pointer to an array of OSMatrix object pointers
 

Detailed Description

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

Definition at line 482 of file OSInstance.h.

Constructor & Destructor Documentation

◆ Matrices()

Matrices::Matrices ( )

The Matrices class constructor.

Definition at line 893 of file OSInstance.cpp.

◆ ~Matrices()

Matrices::~Matrices ( )

The Matrices class destructor.

Definition at line 902 of file OSInstance.cpp.

Member Function Documentation

◆ IsEqual()

bool Matrices::IsEqual ( Matrices * that)

A function to check for the equality of two objects.

Definition at line 8646 of file OSInstance.cpp.

◆ setRandom()

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

◆ numberOfMatrices

int Matrices::numberOfMatrices

numberOfMatrices is the number of <nl> elements in the <matrices> element.

Definition at line 496 of file OSInstance.h.

◆ matrix

OSMatrix** Matrices::matrix

matrix is a pointer to an array of OSMatrix object pointers

Definition at line 499 of file OSInstance.h.


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