CSLConstrainableType Class Reference

#include <ConstrainableType.h>

Inheritance diagram for CSLConstrainableType:


Public Member Functions
virtual CSLConstraint *	AddConstraint (CSLConstraint::EConstraintType in_ConstraintType)=0
SI_Error	RemoveConstraint (SI_Int in_nIndex)
SI_Error	RemoveConstraint (CSLConstraint *in_pToRemove)
SI_Int	GetConstraintCount ()
CSLConstraint **	GetConstraintList ()
SI_Error	ClearConstraints ()
CSLConstraint *	ConnectConstraint (CSLConstraint *in_pNewConstraint)

Detailed Description

Base classe for all templates supporting constraints

virtual CSLConstraint* AddConstraint ( CSLConstraint::EConstraintType in_ConstraintType ) [pure virtual]

Add a constraint to the constraint list

SI_Error RemoveConstraint ( SI_Int in_nIndex )

Removes a constraint from the constraint list

Parameters:

in_nIndex

Index of the constraint to remove

SI_Error RemoveConstraint ( CSLConstraint * in_pToRemove )

Removes a constraint from the constraint list

Parameters:

in_pToRemove

Pointer of the constraint to remove

SI_Int GetConstraintCount ( )

Gets the total number of constraints in the constraints list

CSLConstraint** GetConstraintList ( )

Gets a pointer to the internally-stored constraint pointer list

SI_Error ClearConstraints ( )

Removes all constraints from the internally-stored list and deallocate them

CSLConstraint* ConnectConstraint ( CSLConstraint * in_pNewConstraint )

Adds a reference to an existing constraint

Parameters:

in_pNewCluster

Pointer to the new object to refer to

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