OS  2.9.3
Public Member Functions | Public Attributes | List of all members
MatrixBlock Class Reference

a data structure to represent a MatrixBlock object (derived from MatrixType) More...

#include <OSMatrix.h>

+ Inheritance diagram for MatrixBlock:
+ Collaboration diagram for MatrixBlock:

Public Member Functions

 MatrixBlock ()
 
 ~MatrixBlock ()
 
virtual ENUM_MATRIX_CONSTRUCTOR_TYPE getNodeType ()
 
virtual std::string getNodeName ()
 
virtual std::string getMatrixNodeInXML ()
 
virtual MatrixBlockcloneMatrixNode ()
 The implementation of the virtual functions. More...
 
bool IsEqual (MatrixBlock *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 (MatrixBlock *that)
 A function to make a deep copy of an instance of this class. More...
 
- Public Member Functions inherited from MatrixType
 MatrixType ()
 
 ~MatrixType ()
 
bool IsEqual (MatrixType *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 (MatrixType *that)
 A function to make a deep copy of an instance of this class. More...
 
- Public Member Functions inherited from MatrixNode
 MatrixNode ()
 default constructor More...
 
virtual ~MatrixNode ()
 destructor More...
 
std::vector< MatrixNode * > getPrefixFromNodeTree ()
 
std::vector< MatrixNode * > preOrderMatrixNodeTraversal (std::vector< MatrixNode * > *prefixVector)
 
std::vector< MatrixNode * > getPostfixFromNodeTree ()
 
std::vector< MatrixNode * > postOrderMatrixNodeTraversal (std::vector< MatrixNode * > *postfixVector)
 
virtual bool IsEqual (MatrixNode *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 (MatrixNode *that)
 A function to make a deep copy of an instance of this class. More...
 

Public Attributes

int blockRowIdx
 
int blockColIdx
 
- Public Attributes inherited from MatrixType
int numberOfRows
 
int numberOfColumns
 
ENUM_MATRIX_SYMMETRY symmetry
 
- Public Attributes inherited from MatrixNode
ENUM_MATRIX_TYPE matrixType
 matrixType tracks the type of elements contained in this MatrixNode, which may be useful in solver selection More...
 
ENUM_MATRIX_CONSTRUCTOR_TYPE nType
 nType is a unique integer assigned to each type of matrix node More...
 
unsigned int inumberOfChildren
 inumberOfChildren is the number of MatrixNode child elements For the matrix types (OSMatrix and MatrixBlock) this number is not fixed and is temporarily set to 0 More...
 
MatrixNode ** m_mChildren
 m_mChildren holds all the children, that is, nodes used in the definition or construction of the current node. More...
 

Detailed Description

a data structure to represent a MatrixBlock object (derived from MatrixType)

Definition at line 1239 of file OSMatrix.h.

Constructor & Destructor Documentation

MatrixBlock::MatrixBlock ( )
MatrixBlock::~MatrixBlock ( )

Member Function Documentation

virtual ENUM_MATRIX_CONSTRUCTOR_TYPE MatrixBlock::getNodeType ( )
virtual
Returns
the value of nType

Reimplemented from MatrixNode.

virtual std::string MatrixBlock::getNodeName ( )
virtual
Returns
the name of the operator

Implements MatrixNode.

virtual std::string MatrixBlock::getMatrixNodeInXML ( )
virtual

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.

Implements MatrixNode.

MatrixBlock * MatrixBlock::cloneMatrixNode ( )
virtual

The implementation of the virtual functions.

Returns
a pointer to a new MatrixNode of the proper type.

Implements MatrixNode.

bool MatrixBlock::IsEqual ( MatrixBlock that)

A function to check for the equality of two objects.

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

int MatrixBlock::blockRowIdx

Definition at line 1242 of file OSMatrix.h.

int MatrixBlock::blockColIdx

Definition at line 1243 of file OSMatrix.h.


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