OSMatrixWithMatrixVarIdx Class Reference

this class extends OSMatrix for use, e.g., in the matrixVar section of OSoL and OSrL More...

#include <OSMatrix.h>

Inheritance diagram for OSMatrixWithMatrixVarIdx:

[legend]

Collaboration diagram for OSMatrixWithMatrixVarIdx:

[legend]

List of all members.

Public Member Functions
	OSMatrixWithMatrixVarIdx ()
	---------- Methods for class OSMatrixWithMatrixVarIdx ----------
	~OSMatrixWithMatrixVarIdx ()
virtual std::string	getMatrixNodeInXML ()
virtual OSMatrixWithMatrixVarIdx *	cloneMatrixNode ()
	The implementation of the virtual functions.
bool	IsEqual (OSMatrixWithMatrixVarIdx *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 (OSMatrixWithMatrixVarIdx *that)
	A function to make a deep copy of an instance of this class.
Public Attributes
int	matrixVarIdx

---

Detailed Description

this class extends OSMatrix for use, e.g., in the matrixVar section of OSoL and OSrL

Definition at line 2336 of file OSMatrix.h.

---

Constructor & Destructor Documentation

OSMatrixWithMatrixVarIdx::OSMatrixWithMatrixVarIdx

(

)

---------- Methods for class OSMatrixWithMatrixVarIdx ----------

Definition at line 3757 of file OSMatrix.cpp.

OSMatrixWithMatrixVarIdx::~OSMatrixWithMatrixVarIdx

(

)

Definition at line 3766 of file OSMatrix.cpp.

---

Member Function Documentation

std::string OSMatrixWithMatrixVarIdx::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.

Reimplemented from OSMatrix.

Definition at line 3774 of file OSMatrix.cpp.

OSMatrix * OSMatrixWithMatrixVarIdx::cloneMatrixNode

(

)

[virtual]

The implementation of the virtual functions.

Returns:

a pointer to a new MatrixNode of the proper type.

Reimplemented from OSMatrix.

Definition at line 3800 of file OSMatrix.cpp.

bool OSMatrixWithMatrixVarIdx::IsEqual

(

OSMatrixWithMatrixVarIdx *

that

)

[virtual]

A function to check for the equality of two objects.

Reimplemented from OSMatrix.

bool OSMatrixWithMatrixVarIdx::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

Reimplemented from OSMatrix.

bool OSMatrixWithMatrixVarIdx::deepCopyFrom

(

OSMatrixWithMatrixVarIdx *

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

Reimplemented from OSMatrix.

---

Member Data Documentation

int OSMatrixWithMatrixVarIdx::matrixVarIdx

Definition at line 2339 of file OSMatrix.h.

---

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

• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSMatrix.h
• /home/coin/svn-release/OS-2.10.0/OS/src/OSCommonInterfaces/OSMatrix.cpp