YARP  2.3.68+272-20170522.1+git50f0ae7
Yet Another Robot Platform
InputCallback Class Reference

#include <ovrheadset/InputCallback.h>

+ Inheritance diagram for InputCallback:

Public Member Functions

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

Detailed Description

Definition at line 19 of file InputCallback.h.

Constructor & Destructor Documentation

◆ InputCallback()

InputCallback::InputCallback ( int  eye)

Definition at line 17 of file InputCallback.cpp.

◆ ~InputCallback()

InputCallback::~InputCallback ( )

Definition at line 33 of file InputCallback.cpp.

Member Function Documentation

◆ onRead()

void InputCallback::onRead ( ImageType datum)
virtual

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

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

Definition at line 44 of file InputCallback.cpp.

Member Data Documentation

◆ droppedFrames

unsigned int InputCallback::droppedFrames

Definition at line 31 of file InputCallback.h.

◆ expected

int InputCallback::expected

Definition at line 30 of file InputCallback.h.

◆ eye

int InputCallback::eye

Definition at line 29 of file InputCallback.h.

◆ eyeRenderTexture

TextureBuffer* InputCallback::eyeRenderTexture

Definition at line 28 of file InputCallback.h.

◆ lastImageHeight

unsigned int InputCallback::lastImageHeight

Definition at line 33 of file InputCallback.h.

◆ lastImageWidth

unsigned int InputCallback::lastImageWidth

Definition at line 32 of file InputCallback.h.

◆ pitchOffset

float InputCallback::pitchOffset

Definition at line 36 of file InputCallback.h.

◆ rollOffset

float InputCallback::rollOffset

Definition at line 35 of file InputCallback.h.

◆ yawOffset

float InputCallback::yawOffset

Definition at line 37 of file InputCallback.h.


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