MasterPointControl Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class Control.

Description:

This class is available in release 3.0 and later only.

This is the base class for Master Controllers. Methods are available to get and set the sub-controllers, get/set the number of sub-controllers, and add sub-controllers.

#include <control.h>

Inheritance diagram for MasterPointControl:

List of all members.

Public Member Functions
virtual void	SetNumSubControllers (int num, BOOL keep=FALSE)
virtual int	GetNumSubControllers ()
virtual void	DeleteControlSet (BitArray set)
virtual int	AddSubController (Control *ctrl)
virtual Control *	GetSubController (int i)
virtual void	SetSubController (int i, Control *ctrl)

---

Member Function Documentation

virtual void SetNumSubControllers	(	int	num,
		BOOL	keep = FALSE
	)		[inline, virtual]

Search for all occurrences

Remarks:

Set the number of sub-controllers.

Parameters:

int num

The number of sub-controllers.

BOOL keep=FALSE

If the number if sub-controllers is reallocated this indicates if the previously allocated ones are kept. TRUE to keep; FALSE to discard them.

Default Implementation:

{}

{}

virtual int GetNumSubControllers

(

)

[inline, virtual]

Search for all occurrences

Remarks:

Return the number of sub-controllers.

Default Implementation:

{ return NULL; }

{ return 0; }

virtual void DeleteControlSet

(

BitArray

set

)

[inline, virtual]

Search for all occurrences

Remarks:

Delete all the sub-controllers that are set to TRUE in the BitArray.

Parameters:

BitArray set

This BitArray has bits set for the sub-controllers to be deleted. It should be GetNumSubControllers() in size.

Default Implementation:

{}

{}

virtual int AddSubController

(

Control *

ctrl

)

[inline, virtual]

Search for all occurrences

Remarks:

Adds the specified sub-controller.

Parameters:

Control* ctrl

Points to the controller to add.

Returns:

Nonzero if implemented; otherwise zero.

Default Implementation:

{ return 0; }

{ return 0; }

virtual Control* GetSubController

(

int

i

)

[inline, virtual]

Search for all occurrences

Remarks:

Return a pointer to the i-th sub-controller.

Parameters:

int i

The zero based index of the

Default Implementation:

{ return NULL; }

{ return NULL; }

virtual void SetSubController	(	int	i,
		Control *	ctrl
	)		[inline, virtual]

Search for all occurrences

Remarks:

Set the I-th sub-controller.

Parameters:

int i

The zero based index of the sub-controller to set.

Control* ctrl

Points to the control to set.

Default Implementation:

{}

{}