ml::CSOGroupRules Class Reference

This handles rules like the maximum number of CSOs in a CSOGroup and applies them. More...

#include <CSOGroupRules.h>

Public Member Functions
	CSOGroupRules (unsigned int numMaxCSOs=0)
	Constructor.
	~CSOGroupRules ()
	Destructor.
void	reset ()
	Sets default values to all members.
void	setNumMaximumCSOs (unsigned int numMaxCSOs)
	Sets the maximum number of CSOs allowed in the CSOGroup where the rules are applied to.
unsigned int	getNumMaximumCSOs () const
	Returns the maximum number of CSOs.
void	setOverflowHandling (CSOGroupOverflowHandling handling)
	Sets the overflow handling, i.e., what has to be done when one wants to add CSO and _numMaxCSOs is reached?
CSOGroupOverflowHandling	getOverflowHandling () const
	Returns the _overflowHandling mode.
void	setRemoveFromGroupHandling (CSORemoveHandling handling)
	Sets the handling mode for CSOs that are removed from the CSOGroup, i.e., should they also be removed from the list?
CSORemoveHandling	getRemoveFromGroupHandling () const
	Returns the _removeFromGroupHandling mode.
void	setDeleteGroupCSOHandling (CSORemoveHandling handling)
	Sets the handling mode for CSOs when this CSOGroup is deleted, i.e., should they also be removed from the list?
CSORemoveHandling	getDeleteGroupCSOHandling () const
	Returns the _deleteGroupCSOHandling mode.
bool	mayAddCSO (CSOGroup &csoGroup) const
	Checks whether one could add a CSO to the specified CSOGroup.
void	applyTo (CSOGroup &csoGroup)
	Applies the rules to the csoGroup.
CSO *	addNewCSO (CSOGroup &csoGroup, bool useUndoRedo=true)
	Adds a new CSO to the csoGroup according to the rules.
bool	addCSO (CSO &cso, CSOGroup &csoGroup, bool useUndoRedo=true)
	Adds the specified cso to the specified csoGroup if the rules allow that.
void	removeCSO (CSO &cso, CSOGroup &csoGroup, bool useUndoRedo=true)
	Removes a CSO from the csoGroup according to the rules.
void	applyDeletionRule (CSOGroup &csoGroup)
	Applies the delete-group rules to the csoGroup.
void	applyRemoveFromGroupRule (CSO &cso, bool useUndoRedo)
	Applies the remove-from-group rule to the cso (is is executed any time a CSO is removed from the CSOGroup).

Static Public Member Functions
static unsigned int	getDefaultNumMaximumCSOs ()
	Returns the default value for the maximum amount of CSOs in a CSOGroup.
static CSOGroupOverflowHandling	getDefaultOverflowHandling ()
	Returns the default overflow handling for a CSOGroup.
static CSORemoveHandling	getDefaultRemoveFromGroupHandling ()
	Returns the default handling for removal from CSOGroups.
static CSORemoveHandling	getDefaultDeleteGroupCSOHandling ()
	Returns the default handling for removal from CSOGroups.

Protected Member Functions
void	_removeAllCSO (CSOGroup &csoGroup, bool useUndoRedo=true)
	Removes all CSOs from the csoGroup according to the rules.
void	_combineCSOAndGroup (CSO &cso, CSOGroup &csoGroup)
	Establishes a bidirectional link between the specified CSO and the specified CSOGroup.
void	_breakCSOandGroup (CSO &cso, CSOGroup &csoGroup)
	Removes the bidirectional link between the specified CSO and the specified CSOGroup.

Detailed Description

This handles rules like the maximum number of CSOs in a CSOGroup and applies them.

Definition at line 57 of file CSOGroupRules.h.

Constructor & Destructor Documentation

CSOGroupRules()

ml::CSOGroupRules::CSOGroupRules

(

unsigned int

numMaxCSOs = 0

)

Constructor.

~CSOGroupRules()

ml::CSOGroupRules::~CSOGroupRules

(

)

Destructor.

Member Function Documentation

_breakCSOandGroup()

void ml::CSOGroupRules::_breakCSOandGroup ( CSO &  cso, CSOGroup &  csoGroup  )

protected

Removes the bidirectional link between the specified CSO and the specified CSOGroup.

_combineCSOAndGroup()

void ml::CSOGroupRules::_combineCSOAndGroup ( CSO &  cso, CSOGroup &  csoGroup  )

protected

Establishes a bidirectional link between the specified CSO and the specified CSOGroup.

_removeAllCSO()

void ml::CSOGroupRules::_removeAllCSO ( CSOGroup &  csoGroup, bool  useUndoRedo = true  )

protected

Removes all CSOs from the csoGroup according to the rules.

addCSO()

bool ml::CSOGroupRules::addCSO	(	CSO &	cso,
		CSOGroup &	csoGroup,
		bool	useUndoRedo = true
	)

Adds the specified cso to the specified csoGroup if the rules allow that.

Returns whether the operation was successful.

addNewCSO()

CSO * ml::CSOGroupRules::addNewCSO	(	CSOGroup &	csoGroup,
		bool	useUndoRedo = true
	)

Adds a new CSO to the csoGroup according to the rules.

applyDeletionRule()

void ml::CSOGroupRules::applyDeletionRule

(

CSOGroup &

csoGroup

)

Applies the delete-group rules to the csoGroup.

applyRemoveFromGroupRule()

void ml::CSOGroupRules::applyRemoveFromGroupRule	(	CSO &	cso,
		bool	useUndoRedo
	)

Applies the remove-from-group rule to the cso (is is executed any time a CSO is removed from the CSOGroup).

applyTo()

void ml::CSOGroupRules::applyTo

(

CSOGroup &

csoGroup

)

Applies the rules to the csoGroup.

getDefaultDeleteGroupCSOHandling()

static CSORemoveHandling ml::CSOGroupRules::getDefaultDeleteGroupCSOHandling ( )

inlinestatic

Returns the default handling for removal from CSOGroups.

Definition at line 110 of file CSOGroupRules.h.

References ml::REMOVE_IF_IN_NO_GROUP.

getDefaultNumMaximumCSOs()

static unsigned int ml::CSOGroupRules::getDefaultNumMaximumCSOs ( )

inlinestatic

Returns the default value for the maximum amount of CSOs in a CSOGroup.

Definition at line 104 of file CSOGroupRules.h.

getDefaultOverflowHandling()

static CSOGroupOverflowHandling ml::CSOGroupRules::getDefaultOverflowHandling ( )

inlinestatic

Returns the default overflow handling for a CSOGroup.

Definition at line 106 of file CSOGroupRules.h.

References ml::OVERFLOW_DELETE_FIRST.

getDefaultRemoveFromGroupHandling()

static CSORemoveHandling ml::CSOGroupRules::getDefaultRemoveFromGroupHandling ( )

inlinestatic

Returns the default handling for removal from CSOGroups.

Definition at line 108 of file CSOGroupRules.h.

References ml::REMOVE_NEVER.

getDeleteGroupCSOHandling()

CSORemoveHandling ml::CSOGroupRules::getDeleteGroupCSOHandling ( ) const

inline

Returns the _deleteGroupCSOHandling mode.

Definition at line 85 of file CSOGroupRules.h.

getNumMaximumCSOs()

unsigned int ml::CSOGroupRules::getNumMaximumCSOs ( ) const

inline

Returns the maximum number of CSOs.

Definition at line 73 of file CSOGroupRules.h.

getOverflowHandling()

CSOGroupOverflowHandling ml::CSOGroupRules::getOverflowHandling ( ) const

inline

Returns the _overflowHandling mode.

Definition at line 77 of file CSOGroupRules.h.

getRemoveFromGroupHandling()

CSORemoveHandling ml::CSOGroupRules::getRemoveFromGroupHandling ( ) const

inline

Returns the _removeFromGroupHandling mode.

Definition at line 81 of file CSOGroupRules.h.

mayAddCSO()

bool ml::CSOGroupRules::mayAddCSO

(

CSOGroup &

csoGroup

)

const

Checks whether one could add a CSO to the specified CSOGroup.

removeCSO()

void ml::CSOGroupRules::removeCSO	(	CSO &	cso,
		CSOGroup &	csoGroup,
		bool	useUndoRedo = true
	)

Removes a CSO from the csoGroup according to the rules.

reset()

void ml::CSOGroupRules::reset

(

)

Sets default values to all members.

setDeleteGroupCSOHandling()

void ml::CSOGroupRules::setDeleteGroupCSOHandling ( CSORemoveHandling  handling )

inline

Sets the handling mode for CSOs when this CSOGroup is deleted, i.e., should they also be removed from the list?

Definition at line 83 of file CSOGroupRules.h.

setNumMaximumCSOs()

void ml::CSOGroupRules::setNumMaximumCSOs ( unsigned int  numMaxCSOs )

inline

Sets the maximum number of CSOs allowed in the CSOGroup where the rules are applied to.

Definition at line 71 of file CSOGroupRules.h.

setOverflowHandling()

void ml::CSOGroupRules::setOverflowHandling ( CSOGroupOverflowHandling  handling )

inline

Sets the overflow handling, i.e., what has to be done when one wants to add CSO and _numMaxCSOs is reached?

Definition at line 75 of file CSOGroupRules.h.

setRemoveFromGroupHandling()

void ml::CSOGroupRules::setRemoveFromGroupHandling ( CSORemoveHandling  handling )

inline

Sets the handling mode for CSOs that are removed from the CSOGroup, i.e., should they also be removed from the list?

Definition at line 79 of file CSOGroupRules.h.

---

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

• MeVisLab/Standard/Sources/ML/MLCSO/CSOBase/CSORules/CSOGroupRules.h