yarpdataplayer_IDL Class Reference

yarpdataplayer_IDL Interface. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/guis/yarpdataplayer/idl_generated_code/yarpdataplayer_IDL.h>

Inheritance diagram for yarpdataplayer_IDL:

Public Member Functions
virtual yarp::os::ApplicationNetworkProtocolVersion	getLocalProtocolVersion ()
virtual yarp::os::ApplicationNetworkProtocolVersion	getRemoteProtocolVersion ()
virtual bool	checkProtocolVersion ()
	yarpdataplayer_IDL ()
virtual bool	step ()
	Steps the player once.
virtual bool	setFrame (const std::int32_t frameNum)
	Sets the frame number to the user desired frame.
virtual std::int32_t	getFrame (const std::string &name)
	Gets the frame number the user is requesting.
virtual bool	load (const std::string &path)
	Loads a dataset from a path.
virtual std::int32_t	getSliderPercentage ()
	Get slider percentage.
virtual std::string	getStatus ()
	Get the status of playing.
virtual bool	play ()
	Plays the dataSets.
virtual bool	pause ()
	Pauses the dataSets.
virtual bool	stop ()
	Stops the dataSets.
virtual bool	quit ()
	Quit the module.
virtual std::vector< std::string >	help (const std::string &functionName="--all")
bool	read (yarp::os::ConnectionReader &connection) override
	Read this object from a network connection.
Public Member Functions inherited from yarp::os::Wire
yarp::os::WireLink &	yarp ()
	Get YARP state associated with this object.
const yarp::os::WireLink &	yarp () const
	Get YARP state associated with this object (const version).
Public Member Functions inherited from yarp::os::PortReader
virtual	~PortReader ()
	Destructor.
virtual Type	getReadType () const

Detailed Description

yarpdataplayer_IDL Interface.

Definition at line 22 of file yarpdataplayer_IDL.h.

Constructor & Destructor Documentation

yarpdataplayer_IDL()

yarpdataplayer_IDL::yarpdataplayer_IDL

(

)

Definition at line 2132 of file yarpdataplayer_IDL.cpp.

Member Function Documentation

checkProtocolVersion()

bool yarpdataplayer_IDL::checkProtocolVersion ( )

virtual

Definition at line 80 of file yarpdataplayer_IDL.cpp.

getFrame()

std::int32_t yarpdataplayer_IDL::getFrame ( const std::string &  name )

virtual

Gets the frame number the user is requesting.

Parameters

name	specifies the name of the data to modify would like to skip to

Returns

i32 returns the current frame index

Reimplemented in MainWindow.

Definition at line 2157 of file yarpdataplayer_IDL.cpp.

getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpdataplayer_IDL::getLocalProtocolVersion ( )

virtual

Definition at line 95 of file yarpdataplayer_IDL.cpp.

getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpdataplayer_IDL::getRemoteProtocolVersion ( )

virtual

Definition at line 65 of file yarpdataplayer_IDL.cpp.

getSliderPercentage()

std::int32_t yarpdataplayer_IDL::getSliderPercentage ( )

virtual

Get slider percentage.

Returns

i32 percentage

Reimplemented in MainWindow.

Definition at line 2177 of file yarpdataplayer_IDL.cpp.

getStatus()

std::string yarpdataplayer_IDL::getStatus ( )

virtual

Get the status of playing.

Returns

the status (playing, paused, stopped)

Reimplemented in MainWindow.

Definition at line 2187 of file yarpdataplayer_IDL.cpp.

help()

std::vector< std::string > yarpdataplayer_IDL::help ( const std::string &  functionName = "--all" )

virtual

Definition at line 2238 of file yarpdataplayer_IDL.cpp.

load()

bool yarpdataplayer_IDL::load ( const std::string &  path )

virtual

Loads a dataset from a path.

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2167 of file yarpdataplayer_IDL.cpp.

pause()

bool yarpdataplayer_IDL::pause ( )

virtual

Pauses the dataSets.

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2207 of file yarpdataplayer_IDL.cpp.

play()

bool yarpdataplayer_IDL::play ( )

virtual

Plays the dataSets.

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2197 of file yarpdataplayer_IDL.cpp.

quit()

bool yarpdataplayer_IDL::quit ( )

virtual

Quit the module.

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2227 of file yarpdataplayer_IDL.cpp.

read()

bool yarpdataplayer_IDL::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::PortReader.

Definition at line 2310 of file yarpdataplayer_IDL.cpp.

setFrame()

bool yarpdataplayer_IDL::setFrame ( const std::int32_t  frameNum )

virtual

Sets the frame number to the user desired frame.

Parameters

frameNum

specifies the frame number the user would like to skip to

Returns

true/false on success/failure

Definition at line 2147 of file yarpdataplayer_IDL.cpp.

step()

bool yarpdataplayer_IDL::step ( )

virtual

Steps the player once.

The player will be stepped until all parts have sent data

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2137 of file yarpdataplayer_IDL.cpp.

stop()

bool yarpdataplayer_IDL::stop ( )

virtual

Stops the dataSets.

Returns

true/false on success/failure

Reimplemented in MainWindow.

Definition at line 2217 of file yarpdataplayer_IDL.cpp.

---

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

• src/guis/yarpdataplayer/idl_generated_code/yarpdataplayer_IDL.h
• src/guis/yarpdataplayer/idl_generated_code/yarpdataplayer_IDL.cpp