urcl::rtde_interface::ControlPackageSetupOutputsRequest Class Reference

This class is used to setup the output recipe as part of the initial RTDE handshake. More...

#include <control_package_setup_outputs.h>

Inheritance diagram for urcl::rtde_interface::ControlPackageSetupOutputsRequest:

Public Member Functions
	ControlPackageSetupOutputsRequest ()
	Creates a new ControlPackageSetupOutputsRequest object. More...
virtual	~ControlPackageSetupOutputsRequest ()=default
Public Member Functions inherited from urcl::rtde_interface::RTDEPackage
virtual bool	parseWith (comm::BinParser &bp)
	Sets the attributes of the package by parsing a serialized representation of the package. More...
	RTDEPackage ()=delete
	Creates a new RTDEPackage object. More...
	RTDEPackage (const PackageType type)
virtual std::string	toString () const
	Produces a human readable representation of the package object. More...
virtual	~RTDEPackage ()=default
Public Member Functions inherited from urcl::comm::URPackage< PackageHeader >
	URPackage ()=default
	Creates a new URPackage object. More...
virtual	~URPackage ()=default

Static Public Member Functions
static size_t	generateSerializedRequest (uint8_t *buffer, double output_frequency, std::vector< std::string > variable_names)
	Generates a serialized package. More...
static size_t	generateSerializedRequest (uint8_t *buffer, std::vector< std::string > variable_names)
	Generates a serialized package. More...

Public Attributes
double	output_frequency_
std::string	variable_names_

Static Private Attributes
static const PackageType	PACKAGE_TYPE = PackageType::RTDE_CONTROL_PACKAGE_SETUP_OUTPUTS

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

Detailed Description

This class is used to setup the output recipe as part of the initial RTDE handshake.

Definition at line 77 of file control_package_setup_outputs.h.

Constructor & Destructor Documentation

urcl::rtde_interface::ControlPackageSetupOutputsRequest::ControlPackageSetupOutputsRequest ( )

inline

Creates a new ControlPackageSetupOutputsRequest object.

Definition at line 83 of file control_package_setup_outputs.h.

virtual urcl::rtde_interface::ControlPackageSetupOutputsRequest::~ControlPackageSetupOutputsRequest ( )

virtualdefault

Member Function Documentation

size_t urcl::rtde_interface::ControlPackageSetupOutputsRequest::generateSerializedRequest ( uint8_t *  buffer, double  output_frequency, std::vector< std::string >  variable_names  )

static

Generates a serialized package.

Parameters

buffer	Buffer to fill with the serialization
output_frequency	Frequency of data packages to be sent by the robot
variable_names	The output recipe to set

Returns

The total size of the serialized package

Definition at line 50 of file control_package_setup_outputs.cpp.

size_t urcl::rtde_interface::ControlPackageSetupOutputsRequest::generateSerializedRequest ( uint8_t *  buffer, std::vector< std::string >  variable_names  )

static

Generates a serialized package.

Parameters

buffer	Buffer to fill with the serialization
variable_names	The output recipe to set

Returns

The total size of the serialized package

Definition at line 71 of file control_package_setup_outputs.cpp.

Member Data Documentation

double urcl::rtde_interface::ControlPackageSetupOutputsRequest::output_frequency_

Definition at line 110 of file control_package_setup_outputs.h.

const PackageType urcl::rtde_interface::ControlPackageSetupOutputsRequest::PACKAGE_TYPE = PackageType::RTDE_CONTROL_PACKAGE_SETUP_OUTPUTS

staticprivate

Definition at line 114 of file control_package_setup_outputs.h.

std::string urcl::rtde_interface::ControlPackageSetupOutputsRequest::variable_names_

Definition at line 111 of file control_package_setup_outputs.h.

---

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

• control_package_setup_outputs.h
• control_package_setup_outputs.cpp