TRunnerCommand Struct Reference

Defines a command to be run and its response. More...

#include <runner.hpp>

Public Member Functions
bool	responseIsOk () const
	Returns if response is OK. More...
float	responseAsFloat () const
	Returns response value as a float point. More...
int	responseAsByte () const
	Returns response value as a byte. More...
int	responseAsWord () const
	Returns response value as a word. More...
int	responseAsDWord () const
	Returns response value as a double word. More...
bool	responseAsBool () const
	Returns response value as a boolean. More...
void	set (kCmdOpCodeEnum code)
	Sets the command. More...
void	setFloat (kCmdOpCodeEnum code, float param)
	Sets the command and the parameters. More...
void	setByte (kCmdOpCodeEnum code, uint8_t param)
	Sets the command and the parameters. More...
void	setWord (kCmdOpCodeEnum code, uint16_t param)
	Sets the command and the parameters. More...
void	setDWord (kCmdOpCodeEnum code, uint32_t param)
	Sets the command and the parameters. More...
void	setBool (kCmdOpCodeEnum code, bool param)
	Sets the command and the parameters. More...
TRunnerCommand &	operator= (const TRunnerCommand &src)
	Assign Operator. More...

Public Attributes
TCmdOpCode	opcode
	Opcode of the command. More...
QByteArray	params
	Parameters of the command (raw bytes). More...
QByteArray	response
	Response of the command (raw bytes). More...

Friends
bool	operator== (const TRunnerCommand &a, const TRunnerCommand &b)
	Equality Operator. More...

Detailed Description

Defines a command to be run and its response.

Member Function Documentation

responseIsOk()

bool responseIsOk

(

)

const

Returns if response is OK.

Returns

True if response is OK, else if response is NOK.

responseAsFloat()

float responseAsFloat

(

)

const

Returns response value as a float point.

Returns

Response value.

responseAsByte()

int responseAsByte

(

)

const

Returns response value as a byte.

Returns

Response value.

responseAsWord()

int responseAsWord

(

)

const

Returns response value as a word.

Returns

Response value.

responseAsDWord()

int responseAsDWord

(

)

const

Returns response value as a double word.

Returns

Response value.

responseAsBool()

bool responseAsBool

(

)

const

Returns response value as a boolean.

Returns

Response value.

set()

void set

(

kCmdOpCodeEnum

code

)

Sets the command.

Parameters

code	OpCode of the command.

setFloat()

void setFloat	(	kCmdOpCodeEnum	code,
		float	param
	)

Sets the command and the parameters.

Parameters

code	OpCode of the command.
param	Value of the param.

setByte()

void setByte	(	kCmdOpCodeEnum	code,
		uint8_t	param
	)

Sets the command and the parameters.

Parameters

code	OpCode of the command.
param	Value of the param.

setWord()

void setWord	(	kCmdOpCodeEnum	code,
		uint16_t	param
	)

Sets the command and the parameters.

Parameters

code	OpCode of the command.
param	Value of the param.

setDWord()

void setDWord	(	kCmdOpCodeEnum	code,
		uint32_t	param
	)

Sets the command and the parameters.

Parameters

code	OpCode of the command.
param	Value of the param.

setBool()

void setBool	(	kCmdOpCodeEnum	code,
		bool	param
	)

Sets the command and the parameters.

Parameters

code	OpCode of the command.
param	Value of the param.

operator=()

TRunnerCommand & operator=

(

const TRunnerCommand &

src

)

Assign Operator.

Parameters

src	TRunnerCommand source object.

Returns

Reference for this.

Friends And Related Function Documentation

operator==

bool operator== ( const TRunnerCommand &  a, const TRunnerCommand &  b  )

friend

Equality Operator.

Parameters

a	One object.
b	Another object.

Returns

True if the objects contain equal values, false otherwise.

Member Data Documentation

opcode

TCmdOpCode opcode

Opcode of the command.

params

QByteArray params

Parameters of the command (raw bytes).

response

QByteArray response

Response of the command (raw bytes).

---

The documentation for this struct was generated from the following files:

• runner.hpp
• runner.cpp