YARP
Yet Another Robot Platform
 
Loading...
Searching...
No Matches
yarpdataplayer_console_IDL Class Reference

yarpdataplayer_console_IDL Interface. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarpdataplayer-console/idl_generated_code/yarpdataplayer_console_IDL.h>

+ Inheritance diagram for yarpdataplayer_console_IDL:

Public Member Functions

virtual yarp::os::ApplicationNetworkProtocolVersion getLocalProtocolVersion ()
 
virtual yarp::os::ApplicationNetworkProtocolVersion getRemoteProtocolVersion ()
 
virtual bool checkProtocolVersion ()
 
 yarpdataplayer_console_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 bool play ()
 Plays the dataSets.
 
virtual bool pause ()
 Pauses the dataSets.
 
virtual bool stop ()
 Stops the dataSets.
 
virtual bool enable (const std::string &part)
 Enables the specified part.
 
virtual bool disable (const std::string &part)
 Disable the specified part.
 
virtual std::vector< std::string > getAllParts ()
 Gets the names of all parts loaded.
 
virtual std::string getPortName (const std::string &part)
 Gets the name of the port associated to the specified part.
 
virtual bool setPortName (const std::string &part, const std::string &new_name)
 Sets the name of the port associated to the specified part.
 
virtual bool setSpeed (const double speed)
 Sets the player speed.
 
virtual double getSpeed ()
 Gets the player speed.
 
virtual bool repeat (const bool val=false)
 Sets repeat mode.
 
virtual bool setStrict (const bool val=false)
 Sets strict mode.
 
virtual bool forward (const std::int32_t steps=5)
 Steps forward.
 
virtual bool backward (const std::int32_t steps=5)
 Steps backward.
 
virtual double getProgress ()
 Get the progress of the parts.
 
virtual std::string getStatus ()
 Get the status of playing.
 
virtual bool resume ()
 Resume dataset from where it was paused.
 
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_console_IDL Interface.

Definition at line 23 of file yarpdataplayer_console_IDL.h.

Constructor & Destructor Documentation

◆ yarpdataplayer_console_IDL()

yarpdataplayer_console_IDL::yarpdataplayer_console_IDL ( )

Definition at line 4726 of file yarpdataplayer_console_IDL.cpp.

Member Function Documentation

◆ backward()

bool yarpdataplayer_console_IDL::backward ( const std::int32_t  steps = 5)
virtual

Steps backward.

Parameters
stepsnumber of steps to go backward (default=5).
Returns
true/false on success/failure

Definition at line 4901 of file yarpdataplayer_console_IDL.cpp.

◆ checkProtocolVersion()

bool yarpdataplayer_console_IDL::checkProtocolVersion ( )
virtual

Definition at line 81 of file yarpdataplayer_console_IDL.cpp.

◆ disable()

bool yarpdataplayer_console_IDL::disable ( const std::string &  part)
virtual

Disable the specified part.

Parameters
namespecifies the name of the loaded data
Returns
true/false on success/failure

Definition at line 4811 of file yarpdataplayer_console_IDL.cpp.

◆ enable()

bool yarpdataplayer_console_IDL::enable ( const std::string &  part)
virtual

Enables the specified part.

Parameters
namespecifies the name of the loaded data
Returns
true/false on success/failure

Definition at line 4801 of file yarpdataplayer_console_IDL.cpp.

◆ forward()

bool yarpdataplayer_console_IDL::forward ( const std::int32_t  steps = 5)
virtual

Steps forward.

Parameters
stepsnumber of steps to go forward (default=5).
Returns
true/false on success/failure

Definition at line 4891 of file yarpdataplayer_console_IDL.cpp.

◆ getAllParts()

std::vector< std::string > yarpdataplayer_console_IDL::getAllParts ( )
virtual

Gets the names of all parts loaded.

Returns
list of names of the loaded parts.

Definition at line 4821 of file yarpdataplayer_console_IDL.cpp.

◆ getFrame()

std::int32_t yarpdataplayer_console_IDL::getFrame ( const std::string &  name)
virtual

Gets the frame number the user is requesting.

Parameters
namespecifies the name of the data to modify would like to skip to
Returns
i32 returns the current frame index

Definition at line 4751 of file yarpdataplayer_console_IDL.cpp.

◆ getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpdataplayer_console_IDL::getLocalProtocolVersion ( )
virtual

Definition at line 96 of file yarpdataplayer_console_IDL.cpp.

◆ getPortName()

std::string yarpdataplayer_console_IDL::getPortName ( const std::string &  part)
virtual

Gets the name of the port associated to the specified part.

Parameters
namespecifies the name of the data to modify
Returns
port name

Definition at line 4831 of file yarpdataplayer_console_IDL.cpp.

◆ getProgress()

double yarpdataplayer_console_IDL::getProgress ( )
virtual

Get the progress of the parts.

Returns
the progress of the parts

Definition at line 4911 of file yarpdataplayer_console_IDL.cpp.

◆ getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpdataplayer_console_IDL::getRemoteProtocolVersion ( )
virtual

Definition at line 66 of file yarpdataplayer_console_IDL.cpp.

◆ getSpeed()

double yarpdataplayer_console_IDL::getSpeed ( )
virtual

Gets the player speed.

Returns
value of the player speed

Definition at line 4861 of file yarpdataplayer_console_IDL.cpp.

◆ getStatus()

std::string yarpdataplayer_console_IDL::getStatus ( )
virtual

Get the status of playing.

Returns
the status (playing, paused, stopped)

Definition at line 4921 of file yarpdataplayer_console_IDL.cpp.

◆ help()

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

Definition at line 4952 of file yarpdataplayer_console_IDL.cpp.

◆ load()

bool yarpdataplayer_console_IDL::load ( const std::string &  path)
virtual

Loads a dataset from a path.

Returns
true/false on success/failure

Definition at line 4761 of file yarpdataplayer_console_IDL.cpp.

◆ pause()

bool yarpdataplayer_console_IDL::pause ( )
virtual

Pauses the dataSets.

Returns
true/false on success/failure

Definition at line 4781 of file yarpdataplayer_console_IDL.cpp.

◆ play()

bool yarpdataplayer_console_IDL::play ( )
virtual

Plays the dataSets.

Returns
true/false on success/failure

Definition at line 4771 of file yarpdataplayer_console_IDL.cpp.

◆ quit()

bool yarpdataplayer_console_IDL::quit ( )
virtual

Quit the module.

Returns
true/false on success/failure

Definition at line 4941 of file yarpdataplayer_console_IDL.cpp.

◆ read()

bool yarpdataplayer_console_IDL::read ( yarp::os::ConnectionReader &  reader)
overridevirtual

Read this object from a network connection.

Override this for your particular class.

Parameters
readeran interface to the network connection for reading
Returns
true iff the object is successfully read

Implements yarp::os::PortReader.

Definition at line 5084 of file yarpdataplayer_console_IDL.cpp.

◆ repeat()

bool yarpdataplayer_console_IDL::repeat ( const bool  val = false)
virtual

Sets repeat mode.

Parameters
valif true repeat mode is active.
Returns
true/false on success/failure

Definition at line 4871 of file yarpdataplayer_console_IDL.cpp.

◆ resume()

bool yarpdataplayer_console_IDL::resume ( )
virtual

Resume dataset from where it was paused.

Returns
true/false on success/failure

Definition at line 4931 of file yarpdataplayer_console_IDL.cpp.

◆ setFrame()

bool yarpdataplayer_console_IDL::setFrame ( const std::int32_t  frameNum)
virtual

Sets the frame number to the user desired frame.

Parameters
frameNumspecifies the frame number the user would like to skip to
Returns
true/false on success/failure

Definition at line 4741 of file yarpdataplayer_console_IDL.cpp.

◆ setPortName()

bool yarpdataplayer_console_IDL::setPortName ( const std::string &  part,
const std::string &  new_name 
)
virtual

Sets the name of the port associated to the specified part.

Parameters
partspecifies the name of the data to modify
new_namespecifies the new name to assign to the port
Returns
true/false on success/failure

Definition at line 4841 of file yarpdataplayer_console_IDL.cpp.

◆ setSpeed()

bool yarpdataplayer_console_IDL::setSpeed ( const double  speed)
virtual

Sets the player speed.

Parameters
speedspecifies
Returns
true/false on success/failure

Definition at line 4851 of file yarpdataplayer_console_IDL.cpp.

◆ setStrict()

bool yarpdataplayer_console_IDL::setStrict ( const bool  val = false)
virtual

Sets strict mode.

Parameters
valif true strict mode is active.
Returns
true/false on success/failure

Definition at line 4881 of file yarpdataplayer_console_IDL.cpp.

◆ step()

bool yarpdataplayer_console_IDL::step ( )
virtual

Steps the player once.

The player will be stepped until all parts have sent data

Returns
true/false on success/failure

Definition at line 4731 of file yarpdataplayer_console_IDL.cpp.

◆ stop()

bool yarpdataplayer_console_IDL::stop ( )
virtual

Stops the dataSets.

Returns
true/false on success/failure

Definition at line 4791 of file yarpdataplayer_console_IDL.cpp.


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