yarpdataplayer_console_IDL_setFrame_helper Class Reference

Inheritance diagram for yarpdataplayer_console_IDL_setFrame_helper:

Classes
class	Command
class	Reply

Public Types
using	funcptr_t = bool(*)(const std::int32_t)

Public Member Functions
	yarpdataplayer_console_IDL_setFrame_helper ()=default
	yarpdataplayer_console_IDL_setFrame_helper (const std::int32_t frameNum)
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 (yarpdataplayer_console_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 {"setFrame"}
static constexpr size_t	s_tag_len {1}
static constexpr size_t	s_cmd_len {2}
static constexpr size_t	s_reply_len {1}
static constexpr const char *	s_prototype {"bool yarpdataplayer_console_IDL::setFrame(const std::int32_t frameNum)"}
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 171 of file yarpdataplayer_console_IDL.cpp.

Member Typedef Documentation

funcptr_t

using yarpdataplayer_console_IDL_setFrame_helper::funcptr_t = bool (*)(const std::int32_t)

Definition at line 219 of file yarpdataplayer_console_IDL.cpp.

Constructor & Destructor Documentation

yarpdataplayer_console_IDL_setFrame_helper() [1/2]

yarpdataplayer_console_IDL_setFrame_helper::yarpdataplayer_console_IDL_setFrame_helper ( )

default

yarpdataplayer_console_IDL_setFrame_helper() [2/2]

yarpdataplayer_console_IDL_setFrame_helper::yarpdataplayer_console_IDL_setFrame_helper ( const std::int32_t  frameNum )

explicit

Definition at line 1660 of file yarpdataplayer_console_IDL.cpp.

Member Function Documentation

call()

void yarpdataplayer_console_IDL_setFrame_helper::call

(

yarpdataplayer_console_IDL *

ptr

)

Definition at line 1808 of file yarpdataplayer_console_IDL.cpp.

read()

bool yarpdataplayer_console_IDL_setFrame_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 1670 of file yarpdataplayer_console_IDL.cpp.

write()

bool yarpdataplayer_console_IDL_setFrame_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 1665 of file yarpdataplayer_console_IDL.cpp.

Member Data Documentation

cmd

Command yarpdataplayer_console_IDL_setFrame_helper::cmd

Definition at line 222 of file yarpdataplayer_console_IDL.cpp.

reply

Reply yarpdataplayer_console_IDL_setFrame_helper::reply

Definition at line 223 of file yarpdataplayer_console_IDL.cpp.

s_cmd_len

constexpr size_t yarpdataplayer_console_IDL_setFrame_helper::s_cmd_len {2}

staticconstexpr

Definition at line 227 of file yarpdataplayer_console_IDL.cpp.

s_help

constexpr const char* yarpdataplayer_console_IDL_setFrame_helper::s_help

staticconstexpr

Initial value:

{
        "Sets the frame number to the user desired frame.\n"
        "@param frameNum specifies the frame number the user\n"
        " would like to skip to\n"
        "@return true/false on success/failure"
    }

Definition at line 230 of file yarpdataplayer_console_IDL.cpp.

s_prototype

constexpr const char* yarpdataplayer_console_IDL_setFrame_helper::s_prototype {"bool yarpdataplayer_console_IDL::setFrame(const std::int32_t frameNum)"}

staticconstexpr

Definition at line 229 of file yarpdataplayer_console_IDL.cpp.

s_reply_len

constexpr size_t yarpdataplayer_console_IDL_setFrame_helper::s_reply_len {1}

staticconstexpr

Definition at line 228 of file yarpdataplayer_console_IDL.cpp.

s_tag

constexpr const char* yarpdataplayer_console_IDL_setFrame_helper::s_tag {"setFrame"}

staticconstexpr

Definition at line 225 of file yarpdataplayer_console_IDL.cpp.

s_tag_len

constexpr size_t yarpdataplayer_console_IDL_setFrame_helper::s_tag_len {1}

staticconstexpr

Definition at line 226 of file yarpdataplayer_console_IDL.cpp.

---

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

• src/commands/yarpdataplayer-console/idl_generated_code/yarpdataplayer_console_IDL.cpp