Public Member Functions | Protected Attributes | List of all members
ColorClient Class Reference

#include <ColorClient.hpp>

Collaboration diagram for ColorClient:
Collaboration graph
[legend]

Public Member Functions

 ColorClient ()
 
bool open (const char *serverPrefix, bool quiet=true)
 
bool close ()
 
bool size (int &value)
 
bool get (std::vector< double > &values)
 

Protected Attributes

Network yarp
 
BufferedPort< Bottle > stateClient
 
bool isQuiet
 

Detailed Description

The ColorClient class implements a client part that connects to a remote colorSegmentor or colorDepth module.

Constructor & Destructor Documentation

ColorClient::ColorClient ( )

Constructor.

Member Function Documentation

bool ColorClient::close ( )

Close the port and object graciously.

Returns
true if the object and connection was closed successfully
bool ColorClient::get ( std::vector< double > &  values)

Get values.

Parameters
valuesreturned
Returns
true
bool ColorClient::open ( const char *  serverPrefix,
bool  quiet = true 
)

Configure the object and make it connect to a colorXxx module by port name.

Parameters
serverPrefixthe colorXxx module port name prefix ('/colorSegmentor' or '/colorDepth').
quietsuppress messages displayed upon success/failure.
Returns
true if the object and connection was created successfully.
bool ColorClient::size ( int &  value)

Get how many coordinates are given per point. Refer to documentation of colorSegmentor, colorDepth or similar for unit info.

Parameters
sizereturn
Returns
true

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