List of all members | Public Member Functions | Friends
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. More...
 
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.

Definition at line 15 of file SlaveIdentifierConfig.h.

Constructor & Destructor Documentation

◆ SlaveIdentifierConfig()

SlaveIdentifierConfig ( )
default

Member Function Documentation

◆ getName()

std::string getName ( )

Definition at line 24 of file SlaveIdentifierConfig.cpp.

+ Here is the caller graph for this function:

◆ getProductCode()

std::uint32_t getProductCode ( )

Definition at line 12 of file SlaveIdentifierConfig.cpp.

+ Here is the caller graph for this function:

◆ getSerialNumber()

std::uint32_t getSerialNumber ( )

Definition at line 18 of file SlaveIdentifierConfig.cpp.

+ Here is the caller graph for this function:

◆ getVendorID()

std::uint32_t getVendorID ( )

Definition at line 6 of file SlaveIdentifierConfig.cpp.

+ Here is the caller graph for this function:

◆ 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

Definition at line 30 of file SlaveIdentifierConfig.cpp.

◆ operator==()

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

Definition at line 59 of file SlaveIdentifierConfig.h.

Friends And Related Function Documentation

◆ ConfigParser

friend class ConfigParser
friend

Definition at line 17 of file SlaveIdentifierConfig.h.

◆ operator<<

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

Definition at line 36 of file SlaveIdentifierConfig.h.

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