class
VectorsCollectionClientVectorsCollectionClient is a class that implements that allows to receive a VectorsCollection from a VectorsCollectionServer.
Constructors, destructors, conversion operators
- VectorsCollectionClient()
- Constructor.
- ~VectorsCollectionClient() virtual
- Destructor.
Public functions
-
auto initialize(std::weak_ptr<const ParametersHandler::
IParametersHandler> handler) -> bool - Initialize the server.
- auto connect() -> bool
- Connect to the ports.
- auto disconnect() -> bool
- Disconnect from the ports.
- auto getMetadata(BipedalLocomotion::YarpUtilities::VectorsCollectionMetadata& metadata) -> bool
- Get the metadata.
- auto readData(bool shouldWait = true) -> BipedalLocomotion::YarpUtilities::VectorsCollection*
- Read the data from the port.
Function documentation
bool BipedalLocomotion:: YarpUtilities:: VectorsCollectionClient:: initialize(std::weak_ptr<const ParametersHandler:: IParametersHandler> handler)
Initialize the server.
Parameters | |
---|---|
handler | pointer to the parameters handler. |
Returns | true if the server has been initialized successfully, false otherwise. |
bool BipedalLocomotion:: YarpUtilities:: VectorsCollectionClient:: connect()
Connect to the ports.
Returns | true if the connection has been established successfully, false otherwise. |
---|
bool BipedalLocomotion:: YarpUtilities:: VectorsCollectionClient:: disconnect()
Disconnect from the ports.
Returns | true if the connection has been closed successfully, false otherwise. |
---|
bool BipedalLocomotion:: YarpUtilities:: VectorsCollectionClient:: getMetadata(BipedalLocomotion::YarpUtilities::VectorsCollectionMetadata& metadata)
Get the metadata.
Parameters | |
---|---|
metadata | metadata of the vectors collection. |
Returns | true if the metadata has been retrieved successfully, false otherwise. |
BipedalLocomotion::YarpUtilities::VectorsCollection* BipedalLocomotion:: YarpUtilities:: VectorsCollectionClient:: readData(bool shouldWait = true)
Read the data from the port.
Parameters | |
---|---|
shouldWait | if true the function will wait until the data is available. |
Returns | a pointer to the VectorsCollection. The ownership of the pointer is controlled by the yarp port. |