SlaveIdentifierConfig Class Reference

Data structure holding the information necessary to create a SlaveIdentifier. More...

#include <armarx/control/hardware_config/SlaveIdentifierConfig.h>

Public Member Functions

std::string getName ()
 
std::uint32_t getProductCode ()
 
std::uint32_t getSerialNumber ()
 
std::uint32_t getVendorID ()
 
bool isValid (std::vector< std::string > &errorMessages)
 Check if the SlaveIdentifierConfig is complete and valid.
 
bool operator== (const SlaveIdentifierConfig &other) const
 
 SlaveIdentifierConfig ()=default
 

Friends

class ConfigParser
 
std::ostream & operator<< (std::ostream &stream, const SlaveIdentifierConfig &rhs)
 

Detailed Description

Data structure holding the information necessary to create a SlaveIdentifier.

Can be printed to streams and compared for equality.

Constructor & Destructor Documentation

◆ SlaveIdentifierConfig()

SlaveIdentifierConfig ( )
default

Member Function Documentation

◆ getName()

std::string getName ( )

◆ getProductCode()

std::uint32_t getProductCode ( )

◆ getSerialNumber()

std::uint32_t getSerialNumber ( )

◆ getVendorID()

std::uint32_t getVendorID ( )

◆ isValid()

bool isValid ( std::vector< std::string > & errorMessages)

Check if the SlaveIdentifierConfig is complete and valid.

Parameters
errorMessagesvector that receives the messages describing the cause if invalid. If true is returned then no message is appended to the vector.
Returns
iff this SlaveIdentifierConfig is valid

◆ operator==()

bool operator== ( const SlaveIdentifierConfig & other) const
inline

Friends And Related Symbol Documentation

◆ ConfigParser

friend class ConfigParser
friend

◆ operator<<

std::ostream & operator<< ( std::ostream & stream,
const SlaveIdentifierConfig & rhs )
friend

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