CommandClassInterface Class Reference

#include <commandbase.h>

Inheritance diagram for CommandClassInterface:

Detailed Description

Generic command interface.

Public Member Functions
MAXON_METHOD Result< COMMANDSTATE >	GetState (CommandDataRef &data) const
MAXON_METHOD Result< COMMANDRESULT >	Execute (CommandDataRef &data) const

Private Member Functions
	MAXON_INTERFACE (CommandClassInterface, MAXON_REFERENCE_CONST, "net.maxon.command.interface.command", MAXON_IMPLEMENTATION_MODULE("net.maxon.command"))

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( CommandClassInterface  , MAXON_REFERENCE_CONST  , "net.maxon.command.interface.command"  , MAXON_IMPLEMENTATION_MODULE("net.maxon.command")    )

private

GetState()

MAXON_METHOD Result<COMMANDSTATE> GetState

(

CommandDataRef &

data

)

const

Gets the command state, i.e. if it can be executed or not depending on a given data.

Parameters

[in,out]

data

The command data.

Returns

The command state or an error.

Execute()

MAXON_METHOD Result<COMMANDRESULT> Execute

(

CommandDataRef &

data

)

const

Executes the command.

Parameters

[in,out]

data

The command data.

Returns

The command result or an error.