PlayerCc::ActArrayProxy Class Reference
The ActArrayProxy
class is used to control a actarray device.
More...
#include <playerc++.h>
Inheritance diagram for PlayerCc::ActArrayProxy:
Collaboration diagram for PlayerCc::ActArrayProxy:
Detailed Description
The ActArrayProxy
class is used to control a actarray device.
Public Member Functions | |
ActArrayProxy (PlayerClient *aPc, uint32_t aIndex=0) | |
Default constructor. | |
~ActArrayProxy () | |
Default destructor. | |
void | RequestGeometry (void) |
Geometry request - call before getting the geometry of a joint through the accessor method. | |
void | SetPowerConfig (bool aVal) |
Power control. | |
void | SetBrakesConfig (bool aVal) |
Brakes control. | |
void | SetSpeedConfig (uint32_t aJoint, float aSpeed) |
Speed control. | |
void | SetAccelerationConfig (uint32_t aJoint, float aAcc) |
Acceleration control. | |
void | MoveTo (uint32_t aJoint, float aPos) |
Send an actuator to a position. | |
void | MoveToMulti (std::vector< float > aPos) |
Send actuators 0 thru n to the designated positions. | |
void | MoveAtSpeed (uint32_t aJoint, float aSpeed) |
Move an actuator at a speed. | |
void | MoveAtSpeedMulti (std::vector< float > aSpeed) |
Move actuators 0 thru n at the designated speeds. | |
void | MoveHome (int aJoint) |
Send an actuator, or all actuators, home. | |
void | SetActuatorCurrent (uint32_t aJoint, float aCurrent) |
Set an actuator to a given current. | |
void | SetActuatorCurrentMulti (std::vector< float > aCurrent) |
Set actuators 0 thru n to the given currents. | |
uint32_t | GetCount (void) const |
Gets the number of actuators in the array. | |
player_actarray_actuator_t | GetActuatorData (uint32_t aJoint) const |
Accessor method for getting an actuator's data. | |
player_actarray_actuatorgeom_t | GetActuatorGeom (uint32_t aJoint) const |
Same again for getting actuator geometry. | |
player_point_3d_t | GetBasePos (void) const |
Accessor method for getting the base position. | |
player_orientation_3d_t | GetBaseOrientation (void) const |
Accessor method for getting the base orientation. | |
player_actarray_actuator_t | operator[] (uint32_t aJoint) |
Actuator data access operator. More... | |
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_actarray_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
◆ operator[]()
|
inline |
Actuator data access operator.
This operator provides an alternate way of access the actuator data. For example, given a ActArrayProxy
named ap
, the following expressions are equivalent: ap.GetActuatorData
[0] and ap
[0].
The documentation for this class was generated from the following file: