Public Member Functions | Public Attributes | List of all members
ConstantMatrixValues Class Reference

to represent the nonzeros in a constantMatrix element More...

#include <OSMatrix.h>

Inheritance diagram for ConstantMatrixValues:
Inheritance graph
[legend]
Collaboration diagram for ConstantMatrixValues:
Collaboration graph
[legend]

Public Member Functions

 ConstantMatrixValues ()
 -------— Methods for class ConstantMatrixValues -------— More...
 
 ~ConstantMatrixValues ()
 
bool IsEqual (ConstantMatrixValues *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 (ConstantMatrixValues *that)
 A function to make a deep copy of an instance of this class. More...
 
- Public Member Functions inherited from MatrixElementValues
 MatrixElementValues ()
 -------— Methods for class MatrixElementValues -------— More...
 
virtual ~MatrixElementValues ()
 
virtual bool deepCopyFrom (MatrixElementValues *that)
 A function to check for the equality of two objects. More...
 

Public Attributes

double * el
 
- Public Attributes inherited from MatrixElementValues
int numberOfEl
 each type of value is stored as an array named "el". More...
 

Detailed Description

to represent the nonzeros in a constantMatrix element

Definition at line 501 of file OSMatrix.h.

Constructor & Destructor Documentation

ConstantMatrixValues::ConstantMatrixValues ( )

-------— Methods for class ConstantMatrixValues -------—

Definition at line 4286 of file OSMatrix.cpp.

ConstantMatrixValues::~ConstantMatrixValues ( )

Definition at line 4294 of file OSMatrix.cpp.

Member Function Documentation

bool ConstantMatrixValues::IsEqual ( ConstantMatrixValues that)

A function to check for the equality of two objects.

Returns
the value of nType
the type of the matrix elements
the name of the matrix constructor

The following method writes a matrix node in OSgL format. it is used by OSgLWriter to write a <matrix> element.

Returns
the MatrixNode and its children as an OSgL string.

Definition at line 4310 of file OSMatrix.cpp.

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

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)
iMin,:lowest index value (inclusive) that a variable reference in this matrix can take
iMax,:greatest index value (inclusive) that a variable reference in this matrix can take

Definition at line 4349 of file OSMatrix.cpp.

bool ConstantMatrixValues::deepCopyFrom ( ConstantMatrixValues 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 4354 of file OSMatrix.cpp.

Member Data Documentation

double* ConstantMatrixValues::el

Definition at line 504 of file OSMatrix.h.


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