DeviceControlCommand Class Reference

A specific command to send to the driver. More...

#include <cvb/driver/device_control.hpp>

Public Member Functions
template<class PARAM>
	DeviceControlCommand (PARAM parameter, DeviceControlOperation operation) noexcept
	Creates a command from the given operation and command parameter.
template<class PARAM = std::uint32_t>
PARAM	Parameter () const noexcept
	Gets the parameter part of the command.
template<class PARAM = std::uint32_t>
void	SetParameter (PARAM parameter) noexcept
	Sets the parameter part of the command.
DeviceControlOperation	Operation () const noexcept
	Gets the operation part of the command.
void	SetOperation (DeviceControlOperation operation) noexcept
	Sets the operation part of the command.

Detailed Description

A specific command to send to the driver.

Constructor & Destructor Documentation

DeviceControlCommand()

template<class PARAM>

DeviceControlCommand ( PARAM parameter, DeviceControlOperation operation )

inlinenoexcept

Creates a command from the given operation and command parameter.

Parameters

[in]	parameter	Driver specific command parameter.
[in]	operation	Operation to perform on parameter.

Exceptions

Does	not throw any exception.

Member Function Documentation

Operation()

DeviceControlOperation Operation ( ) const

inlinenoexcept

Gets the operation part of the command.

Returns

The current operation.

Exceptions

Does	not throw any exception.

Parameter()

template<class PARAM = std::uint32_t>

PARAM Parameter ( ) const

inlinenoexcept

Gets the parameter part of the command.

Returns

The current parameter. Basically driver specific raw byte data.

Exceptions

Does	not throw any exception.

SetOperation()

void SetOperation ( DeviceControlOperation operation )

inlinenoexcept

Sets the operation part of the command.

Parameters

[in]

operation

The new operation.

Exceptions

Does	not throw any exception.

SetParameter()

template<class PARAM = std::uint32_t>

void SetParameter ( PARAM parameter )

inlinenoexcept

Sets the parameter part of the command.

Parameters

[in]

parameter

The new parameter. Basically driver specific raw byte data.

Exceptions

Does	not throw any exception.