yarpActionsPlayer_IDL_set_thread_period_helper Class Reference

Inheritance diagram for yarpActionsPlayer_IDL_set_thread_period_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = bool(*)(const double)

Public Member Functions
	yarpActionsPlayer_IDL_set_thread_period_helper ()=default
	yarpActionsPlayer_IDL_set_thread_period_helper (const double value)
bool	write (yarp::os::ConnectionWriter &connection) const override
	Write this object to a network connection.
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
void	call (yarpActionsPlayer_IDL *ptr)
Public Member Functions inherited from yarp::os::Portable
virtual Type	getType () const
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const
Public Member Functions inherited from yarp::os::PortWriter
virtual	~PortWriter ()
	Destructor.
virtual void	onCompletion () const
	This is called when the port has finished all writing operations.
virtual void	onCommencement () const
	This is called when the port is about to begin writing operations.
virtual yarp::os::Type	getWriteType () const

Public Attributes
Command	cmd
Reply	reply

Static Public Attributes
static constexpr const char *	s_tag {"set_thread_period"}
static constexpr size_t	s_tag_len {3}
static constexpr size_t	s_cmd_len {4}
static constexpr size_t	s_reply_len {1}
static constexpr const char *	s_prototype {"bool yarpActionsPlayer_IDL::set_thread_period(const double value)"}
static constexpr const char *	s_help

Additional Inherited Members
Static Public Member Functions inherited from yarp::os::Portable
static bool	copyPortable (const PortWriter &writer, PortReader &reader)
	Copy one portable to another, via writing and reading.

Detailed Description

Definition at line 741 of file yarpActionsPlayer_IDL.cpp.

Member Typedef Documentation

funcptr_t

using yarpActionsPlayer_IDL_set_thread_period_helper::funcptr_t = bool (*)(const double)

Definition at line 789 of file yarpActionsPlayer_IDL.cpp.

Constructor & Destructor Documentation

yarpActionsPlayer_IDL_set_thread_period_helper() [1/2]

yarpActionsPlayer_IDL_set_thread_period_helper::yarpActionsPlayer_IDL_set_thread_period_helper ( )

default

yarpActionsPlayer_IDL_set_thread_period_helper() [2/2]

yarpActionsPlayer_IDL_set_thread_period_helper::yarpActionsPlayer_IDL_set_thread_period_helper ( const double  value )

explicit

Definition at line 2221 of file yarpActionsPlayer_IDL.cpp.

Member Function Documentation

call()

void yarpActionsPlayer_IDL_set_thread_period_helper::call

(

yarpActionsPlayer_IDL *

ptr

)

Definition at line 2369 of file yarpActionsPlayer_IDL.cpp.

read()

bool yarpActionsPlayer_IDL_set_thread_period_helper::read ( yarp::os::ConnectionReader &  reader )

overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters

reader

an interface to the network connection for reading

Returns

true iff the object is successfully read

Implements yarp::os::Portable.

Definition at line 2231 of file yarpActionsPlayer_IDL.cpp.

write()

bool yarpActionsPlayer_IDL_set_thread_period_helper::write ( yarp::os::ConnectionWriter &  writer ) const

overridevirtual

Write this object to a network connection.

Override this for your particular class. Be aware that depending on the nature of the connections a port has, and what protocol they use, and how efficient the YARP implementation is, this method may be called once, twice, or many times, as the result of a single call to Port::write

Parameters

writer

an interface to the network connection for writing

Returns

true iff the object is successfully written

Implements yarp::os::Portable.

Definition at line 2226 of file yarpActionsPlayer_IDL.cpp.

Member Data Documentation

cmd

Command yarpActionsPlayer_IDL_set_thread_period_helper::cmd

Definition at line 792 of file yarpActionsPlayer_IDL.cpp.

reply

Reply yarpActionsPlayer_IDL_set_thread_period_helper::reply

Definition at line 793 of file yarpActionsPlayer_IDL.cpp.

s_cmd_len

constexpr size_t yarpActionsPlayer_IDL_set_thread_period_helper::s_cmd_len {4}

staticconstexpr

Definition at line 797 of file yarpActionsPlayer_IDL.cpp.

s_help

constexpr const char* yarpActionsPlayer_IDL_set_thread_period_helper::s_help

staticconstexpr

Initial value:

{
        "Sets the period of the sampling thread (for advanced use only, default value: 0.010s).\n"
        "@return true/false on success/failure"
    }

Definition at line 800 of file yarpActionsPlayer_IDL.cpp.

s_prototype

constexpr const char* yarpActionsPlayer_IDL_set_thread_period_helper::s_prototype {"bool yarpActionsPlayer_IDL::set_thread_period(const double value)"}

staticconstexpr

Definition at line 799 of file yarpActionsPlayer_IDL.cpp.

s_reply_len

constexpr size_t yarpActionsPlayer_IDL_set_thread_period_helper::s_reply_len {1}

staticconstexpr

Definition at line 798 of file yarpActionsPlayer_IDL.cpp.

s_tag

constexpr const char* yarpActionsPlayer_IDL_set_thread_period_helper::s_tag {"set_thread_period"}

staticconstexpr

Definition at line 795 of file yarpActionsPlayer_IDL.cpp.

s_tag_len

constexpr size_t yarpActionsPlayer_IDL_set_thread_period_helper::s_tag_len {3}

staticconstexpr

Definition at line 796 of file yarpActionsPlayer_IDL.cpp.

---

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

• src/commands/yarpActionsPlayer/idl_generated_code/yarpActionsPlayer_IDL.cpp