urcl::primary_interface::VersionMessage Class Reference

The VersionMessage class handles the version messages sent via the primary UR interface. More...

#include <version_message.h>

Inheritance diagram for urcl::primary_interface::VersionMessage:

Public Member Functions
virtual bool	consumeWith (AbstractPrimaryConsumer &consumer)
	Consume this package with a specific consumer. More...
virtual bool	parseWith (comm::BinParser &bp)
	Sets the attributes of the package by parsing a serialized representation of the package. More...
virtual std::string	toString () const
	Produces a human readable representation of the package object. More...
	VersionMessage ()=delete
	VersionMessage (uint64_t timestamp, uint8_t source)
	Creates a new VersionMessage object to be filled from a package. More...
virtual	~VersionMessage ()=default
Public Member Functions inherited from urcl::primary_interface::RobotMessage
	RobotMessage (const uint64_t timestamp, const uint8_t source)
	Creates a new RobotMessage object to be filled from a package. More...
virtual	~RobotMessage ()=default
Public Member Functions inherited from urcl::primary_interface::PrimaryPackage
	PrimaryPackage ()
	Creates a new PrimaryPackage object. More...
virtual	~PrimaryPackage ()=default
Public Member Functions inherited from urcl::comm::URPackage< PackageHeader >
	URPackage ()=default
	Creates a new URPackage object. More...
virtual	~URPackage ()=default

Public Attributes
std::string	build_date_
int32_t	build_number_
uint8_t	major_version_
uint8_t	minor_version_
std::string	project_name_
int8_t	project_name_length_
int32_t	svn_version_
Public Attributes inherited from urcl::primary_interface::RobotMessage
RobotMessagePackageType	message_type_
uint8_t	source_
uint64_t	timestamp_

Additional Inherited Members
Public Types inherited from urcl::comm::URPackage< PackageHeader >
using	HeaderType = PackageHeader
Protected Attributes inherited from urcl::primary_interface::PrimaryPackage
std::unique_ptr< uint8_t >	buffer_
size_t	buffer_length_

Detailed Description

The VersionMessage class handles the version messages sent via the primary UR interface.

Definition at line 41 of file version_message.h.

Constructor & Destructor Documentation

VersionMessage() [1/2]

urcl::primary_interface::VersionMessage::VersionMessage ( )

delete

VersionMessage() [2/2]

urcl::primary_interface::VersionMessage::VersionMessage ( uint64_t  timestamp, uint8_t  source  )

inline

Creates a new VersionMessage object to be filled from a package.

Parameters

timestamp	Timestamp of the package
source	The package's source

Definition at line 51 of file version_message.h.

~VersionMessage()

virtual urcl::primary_interface::VersionMessage::~VersionMessage ( )

virtualdefault

Member Function Documentation

consumeWith()

bool urcl::primary_interface::VersionMessage::consumeWith ( AbstractPrimaryConsumer &  consumer )

virtual

Consume this package with a specific consumer.

Parameters

consumer

Placeholder for the consumer calling this

Returns

true on success

Reimplemented from urcl::primary_interface::RobotMessage.

Definition at line 52 of file version_message.cpp.

parseWith()

bool urcl::primary_interface::VersionMessage::parseWith ( comm::BinParser &  bp )

virtual

Sets the attributes of the package by parsing a serialized representation of the package.

Parameters

bp	A parser containing a serialized version of the package

Returns

True, if the package was parsed successfully, false otherwise

Reimplemented from urcl::primary_interface::RobotMessage.

Definition at line 39 of file version_message.cpp.

toString()

std::string urcl::primary_interface::VersionMessage::toString ( ) const

virtual

Produces a human readable representation of the package object.

Returns

A string representing the object

Reimplemented from urcl::primary_interface::RobotMessage.

Definition at line 57 of file version_message.cpp.

Member Data Documentation

build_date_

std::string urcl::primary_interface::VersionMessage::build_date_

Definition at line 88 of file version_message.h.

build_number_

int32_t urcl::primary_interface::VersionMessage::build_number_

Definition at line 87 of file version_message.h.

major_version_

uint8_t urcl::primary_interface::VersionMessage::major_version_

Definition at line 84 of file version_message.h.

minor_version_

uint8_t urcl::primary_interface::VersionMessage::minor_version_

Definition at line 85 of file version_message.h.

project_name_

std::string urcl::primary_interface::VersionMessage::project_name_

Definition at line 83 of file version_message.h.

project_name_length_

int8_t urcl::primary_interface::VersionMessage::project_name_length_

Definition at line 82 of file version_message.h.

svn_version_

int32_t urcl::primary_interface::VersionMessage::svn_version_

Definition at line 86 of file version_message.h.

---

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

• version_message.h
• version_message.cpp