YARP  2.3.70.1
Yet Another Robot Platform
yarp::dev::JoypadControl::JoyPort< T > Struct Template Reference

#include <JoypadControlServer/JoypadControlNetUtils.h>

+ Inheritance diagram for yarp::dev::JoypadControl::JoyPort< T >:

Public Types

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

Public Member Functions

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

Public Attributes

storage
 
yarp::os::Mutex mutex
 
- Public Attributes inherited from yarp::dev::JoypadControl::LoopablePort
bool valid
 
unsigned int count
 
yarp::os::ConstString name
 
yarp::os::Contactablecontactable
 

Detailed Description

template<typename T>
struct yarp::dev::JoypadControl::JoyPort< T >

Definition at line 17 of file JoypadControlNetUtils.h.

Member Typedef Documentation

◆ bufferedPort

Definition at line 38 of file JoypadControlNetUtils.h.

Constructor & Destructor Documentation

◆ JoyPort()

template<typename T >
yarp::dev::JoypadControl::JoyPort< T >::JoyPort ( )
inline

Definition at line 43 of file JoypadControlNetUtils.h.

Member Function Documentation

◆ onRead()

template<typename T >
virtual void yarp::dev::JoypadControl::JoyPort< T >::onRead ( T &  datum)
inlinevirtual

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< T >.

Definition at line 48 of file JoypadControlNetUtils.h.

◆ useCallback()

template<typename T >
virtual void yarp::dev::JoypadControl::JoyPort< T >::useCallback ( )
inlinevirtual

Implements yarp::dev::JoypadControl::LoopablePort.

Definition at line 45 of file JoypadControlNetUtils.h.

Member Data Documentation

◆ mutex

template<typename T >
yarp::os::Mutex yarp::dev::JoypadControl::JoyPort< T >::mutex

Definition at line 41 of file JoypadControlNetUtils.h.

◆ storage

template<typename T >
T yarp::dev::JoypadControl::JoyPort< T >::storage

Definition at line 40 of file JoypadControlNetUtils.h.


The documentation for this struct was generated from the following file: