PlayerCc::SimulationProxy Class Reference

The SimulationProxy proxy provides access to a simulation device. More...

#include <playerc++.h>

Inheritance diagram for PlayerCc::SimulationProxy:

Collaboration diagram for PlayerCc::SimulationProxy:

Detailed Description

The SimulationProxy proxy provides access to a simulation device.

Public Member Functions
	SimulationProxy (PlayerClient *aPc, uint32_t aIndex=0)
	Constructor.
	~SimulationProxy ()
	Destructor.
void	SetPose2d (char *identifier, double x, double y, double a)
	set the 2D pose of an object in the simulator, identified by the std::string. More...
void	GetPose2d (char *identifier, double &x, double &y, double &a)
	get the pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code. More...
void	SetPose3d (char *identifier, double x, double y, double z, double roll, double pitch, double yaw)
	set the 3D pose of an object in the simulator, identified by the std::string. More...
void	GetPose3d (char *identifier, double &x, double &y, double &z, double &roll, double &pitch, double &yaw, double &time)
	get the 3D pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code. More...
void	GetProperty (char *identifier, char *name, void *value, size_t value_len)
	Get a simulation property.
void	SetProperty (char *identifier, char *name, void *value, size_t value_len)
	Set a simulation property.
Public Member Functions inherited from PlayerCc::ClientProxy
bool	IsValid () const
	Proxy has any information. More...
bool	IsFresh () const
	Check for fresh data. More...
void	NotFresh ()
	Reset Fresh flag. More...
std::string	GetDriverName () const
	Get the underlying driver's name. More...
double	GetDataTime () const
	Returns the received timestamp of the last data sample [s].
double	GetElapsedTime () const
	Returns the time between the current data time and the time of the last data sample [s].
PlayerClient *	GetPlayerClient () const
	Get a pointer to the Player Client. More...
uint32_t	GetIndex () const
	Get device index. More...
uint32_t	GetInterface () const
	Get Interface Code. More...
std::string	GetInterfaceStr () const
	Get Interface Name. More...
void	SetReplaceRule (bool aReplace, int aType=-1, int aSubtype=-1)
	Set a replace rule for this proxy on the server. More...
int	HasCapability (uint32_t aType, uint32_t aSubtype)
	Request capabilities of device. More...
int	GetBoolProp (char *aProperty, bool *aValue)
	Request a boolean property. More...
int	SetBoolProp (char *aProperty, bool aValue)
	Set a boolean property. More...
int	GetIntProp (char *aProperty, int32_t *aValue)
	Request an integer property. More...
int	SetIntProp (char *aProperty, int32_t aValue)
	Set an integer property. More...
int	GetDblProp (char *aProperty, double *aValue)
	Request a double property. More...
int	SetDblProp (char *aProperty, double aValue)
	Set a double property. More...
int	GetStrProp (char *aProperty, char **aValue)
	Request a string property. More...
int	SetStrProp (char *aProperty, char *aValue)
	Set a string property. More...
template<typename T >
connection_t	ConnectReadSignal (T aSubscriber)
	Connect a read signal to this proxy. More...
void	DisconnectReadSignal (connection_t aSubscriber)
	Disconnect a signal from this proxy. More...

Private Member Functions
void	Subscribe (uint32_t aIndex)
void	Unsubscribe ()

Private Attributes
playerc_simulation_t *	mDevice

Additional Inherited Members
Public Types inherited from PlayerCc::ClientProxy
typedef int	connection_t
typedef boost::mutex::scoped_lock	scoped_lock_t
typedef int	read_signal_t
Protected Member Functions inherited from PlayerCc::ClientProxy
	ClientProxy (PlayerClient *aPc, uint32_t aIndex)
template<typename T >
T	GetVar (const T &aV) const
template<typename T >
void	GetVarByRef (const T aBegin, const T aEnd, T aDest) const
Protected Attributes inherited from PlayerCc::ClientProxy
PlayerClient *	mPc
playerc_client_t *	mClient
playerc_device_t *	mInfo
bool	mFresh

Member Function Documentation

GetPose2d()

void PlayerCc::SimulationProxy::GetPose2d	(	char *	identifier,
		double &	x,
		double &	y,
		double &	a
	)

get the pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code.

GetPose3d()

void PlayerCc::SimulationProxy::GetPose3d	(	char *	identifier,
		double &	x,
		double &	y,
		double &	z,
		double &	roll,
		double &	pitch,
		double &	yaw,
		double &	time
	)

get the 3D pose of an object in the simulator, identified by the std::string Returns 0 on success, else a non-zero error code.

SetPose2d()

void PlayerCc::SimulationProxy::SetPose2d	(	char *	identifier,
		double	x,
		double	y,
		double	a
	)

set the 2D pose of an object in the simulator, identified by the std::string.

Returns 0 on success, else a non-zero error code.

SetPose3d()

void PlayerCc::SimulationProxy::SetPose3d	(	char *	identifier,
		double	x,
		double	y,
		double	z,
		double	roll,
		double	pitch,
		double	yaw
	)

set the 3D pose of an object in the simulator, identified by the std::string.

Returns 0 on success, else a non-zero error code.

---

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

• playerc++.h