Class: TConfigurationCommand

Declaration: DisplayConfiguration.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TConfigurationCommandProtocol

Inherited By:

None.

Purpose:

This template class is used to create and define command classes. These command classes are derivative classes of BaseConfigCommand. They include the specific data type used for storing the configuration parameter, along with a pointer to a member function of a class derived from the base configuration class. This member function performs the actual configuration change. Instances of this class are created on the heap and passed to the base configuration class AddCommand member function.

Instantiation:

Allocate on the heap.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TConfigurationCommand::TConfigurationCommand

TConfigurationCommand (ConfigChangePtr aCmd, const T & aParm)
TConfigurationCommand (ConfigChangePtr aCmd)

Interface Category:

API.

Purpose:

Constructs a command with a parameter.
Constructs a command.

Calling Context:

Called to create a command that needs a parameter (Type T).
Called to create a command that doesn't need a parameter.

Parameters:

ConfigChangePtr aCmd -Pointer to a member function that does the change.
const T & aParm -Configuration change parameter of type T.
ConfigChangePtr aCmd -Pointer to a member function that does the change.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TConfigurationCommand::~TConfigurationCommand

virtual ~ TConfigurationCommand ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TConfigurationCommand::SetData

void SetData (const T & aCmd)

Interface Category:

API.

Purpose:

Used to set the data needed for a command.

Calling Context:

Called from a configuration change member function to save the data needed for the change.

Parameters:

const T & aCmd -The data.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TConfigurationCommand::GetData

T GetData ()

Interface Category:

API.

Purpose:

Get the saved command data.

Calling Context:

Called when the configuration change is being executed.

Parameters:

Takes no parameters.

Return Value:

T -The command data.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.