Command data structure. The member contents depend on the command type as described in each command type of the Enums::CommandId enum documentation. More...

#include "WASimCommander.h"

Public Member Functions
	Command (WASimCommander::Enums::CommandId id=WASimCommander::Enums::CommandId::None, uint32_t uData=0, const char *str=nullptr, double fData=0.0, int32_t token=0)
	Default constructor with all parameters optional.

void	setStringData (const char *str)
	Set the `sData` member using a const char array.

Public Attributes
uint32_t	token
	A unique ID for this command instance. Echoed back by server in command responses. Optional use for client implementations.

uint32_t	uData
	DWORD command parameter value, meaning depends on the command being issued.

double	fData
	double-precision floating point command parameter value, meaning depends on the command being issued.

WASimCommander::Enums::CommandId	commandId
	What to do.

char	sData [STRSZ_CMD] = {0}
	String command parameter value, meaning depends on the command being issued.

Detailed Description

Command data structure. The member contents depend on the command type as described in each command type of the Enums::CommandId enum documentation.

See also: Enums::CommandId enum

Definition at line 98 of file WASimCommander.h.

Constructor & Destructor Documentation

◆ Command()

WASimCommander::Command::Command	(	WASimCommander::Enums::CommandId	id = WASimCommander::Enums::CommandId::None,
		uint32_t	uData = 0,
		const char *	str = nullptr,
		double	fData = 0.0,
		int32_t	token = 0 )

inlineexplicit

Default constructor with all parameters optional.

Definition at line 108 of file WASimCommander.h.

Member Function Documentation

◆ setStringData()

void WASimCommander::Command::setStringData ( const char * str )

inline

Set the sData member using a const char array.

Definition at line 114 of file WASimCommander.h.

Member Data Documentation

◆ token

uint32_t WASimCommander::Command::token

A unique ID for this command instance. Echoed back by server in command responses. Optional use for client implementations.

Definition at line 100 of file WASimCommander.h.

◆ uData

uint32_t WASimCommander::Command::uData

DWORD command parameter value, meaning depends on the command being issued.

Definition at line 101 of file WASimCommander.h.

◆ fData

double WASimCommander::Command::fData

double-precision floating point command parameter value, meaning depends on the command being issued.

Definition at line 102 of file WASimCommander.h.

◆ commandId

WASimCommander::Enums::CommandId WASimCommander::Command::commandId

What to do.

See also: CommandId

Definition at line 103 of file WASimCommander.h.

◆ sData

char WASimCommander::Command::sData[STRSZ_CMD] = {0}

String command parameter value, meaning depends on the command being issued.

Definition at line 104 of file WASimCommander.h.

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

src/include/WASimCommander.h

Public Member Functions

Public Attributes