Public Member Functions | Static Public Member Functions | Public Attributes | Static Private Attributes | List of all members
urcl::rtde_interface::ControlPackageSetupInputsRequest Class Reference

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

#include <control_package_setup_inputs.h>

Inheritance diagram for urcl::rtde_interface::ControlPackageSetupInputsRequest:
Inheritance graph
[legend]

Public Member Functions

 ControlPackageSetupInputsRequest ()
 Creates a new ControlPackageSetupInputsRequest object. More...
 
virtual ~ControlPackageSetupInputsRequest ()=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, std::vector< std::string > variable_names)
 Generates a serialized package. More...
 

Public Attributes

std::string variable_names_
 

Static Private Attributes

static const PackageType PACKAGE_TYPE = PackageType::RTDE_CONTROL_PACKAGE_SETUP_INPUTS
 

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 input recipe as part of the initial RTDE handshake.

Definition at line 76 of file control_package_setup_inputs.h.

Constructor & Destructor Documentation

urcl::rtde_interface::ControlPackageSetupInputsRequest::ControlPackageSetupInputsRequest ( )
inline

Creates a new ControlPackageSetupInputsRequest object.

Definition at line 82 of file control_package_setup_inputs.h.

virtual urcl::rtde_interface::ControlPackageSetupInputsRequest::~ControlPackageSetupInputsRequest ( )
virtualdefault

Member Function Documentation

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

Generates a serialized package.

Parameters
bufferBuffer to fill with the serialization
variable_namesThe input recipe to set
Returns
The total size of the serialized package

Definition at line 50 of file control_package_setup_inputs.cpp.

Member Data Documentation

const PackageType urcl::rtde_interface::ControlPackageSetupInputsRequest::PACKAGE_TYPE = PackageType::RTDE_CONTROL_PACKAGE_SETUP_INPUTS
staticprivate

Definition at line 100 of file control_package_setup_inputs.h.

std::string urcl::rtde_interface::ControlPackageSetupInputsRequest::variable_names_

Definition at line 97 of file control_package_setup_inputs.h.


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


ur_client_library
Author(s): Thomas Timm Andersen, Simon Rasmussen, Felix Exner, Lea Steffen, Tristan Schnell
autogenerated on Sun May 9 2021 02:16:26