yarpActionsPlayer_IDL Interface. More...

#include </home/runner/work/yarp-documentation/yarp-documentation/yarp/src/commands/yarpActionsPlayer/idl_generated_code/yarpActionsPlayer_IDL.h>

Inheritance diagram for yarpActionsPlayer_IDL:

Public Member Functions
virtual yarp::os::ApplicationNetworkProtocolVersion	getLocalProtocolVersion ()

virtual yarp::os::ApplicationNetworkProtocolVersion	getRemoteProtocolVersion ()

virtual bool	checkProtocolVersion ()

	yarpActionsPlayer_IDL ()

virtual bool	start ()
	Start (or resumes, if stopped) the currently selected action.

virtual bool	stop ()
	Stops the currently selected (running) action.

virtual bool	reset ()
	Rewinds the currently selected action.

virtual bool	forever ()
	Similar to play, but it will automatically restart the playback when the last frame is reached.

virtual bool	print_frames ()
	Prints all the frames of the currently selected action.

virtual bool	speed_factor (const double value)
	Sets the playback speed factor for the currently selected action (default value: 1.0).

virtual bool	resample (const double value)
	Resamples the currently selected action (in seconds, recommended value 0.010s).

virtual bool	choose_action (const std::string &action_name)
	Choose the current action and wait for further commands.

virtual bool	play_action (const std::string &action_name)
	Play an action one single time.

virtual bool	show_actions ()
	Prints all the loaded actions.

virtual bool	set_thread_period (const double value)
	Sets the period of the sampling thread (for advanced use only, default value: 0.010s).

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

yarpActionsPlayer_IDL Interface.

Definition at line 22 of file yarpActionsPlayer_IDL.h.

Constructor & Destructor Documentation

◆ yarpActionsPlayer_IDL()

yarpActionsPlayer_IDL::yarpActionsPlayer_IDL ( )

Definition at line 2375 of file yarpActionsPlayer_IDL.cpp.

Member Function Documentation

◆ checkProtocolVersion()

bool yarpActionsPlayer_IDL::checkProtocolVersion ( )

virtual

Definition at line 80 of file yarpActionsPlayer_IDL.cpp.

◆ choose_action()

bool yarpActionsPlayer_IDL::choose_action ( const std::string & action_name )

virtual

Choose the current action and wait for further commands.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2450 of file yarpActionsPlayer_IDL.cpp.

◆ forever()

bool yarpActionsPlayer_IDL::forever ( )

virtual

Similar to play, but it will automatically restart the playback when the last frame is reached.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2410 of file yarpActionsPlayer_IDL.cpp.

◆ getLocalProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpActionsPlayer_IDL::getLocalProtocolVersion ( )

virtual

Definition at line 95 of file yarpActionsPlayer_IDL.cpp.

◆ getRemoteProtocolVersion()

yarp::os::ApplicationNetworkProtocolVersion yarpActionsPlayer_IDL::getRemoteProtocolVersion ( )

virtual

Definition at line 65 of file yarpActionsPlayer_IDL.cpp.

◆ help()

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

virtual

Definition at line 2491 of file yarpActionsPlayer_IDL.cpp.

◆ play_action()

bool yarpActionsPlayer_IDL::play_action ( const std::string & action_name )

virtual

Play an action one single time.

The call blocks untils the playback is complete.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2460 of file yarpActionsPlayer_IDL.cpp.

◆ print_frames()

bool yarpActionsPlayer_IDL::print_frames ( )

virtual

Prints all the frames of the currently selected action.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2420 of file yarpActionsPlayer_IDL.cpp.

◆ read()

bool yarpActionsPlayer_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 2568 of file yarpActionsPlayer_IDL.cpp.

◆ resample()

bool yarpActionsPlayer_IDL::resample ( const double value )

virtual

Resamples the currently selected action (in seconds, recommended value 0.010s).

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2440 of file yarpActionsPlayer_IDL.cpp.

◆ reset()

bool yarpActionsPlayer_IDL::reset ( )

virtual

Rewinds the currently selected action.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2400 of file yarpActionsPlayer_IDL.cpp.

◆ set_thread_period()

bool yarpActionsPlayer_IDL::set_thread_period ( const double value )

virtual

Sets the period of the sampling thread (for advanced use only, default value: 0.010s).

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2480 of file yarpActionsPlayer_IDL.cpp.

◆ show_actions()

bool yarpActionsPlayer_IDL::show_actions ( )

virtual

Prints all the loaded actions.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2470 of file yarpActionsPlayer_IDL.cpp.

◆ speed_factor()

bool yarpActionsPlayer_IDL::speed_factor ( const double value )

virtual

Sets the playback speed factor for the currently selected action (default value: 1.0).

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2430 of file yarpActionsPlayer_IDL.cpp.

◆ start()

bool yarpActionsPlayer_IDL::start ( )

virtual

Start (or resumes, if stopped) the currently selected action.

It will stop when the last frame is reached.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2380 of file yarpActionsPlayer_IDL.cpp.

◆ stop()

bool yarpActionsPlayer_IDL::stop ( )

virtual

Stops the currently selected (running) action.

Can be resumed by start.

Returns: true/false on success/failure

Reimplemented in scriptModule.

Definition at line 2390 of file yarpActionsPlayer_IDL.cpp.

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

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ yarpActionsPlayer_IDL()

Member Function Documentation

◆ checkProtocolVersion()

◆ choose_action()

◆ forever()

◆ getLocalProtocolVersion()

◆ getRemoteProtocolVersion()

◆ help()

◆ play_action()

◆ print_frames()

◆ read()

◆ resample()

◆ reset()

◆ set_thread_period()

◆ show_actions()

◆ speed_factor()

◆ start()

◆ stop()