openrave.org

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Public Attributes | List of all members
OpenRAVE::IkReturn Class Reference

#include <iksolver.h>

Collaboration diagram for OpenRAVE::IkReturn:
Collaboration graph
[legend]

Public Types

typedef std::map< std::string,
std::vector< dReal > > 
CustomData
 

Public Member Functions

 IkReturn (IkReturnAction action)
 
bool operator!= (IkReturnAction action) const
 
bool operator== (IkReturnAction action) const
 
bool Append (const IkReturn &r)
 appends the data of one IkReturn to this structure
 
void Clear ()
 clears the data, leaves the _action unchanged
 

Public Attributes

IkReturnAction _action
 
std::vector< dReal_vsolution
 the solution
 
CustomData _mapdata
 name/value pairs for custom data computed in the filters. Cascading filters using the same name will overwrite this until the last executed filter (with lowest priority).
 
UserDataPtr _userdata
 if the name/value pairs are not enough, can further use a pointer to custom data. Cascading filters with valid _userdata pointers will overwrite this until the last executed filter (with lowest priority).
 

Detailed Description

Examples:
orikfilter.cpp, and orplanning_door.cpp.

Definition at line 62 of file iksolver.h.

Member Typedef Documentation

typedef std::map<std::string, std::vector<dReal> > OpenRAVE::IkReturn::CustomData

Definition at line 84 of file iksolver.h.

Constructor & Destructor Documentation

OpenRAVE::IkReturn::IkReturn ( IkReturnAction  action)
inline

Definition at line 65 of file iksolver.h.

Member Function Documentation

bool OpenRAVE::IkReturn::Append ( const IkReturn r)

appends the data of one IkReturn to this structure

_action is untouched, _vsolution is overridden if non-empty

Returns
If data clashes, will output text and return false

Definition at line 21 of file iksolver.cpp.

void OpenRAVE::IkReturn::Clear ( )

clears the data, leaves the _action unchanged

Definition at line 52 of file iksolver.cpp.

bool OpenRAVE::IkReturn::operator!= ( IkReturnAction  action) const
inline

Definition at line 68 of file iksolver.h.

bool OpenRAVE::IkReturn::operator== ( IkReturnAction  action) const
inline

Definition at line 71 of file iksolver.h.

Member Data Documentation

IkReturnAction OpenRAVE::IkReturn::_action

Definition at line 85 of file iksolver.h.

CustomData OpenRAVE::IkReturn::_mapdata

name/value pairs for custom data computed in the filters. Cascading filters using the same name will overwrite this until the last executed filter (with lowest priority).

Definition at line 87 of file iksolver.h.

UserDataPtr OpenRAVE::IkReturn::_userdata

if the name/value pairs are not enough, can further use a pointer to custom data. Cascading filters with valid _userdata pointers will overwrite this until the last executed filter (with lowest priority).

Definition at line 88 of file iksolver.h.

std::vector< dReal > OpenRAVE::IkReturn::_vsolution

the solution

Definition at line 86 of file iksolver.h.


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