YARP
Yet Another Robot Platform
InputCallback Class Reference

#include <ovrheadset/InputCallback.h>

+ Inheritance diagram for InputCallback:

Detailed Description

Definition at line 18 of file InputCallback.h.

Public Member Functions

 InputCallback (int eye)
 
 ~InputCallback ()
 
virtual void onRead (ImageType &img)
 Callback method. More...
 
- Public Member Functions inherited from yarp::os::BufferedPort< ImageType >
 BufferedPort ()
 Constructor. More...
 
 BufferedPort (Port &port)
 Wrap an existing unbuffered port. More...
 
virtual ~BufferedPort ()
 Destructor. More...
 
virtual bool open (const std::string &name) override
 Start port operation, with a specific name, with automatically-chosen network parameters. More...
 
virtual bool open (const Contact &contact, bool registerName=true) override
 Start port operation with user-chosen network parameters. More...
 
virtual bool addOutput (const std::string &name) override
 Add an output connection to the specified port. More...
 
virtual bool addOutput (const std::string &name, const std::string &carrier) override
 Add an output connection to the specified port, using a specified carrier. More...
 
virtual bool addOutput (const Contact &contact) override
 Add an output connection to the specified port, using specified network parameters. More...
 
virtual void close () override
 Stop port activity. More...
 
virtual void interrupt () override
 Interrupt any current reads or writes attached to the port. More...
 
virtual void resume () override
 Put the port back in an operative state after interrupt() has been called. More...
 
virtual int getPendingReads () override
 Get the number of objects ready to be read. More...
 
virtual Contact where () const override
 Returns information about how this port can be reached. More...
 
virtual std::string getName () const override
 Get name of port. More...
 
ImageTypeprepare ()
 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...
 
virtual void setStrict (bool strict=true) override
 Call this to strictly keep all messages, or allow old ones to be quietly dropped. More...
 
virtual ImageTyperead (bool shouldWait=true) override
 Read an available object from the port. More...
 
virtual ImageTypelastRead () override
 Get the last data returned by read() More...
 
virtual 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...
 
virtual void useCallback (TypedReaderCallback< ImageType > &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...
 
virtual void disableCallback () override
 Remove a callback set up with useCallback() More...
 
virtual bool setEnvelope (PortWriter &envelope) override
 Set an envelope (e.g., a timestamp) to the next message which will be sent. More...
 
virtual bool getEnvelope (PortReader &envelope) override
 Get the envelope information (e.g., a timestamp) from the last message received on the port. More...
 
virtual int getInputCount () override
 Determine how many connections are arriving into this port. More...
 
virtual int getOutputCount () override
 Determine how many output connections this port has. More...
 
bool isWriting () override
 Report whether the port is currently writing data. More...
 
virtual void getReport (PortReport &reporter) override
 Get information on the state of the port - connections etc. More...
 
virtual void setReporter (PortReport &reporter) override
 Set a callback to be called upon any future connections and disconnections to/from the port. More...
 
virtual void resetReporter () override
 Remove the callback which is called upon any future connections and disconnections to/from the port. More...
 
virtual void * acquire () override
 Take control of the last object read. More...
 
virtual void release (void *handle) override
 Return control to YARP of an object previously taken control of with the acquire() method. More...
 
virtual void setTargetPeriod (double period) override
 Try to provide data periodically. More...
 
virtual Type getType () override
 Get the type of data the port has committed to send/receive. More...
 
virtual void promiseType (const Type &typ) override
 Commit the port to a particular type of data. More...
 
virtual void setInputMode (bool expectInput) override
 Configure the port to allow or forbid inputs. More...
 
virtual void setOutputMode (bool expectOutput) override
 Configure the port to allow or forbid outputs. More...
 
virtual void setRpcMode (bool expectRpc) override
 Configure the port to be RPC only. More...
 
virtual PropertyacquireProperties (bool readOnly) override
 Access unstructured port properties. More...
 
virtual void releaseProperties (Property *prop) override
 End access unstructured port properties. More...
 
virtual void includeNodeInName (bool flag) override
 Choose whether to prepend a node name (if one is available) to the port's name. More...
 
virtual bool setCallbackLock (yarp::os::Mutex *mutex) override
 Add a lock to use when invoking callbacks. More...
 
virtual bool removeCallbackLock () override
 Remove a lock on callbacks added with setCallbackLock() More...
 
virtual bool lockCallback () override
 Lock callbacks until unlockCallback() is called. More...
 
virtual bool tryLockCallback () override
 Try to lock callbacks until unlockCallback() is called. More...
 
virtual void unlockCallback () override
 Unlock callbacks. More...
 
- Public Member Functions inherited from yarp::os::Contactable
virtual ~Contactable ()
 Destructor. 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< ImageType >
virtual ~TypedReader ()
 Destructor. More...
 
- Public Member Functions inherited from yarp::os::TypedReaderCallback< ImageType >
virtual ~TypedReaderCallback ()
 Destructor. More...
 
virtual void onRead (ImageType &datum, const yarp::os::TypedReader< ImageType > &reader)
 Callback method. More...
 

Public Attributes

TextureBuffereyeRenderTexture
 
int eye
 
int expected
 
unsigned int droppedFrames
 
unsigned int lastImageWidth
 
unsigned int lastImageHeight
 
float rollOffset
 
float pitchOffset
 
float yawOffset
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ InputCallback()

InputCallback::InputCallback ( int  eye)

Definition at line 16 of file InputCallback.cpp.

◆ ~InputCallback()

InputCallback::~InputCallback ( )

Definition at line 32 of file InputCallback.cpp.

Member Function Documentation

◆ onRead()

void InputCallback::onRead ( ImageType datum)
virtual

Callback method.

this method will be called with new data, as long as you've requested this be done by calling useCallback()

Parameters
datumdata read from a port

Reimplemented from yarp::os::BufferedPort< ImageType >.

Definition at line 43 of file InputCallback.cpp.

Member Data Documentation

◆ droppedFrames

unsigned int InputCallback::droppedFrames

Definition at line 30 of file InputCallback.h.

◆ expected

int InputCallback::expected

Definition at line 29 of file InputCallback.h.

◆ eye

int InputCallback::eye

Definition at line 28 of file InputCallback.h.

◆ eyeRenderTexture

TextureBuffer* InputCallback::eyeRenderTexture

Definition at line 27 of file InputCallback.h.

◆ lastImageHeight

unsigned int InputCallback::lastImageHeight

Definition at line 32 of file InputCallback.h.

◆ lastImageWidth

unsigned int InputCallback::lastImageWidth

Definition at line 31 of file InputCallback.h.

◆ pitchOffset

float InputCallback::pitchOffset

Definition at line 35 of file InputCallback.h.

◆ rollOffset

float InputCallback::rollOffset

Definition at line 34 of file InputCallback.h.

◆ yawOffset

float InputCallback::yawOffset

Definition at line 36 of file InputCallback.h.


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