YARP
Yet Another Robot Platform
StateExtendedInputPort Class Reference

#include <RemoteControlBoard/stateExtendedReader.h>

+ Inheritance diagram for StateExtendedInputPort:

Detailed Description

Definition at line 42 of file stateExtendedReader.h.

Public Member Functions

 StateExtendedInputPort ()
 
void resetStat ()
 
void init (int numberOfJoints)
 
void onRead (yarp::dev::impl::jointData &v) override
 Callback method. More...
 
void setTimeout (const double &timeout)
 setTimeout, set the timeout for retrieving data More...
 
bool getLastSingle (int j, int field, double *data, Stamp &stamp, double &localArrivalTime)
 
bool getLastSingle (int j, int field, int *data, Stamp &stamp, double &localArrivalTime)
 
bool getLastVector (int field, double *data, Stamp &stamp, double &localArrivalTime)
 
bool getLastVector (int field, int *data, Stamp &stamp, double &localArrivalTime)
 
int getIterations ()
 
void getEstFrequency (int &ite, double &av, double &min, double &max)
 
- Public Member Functions inherited from yarp::os::BufferedPort< yarp::dev::impl::jointData >
 BufferedPort ()
 Constructor. More...
 
 BufferedPort (Port &port)
 Wrap an existing unbuffered port. More...
 
virtual ~BufferedPort ()
 Destructor. More...
 
bool open (const std::string &name) override
 Start port operation, with a specific name, with automatically-chosen network parameters. More...
 
bool open (const Contact &contact, bool registerName=true) override
 Start port operation with user-chosen network parameters. More...
 
bool addOutput (const std::string &name) override
 Add an output connection to the specified port. More...
 
bool addOutput (const std::string &name, const std::string &carrier) override
 Add an output connection to the specified port, using a specified carrier. More...
 
bool addOutput (const Contact &contact) override
 Add an output connection to the specified port, using specified network parameters. More...
 
void close () override
 Stop port activity. More...
 
void interrupt () override
 Interrupt any current reads or writes attached to the port. More...
 
void resume () override
 Put the port back in an operative state after interrupt() has been called. More...
 
int getPendingReads () override
 Get the number of objects ready to be read. More...
 
Contact where () const override
 Returns information about how this port can be reached. More...
 
std::string getName () const override
 Get name of port. More...
 
yarp::dev::impl::jointDataprepare ()
 Access the object which will be transmitted by the next call to yarp::os::BufferedPort::write. More...
 
bool unprepare ()
 Give the last prepared object back to YARP without writing it. More...
 
void write (bool forceStrict=false)
 Write the current object being returned by BufferedPort::prepare. More...
 
void writeStrict ()
 Write the current object being returned by BufferedPort::prepare, waiting until any previous sends are complete. More...
 
void waitForWrite ()
 Wait for any pending writes to complete. More...
 
void setStrict (bool strict=true) override
 Call this to strictly keep all messages, or allow old ones to be quietly dropped. More...
 
yarp::dev::impl::jointDataread (bool shouldWait=true) override
 Read an available object from the port. More...
 
yarp::dev::impl::jointDatalastRead () override
 Get the last data returned by read() More...
 
bool isClosed () override
 Returns whether the port associated with this reader has been closed. More...
 
void setReplier (PortReader &reader) override
 If a message is received that requires a reply, use this handler. More...
 
void setReader (PortReader &reader) override
 Set an external reader for port data. More...
 
void setAdminReader (PortReader &reader) override
 Set an external reader for unrecognized administrative port messages. More...
 
void onRead (yarp::dev::impl::jointData &datum) override
 Callback method. More...
 
void useCallback (TypedReaderCallback< yarp::dev::impl::jointData > &callback) override
 Set an object whose onRead method will be called when data is available. More...
 
void useCallback ()
 Use own onRead() method as callback. More...
 
void disableCallback () override
 Remove a callback set up with useCallback() More...
 
bool setEnvelope (PortWriter &envelope) override
 Set an envelope (e.g., a timestamp) to the next message which will be sent. More...
 
bool getEnvelope (PortReader &envelope) override
 Get the envelope information (e.g., a timestamp) from the last message received on the port. More...
 
int getInputCount () override
 Determine how many connections are arriving into this port. More...
 
int getOutputCount () override
 Determine how many output connections this port has. More...
 
bool isWriting () override
 Report whether the port is currently writing data. More...
 
void getReport (PortReport &reporter) override
 Get information on the state of the port - connections etc. More...
 
void setReporter (PortReport &reporter) override
 Set a callback to be called upon any future connections and disconnections to/from the port. More...
 
void resetReporter () override
 Remove the callback which is called upon any future connections and disconnections to/from the port. More...
 
void * acquire () override
 Take control of the last object read. More...
 
void release (void *handle) override
 Return control to YARP of an object previously taken control of with the acquire() method. More...
 
void setTargetPeriod (double period) override
 Try to provide data periodically. More...
 
Type getType () override
 Get the type of data the port has committed to send/receive. More...
 
void promiseType (const Type &typ) override
 Commit the port to a particular type of data. More...
 
void setInputMode (bool expectInput) override
 Configure the port to allow or forbid inputs. More...
 
void setOutputMode (bool expectOutput) override
 Configure the port to allow or forbid outputs. More...
 
void setRpcMode (bool expectRpc) override
 Configure the port to be RPC only. More...
 
PropertyacquireProperties (bool readOnly) override
 Access unstructured port properties. More...
 
void releaseProperties (Property *prop) override
 End access unstructured port properties. More...
 
void includeNodeInName (bool flag) override
 Choose whether to prepend a node name (if one is available) to the port's name. More...
 
bool setCallbackLock (yarp::os::Mutex *mutex) override
 Add a lock to use when invoking callbacks. More...
 
bool setCallbackLock (std::mutex *mutex) override
 Add a lock to use when invoking callbacks. More...
 
bool removeCallbackLock () override
 Remove a lock on callbacks added with setCallbackLock() More...
 
bool lockCallback () override
 Lock callbacks until unlockCallback() is called. More...
 
bool tryLockCallback () override
 Try to lock callbacks until unlockCallback() is called. More...
 
void unlockCallback () override
 Unlock callbacks. More...
 
- Public Member Functions inherited from yarp::os::Contactable
virtual ~Contactable ()
 Destructor. More...
 
virtual Contact where () const =0
 Returns information about how this port can be reached. More...
 
virtual std::string getName () const
 Get name of port. More...
 
void setReadOnly ()
 Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(false) More...
 
void setWriteOnly ()
 Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(false) More...
 
void setRpcServer ()
 Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(true) More...
 
void setRpcClient ()
 Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(true) More...
 
- Public Member Functions inherited from yarp::os::TypedReader< yarp::dev::impl::jointData >
virtual ~TypedReader ()=default
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::TypedReaderCallback< yarp::dev::impl::jointData >
virtual ~TypedReaderCallback ()
 Destructor. More...
 
virtual void onRead (yarp::dev::impl::jointData &datum, const yarp::os::TypedReader< yarp::dev::impl::jointData > &reader)
 Callback method. More...
 

Additional Inherited Members

- Public Types inherited from yarp::os::BufferedPort< yarp::dev::impl::jointData >
typedef yarp::dev::impl::jointData ContentType
 The type of content stored by this BufferedPort. More...
 

Constructor & Destructor Documentation

◆ StateExtendedInputPort()

StateExtendedInputPort::StateExtendedInputPort ( )

Definition at line 47 of file stateExtendedReader.cpp.

Member Function Documentation

◆ getEstFrequency()

void StateExtendedInputPort::getEstFrequency ( int &  ite,
double &  av,
double &  min,
double &  max 
)

Definition at line 312 of file stateExtendedReader.cpp.

◆ getIterations()

int StateExtendedInputPort::getIterations ( )

Definition at line 303 of file stateExtendedReader.cpp.

◆ getLastSingle() [1/2]

bool StateExtendedInputPort::getLastSingle ( int  j,
int  field,
double *  data,
Stamp stamp,
double &  localArrivalTime 
)

Definition at line 104 of file stateExtendedReader.cpp.

◆ getLastSingle() [2/2]

bool StateExtendedInputPort::getLastSingle ( int  j,
int  field,
int *  data,
Stamp stamp,
double &  localArrivalTime 
)

Definition at line 172 of file stateExtendedReader.cpp.

◆ getLastVector() [1/2]

bool StateExtendedInputPort::getLastVector ( int  field,
double *  data,
Stamp stamp,
double &  localArrivalTime 
)

Definition at line 204 of file stateExtendedReader.cpp.

◆ getLastVector() [2/2]

bool StateExtendedInputPort::getLastVector ( int  field,
int *  data,
Stamp stamp,
double &  localArrivalTime 
)

Definition at line 272 of file stateExtendedReader.cpp.

◆ init()

void StateExtendedInputPort::init ( int  numberOfJoints)

Definition at line 58 of file stateExtendedReader.cpp.

◆ onRead()

void StateExtendedInputPort::onRead ( yarp::dev::impl::jointData datum)
overridevirtual

Callback method.

Parameters
datumdata read from a port

Reimplemented from yarp::os::TypedReaderCallback< yarp::dev::impl::jointData >.

Definition at line 73 of file stateExtendedReader.cpp.

◆ resetStat()

void StateExtendedInputPort::resetStat ( )

Definition at line 35 of file stateExtendedReader.cpp.

◆ setTimeout()

void StateExtendedInputPort::setTimeout ( const double &  timeout)

setTimeout, set the timeout for retrieving data

Parameters
timeoutin seconds

Definition at line 100 of file stateExtendedReader.cpp.


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