 |
YARP
Yet Another Robot Platform
|
|
|
YARP
Yet Another Robot Platform
|
|
This class is a callback class that receives the video frame from the YARP backend. More...
#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/guis/yarpview/plugin/ImagePort.h>
Inheritance diagram for InputCallback:Public Member Functions | |
| InputCallback () | |
| ~InputCallback () | |
| void | setSignalHandler (SignalHandler *) |
| sets the signalhandler to the class | |
| void | onRead (yarp::sig::ImageOf< yarp::sig::PixelBgra > &img) override |
| the function callback | |
| InputCallback (int eye) | |
| ~InputCallback () | |
| virtual void | onRead (ImageType &img) |
| Public Member Functions inherited from yarp::os::TypedReaderCallback< yarp::sig::ImageOf< yarp::sig::PixelBgra > > | |
| virtual | ~TypedReaderCallback () |
| Destructor. | |
| virtual void | onRead (yarp::sig::ImageOf< yarp::sig::PixelBgra > &datum) |
| Callback method. | |
| virtual void | onRead (yarp::sig::ImageOf< yarp::sig::PixelBgra > &datum, const yarp::os::TypedReader< yarp::sig::ImageOf< yarp::sig::PixelBgra > > &reader) |
| Callback method. | |
| Public Member Functions inherited from yarp::os::BufferedPort< ImageType > | |
| BufferedPort () | |
| Constructor. | |
| BufferedPort (Port &port) | |
| Wrap an existing unbuffered port. | |
| virtual | ~BufferedPort () |
| Destructor. | |
| bool | open (const std::string &name) override |
| Start port operation, with a specific name, with automatically-chosen network parameters. | |
| bool | open (const Contact &contact, bool registerName=true) override |
| Start port operation with user-chosen network parameters. | |
| bool | addOutput (const std::string &name) override |
| Add an output connection to the specified port. | |
| bool | addOutput (const std::string &name, const std::string &carrier) override |
| Add an output connection to the specified port, using a specified carrier. | |
| bool | addOutput (const Contact &contact) override |
| Add an output connection to the specified port, using specified network parameters. | |
| void | close () override |
| Stop port activity. | |
| void | interrupt () override |
| Interrupt any current reads or writes attached to the port. | |
| void | resume () override |
| Put the port back in an operative state after interrupt() has been called. | |
| int | getPendingReads () override |
| Get the number of objects ready to be read. | |
| Contact | where () const override |
| Returns information about how this port can be reached. | |
| std::string | getName () const override |
| Get name of port. | |
| ImageType & | prepare () |
| Access the object which will be transmitted by the next call to yarp::os::BufferedPort::write. | |
| bool | unprepare () |
| Give the last prepared object back to YARP without writing it. | |
| void | write (bool forceStrict=false) |
| Write the current object being returned by BufferedPort::prepare. | |
| void | writeStrict () |
| Write the current object being returned by BufferedPort::prepare, waiting until any previous sends are complete. | |
| void | waitForWrite () |
| Wait for any pending writes to complete. | |
| void | setStrict (bool strict=true) override |
| Call this to strictly keep all messages, or allow old ones to be quietly dropped. | |
| ImageType * | read (bool shouldWait=true) override |
| Read an available object from the port. | |
| ImageType * | lastRead () override |
| Get the last data returned by read() | |
| bool | isClosed () override |
| Returns whether the port associated with this reader has been closed. | |
| void | setReplier (PortReader &reader) override |
| If a message is received that requires a reply, use this handler. | |
| void | setReader (PortReader &reader) override |
| Set an external reader for port data. | |
| void | setAdminReader (PortReader &reader) override |
| Set an external reader for unrecognized administrative port messages. | |
| void | onRead (ImageType &datum) override |
| Callback method. | |
| void | useCallback (TypedReaderCallback< ImageType > &callback) override |
| Set an object whose onRead method will be called when data is available. | |
| void | useCallback () |
| Use own onRead() method as callback. | |
| void | disableCallback () override |
| Remove a callback set up with useCallback() | |
| bool | setEnvelope (PortWriter &envelope) override |
| Set an envelope (e.g., a timestamp) to the next message which will be sent. | |
| bool | getEnvelope (PortReader &envelope) override |
| Get the envelope information (e.g., a timestamp) from the last message received on the port. | |
| int | getInputCount () override |
| Determine how many connections are arriving into this port. | |
| int | getOutputCount () override |
| Determine how many output connections this port has. | |
| bool | isWriting () override |
| Report whether the port is currently writing data. | |
| void | getReport (PortReport &reporter) override |
| Get information on the state of the port - connections etc. | |
| void | setReporter (PortReport &reporter) override |
| Set a callback to be called upon any future connections and disconnections to/from the port. | |
| void | resetReporter () override |
| Remove the callback which is called upon any future connections and disconnections to/from the port. | |
| void * | acquire () override |
| Take control of the last object read. | |
| void | release (void *handle) override |
| Return control to YARP of an object previously taken control of with the acquire() method. | |
| void | setTargetPeriod (double period) override |
| Try to provide data periodically. | |
| Type | getType () override |
| Get the type of data the port has committed to send/receive. | |
| void | promiseType (const Type &typ) override |
| Commit the port to a particular type of data. | |
| void | setInputMode (bool expectInput) override |
| Configure the port to allow or forbid inputs. | |
| void | setOutputMode (bool expectOutput) override |
| Configure the port to allow or forbid outputs. | |
| void | setRpcMode (bool expectRpc) override |
| Configure the port to be RPC only. | |
| Property * | acquireProperties (bool readOnly) override |
| Access unstructured port properties. | |
| void | releaseProperties (Property *prop) override |
| End access unstructured port properties. | |
| void | includeNodeInName (bool flag) override |
| Choose whether to prepend a node name (if one is available) to the port's name. | |
| bool | setCallbackLock (std::mutex *mutex) override |
| Add a lock to use when invoking callbacks. | |
| bool | removeCallbackLock () override |
| Remove a lock on callbacks added with setCallbackLock() | |
| bool | lockCallback () override |
| Lock callbacks until unlockCallback() is called. | |
| bool | tryLockCallback () override |
| Try to lock callbacks until unlockCallback() is called. | |
| void | unlockCallback () override |
| Unlock callbacks. | |
| Public Member Functions inherited from yarp::os::Contactable | |
| virtual | ~Contactable () |
| Destructor. | |
| void | setReadOnly () |
| Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(false) | |
| void | setWriteOnly () |
| Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(false) | |
| void | setRpcServer () |
| Shorthand for setInputMode(true), setOutputMode(false), setRpcMode(true) | |
| void | setRpcClient () |
| Shorthand for setInputMode(false), setOutputMode(true), setRpcMode(true) | |
| Public Member Functions inherited from yarp::os::TypedReader< T > | |
| virtual | ~TypedReader ()=default |
| Destructor. | |
| Public Member Functions inherited from yarp::os::TypedReaderCallback< T > | |
| virtual | ~TypedReaderCallback () |
| Destructor. | |
| virtual void | onRead (T &datum, const yarp::os::TypedReader< T > &reader) |
| Callback method. | |
Additional Inherited Members | |
| Public Types inherited from yarp::os::BufferedPort< ImageType > | |
| typedef ImageType | ContentType |
| The type of content stored by this BufferedPort. | |
This class is a callback class that receives the video frame from the YARP backend.
Definition at line 27 of file ImagePort.h.
| InputCallback::InputCallback | ( | ) |
Definition at line 18 of file ImagePort.cpp.
|
default |
Definition at line 44 of file InputCallback.cpp.
| InputCallback::InputCallback | ( | int | eye | ) |
Definition at line 28 of file InputCallback.cpp.
| InputCallback::~InputCallback | ( | ) |
Definition at line 55 of file InputCallback.cpp.
|
override |
| void InputCallback::setSignalHandler | ( | SignalHandler * | handler | ) |
sets the signalhandler to the class
| handler | the signal handler |
Definition at line 84 of file ImagePort.cpp.
Definition at line 42 of file InputCallback.h.
| int InputCallback::expected |
Definition at line 41 of file InputCallback.h.
| int InputCallback::eye |
Definition at line 40 of file InputCallback.h.
| TextureBuffer* InputCallback::eyeRenderTexture |
Definition at line 39 of file InputCallback.h.
Definition at line 44 of file InputCallback.h.
Definition at line 43 of file InputCallback.h.
| float InputCallback::pitchOffset |
Definition at line 47 of file InputCallback.h.
| float InputCallback::rollOffset |
Definition at line 46 of file InputCallback.h.
| float InputCallback::yawOffset |
Definition at line 48 of file InputCallback.h.
1.9.8 