#include <JoypadControlNetUtils/JoypadControlNetUtils.h>

Inheritance diagram for 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.

Public Member Functions
	JoyPort ()

void	useCallback () override

void	onRead (T &datum) override
	Callback method.

void	onTimeout (double sec) override

void	useCallback (TypedReaderCallback< T > &callback) override
	Set an object whose onRead method will be called when data is available.

void	useCallback ()
	Use own onRead() method as callback.

Public Member Functions inherited from JoypadControl::LoopablePort
	LoopablePort ()=default

virtual	~LoopablePort ()=default

Public Member Functions inherited from yarp::os::BufferedPort< T >
	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.

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

T *	read (bool shouldWait=true) override
	Read an available object from the port.

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

Public Attributes
double	now

T	storage

std::mutex	mutex

Public Attributes inherited from JoypadControl::LoopablePort
bool	valid {false}

unsigned int	count {0}

std::string	name

yarp::os::Contactable *	contactable {nullptr}

Detailed Description

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

Definition at line 44 of file JoypadControlNetUtils.h.

Member Typedef Documentation

◆ bufferedPort

template<typename T >

typedef yarp::os::BufferedPort<T> JoypadControl::JoyPort< T >::bufferedPort

Definition at line 48 of file JoypadControlNetUtils.h.

Constructor & Destructor Documentation

◆ JoyPort()

template<typename T >

JoypadControl::JoyPort< T >::JoyPort ( )

inline

Definition at line 54 of file JoypadControlNetUtils.h.

Member Function Documentation

◆ onRead()

template<typename T >

void JoypadControl::JoyPort< T >::onRead ( T & datum )

inlineoverridevirtual

Callback method.

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

Parameters

datum data read from a port

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

Definition at line 62 of file JoypadControlNetUtils.h.

◆ onTimeout()

template<typename T >

void JoypadControl::JoyPort< T >::onTimeout ( double sec )

inlineoverridevirtual

Implements JoypadControl::LoopablePort.

Definition at line 70 of file JoypadControlNetUtils.h.

◆ useCallback() [1/3]

template<typename T >

void yarp::os::BufferedPort< T >::useCallback ( )

virtual

Use own onRead() method as callback.

User can override that method to be informed about data as it arrives.

Implements JoypadControl::LoopablePort.

Definition at line 219 of file BufferedPort-inl.h.

◆ useCallback() [2/3]

template<typename T >

void JoypadControl::JoyPort< T >::useCallback ( )

inlineoverridevirtual

Implements JoypadControl::LoopablePort.

Definition at line 59 of file JoypadControlNetUtils.h.

◆ useCallback() [3/3]

template<typename T >

void yarp::os::BufferedPort< T >::useCallback ( TypedReaderCallback< T > & callback )

overridevirtual

Set an object whose onRead method will be called when data is available.

Parameters

callback the object whose onRead method will be called with data

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

Definition at line 212 of file BufferedPort-inl.h.

Member Data Documentation

◆ mutex

template<typename T >

std::mutex JoypadControl::JoyPort< T >::mutex

Definition at line 52 of file JoypadControlNetUtils.h.

◆ now

template<typename T >

double JoypadControl::JoyPort< T >::now

Definition at line 50 of file JoypadControlNetUtils.h.

◆ storage

template<typename T >

T JoypadControl::JoyPort< T >::storage

Definition at line 51 of file JoypadControlNetUtils.h.

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

src/devices/JoypadControlNetUtils/JoypadControlNetUtils.h

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ bufferedPort

Constructor & Destructor Documentation

◆ JoyPort()

Member Function Documentation

◆ onRead()

◆ onTimeout()

◆ useCallback() [1/3]

◆ useCallback() [2/3]

◆ useCallback() [3/3]

Member Data Documentation

◆ mutex

◆ now

◆ storage