Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
visionary::CoLaCommand Class Reference

#include <CoLaCommand.h>

Public Member Functions

 CoLaCommand (std::vector< uint8_t > buffer)
 Construct a new CoLaCommand from the given data buffer. More...
 
const std::vector< uint8_t > & getBuffer ()
 Get the binary data buffer. More...
 
CoLaError::Enum getError ()
 Get error. More...
 
const char * getName ()
 Get the name of command. More...
 
size_t getParameterOffset ()
 Get offset in bytes to where first parameter starts. More...
 
CoLaCommandType::Enum getType ()
 Get the type of command. More...
 
 ~CoLaCommand ()
 

Static Public Member Functions

static CoLaCommand networkErrorCommand ()
 Create a command for network errors. More...
 

Private Member Functions

 CoLaCommand (CoLaCommandType::Enum commandType, CoLaError::Enum error, const char *name)
 Construct a new CoLaCommand with the given command type, error, and name, but without any data. More...
 

Private Attributes

std::vector< uint8_t > m_buffer
 
CoLaError::Enum m_error
 
std::string m_name
 
size_t m_parameterOffset
 
CoLaCommandType::Enum m_type
 

Detailed Description

Definition at line 32 of file CoLaCommand.h.

Constructor & Destructor Documentation

◆ CoLaCommand() [1/2]

visionary::CoLaCommand::CoLaCommand ( CoLaCommandType::Enum  commandType,
CoLaError::Enum  error,
const char *  name 
)
private

Construct a new CoLaCommand with the given command type, error, and name, but without any data.

Definition at line 29 of file CoLaCommand.cpp.

◆ CoLaCommand() [2/2]

visionary::CoLaCommand::CoLaCommand ( std::vector< uint8_t >  buffer)

Construct a new CoLaCommand from the given data buffer.

Definition at line 38 of file CoLaCommand.cpp.

◆ ~CoLaCommand()

visionary::CoLaCommand::~CoLaCommand ( )

Definition at line 91 of file CoLaCommand.cpp.

Member Function Documentation

◆ getBuffer()

const std::vector< uint8_t > & visionary::CoLaCommand::getBuffer ( )

Get the binary data buffer.

Definition at line 93 of file CoLaCommand.cpp.

◆ getError()

CoLaError::Enum visionary::CoLaCommand::getError ( )

Get error.

Definition at line 113 of file CoLaCommand.cpp.

◆ getName()

const char * visionary::CoLaCommand::getName ( )

Get the name of command.

Definition at line 103 of file CoLaCommand.cpp.

◆ getParameterOffset()

size_t visionary::CoLaCommand::getParameterOffset ( )

Get offset in bytes to where first parameter starts.

Definition at line 108 of file CoLaCommand.cpp.

◆ getType()

CoLaCommandType::Enum visionary::CoLaCommand::getType ( )

Get the type of command.

Definition at line 98 of file CoLaCommand.cpp.

◆ networkErrorCommand()

CoLaCommand visionary::CoLaCommand::networkErrorCommand ( )
static

Create a command for network errors.

Definition at line 118 of file CoLaCommand.cpp.

Member Data Documentation

◆ m_buffer

std::vector<uint8_t> visionary::CoLaCommand::m_buffer
private

Definition at line 35 of file CoLaCommand.h.

◆ m_error

CoLaError::Enum visionary::CoLaCommand::m_error
private

Definition at line 39 of file CoLaCommand.h.

◆ m_name

std::string visionary::CoLaCommand::m_name
private

Definition at line 37 of file CoLaCommand.h.

◆ m_parameterOffset

size_t visionary::CoLaCommand::m_parameterOffset
private

Definition at line 38 of file CoLaCommand.h.

◆ m_type

CoLaCommandType::Enum visionary::CoLaCommand::m_type
private

Definition at line 36 of file CoLaCommand.h.


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


sick_safevisionary_base
Author(s):
autogenerated on Sat Oct 21 2023 02:24:26