Advanced methods for copying states

Enumerations

enum  ompl::base::AdvancedStateCopyOperation { ompl::base::NO_DATA_COPIED = 0, ompl::base::SOME_DATA_COPIED = 1, ompl::base::ALL_DATA_COPIED = 2 }
 The possible outputs for an advanced copy operation. More...
 

Functions

AdvancedStateCopyOperation ompl::base::copyStateData (const StateSpacePtr &destS, State *dest, const StateSpacePtr &sourceS, const State *source)
 Copy data from source (state from space sourceS) to dest (state from space destS) on a component by component basis. State spaces are matched by name. If the state space destS contains any subspace whose name matches any subspace of the state space sourceS, the corresponding state components are copied.
 
AdvancedStateCopyOperation ompl::base::copyStateData (const StateSpace *destS, State *dest, const StateSpace *sourceS, const State *source)
 Copy data from source (state from space sourceS) to dest (state from space destS) on a component by component basis. State spaces are matched by name. If the state space destS contains any subspace whose name matches any subspace of the state space sourceS, the corresponding state components are copied.
 
AdvancedStateCopyOperation ompl::base::copyStateData (const StateSpacePtr &destS, State *dest, const StateSpacePtr &sourceS, const State *source, const std::vector< std::string > &subspaces)
 Copy data from source (state from space sourceS) to dest (state from space destS) but only for the subspaces indicated by name in subspaces. This uses StateSpace::getSubstateLocationsByName(). More...
 
AdvancedStateCopyOperation ompl::base::copyStateData (const StateSpace *destS, State *dest, const StateSpace *sourceS, const State *source, const std::vector< std::string > &subspaces)
 Copy data from source (state from space sourceS) to dest (state from space destS) but only for the subspaces indicated by name in subspaces. This uses StateSpace::getSubstateLocationsByName(). More...
 

Detailed Description

Enumeration Type Documentation

◆ AdvancedStateCopyOperation

The possible outputs for an advanced copy operation.

Enumerator
NO_DATA_COPIED 

No data was copied.

SOME_DATA_COPIED 

Some data was copied.

ALL_DATA_COPIED 

All data was copied.

Definition at line 786 of file StateSpace.h.

Function Documentation

◆ copyStateData() [1/2]

AdvancedStateCopyOperation ompl::base::copyStateData ( const StateSpacePtr destS,
State dest,
const StateSpacePtr sourceS,
const State source,
const std::vector< std::string > &  subspaces 
)

Copy data from source (state from space sourceS) to dest (state from space destS) but only for the subspaces indicated by name in subspaces. This uses StateSpace::getSubstateLocationsByName().

Note
For efficiency reasons it is a good idea usually to make sure the elements of subspaces are not subspaces of each other

◆ copyStateData() [2/2]

AdvancedStateCopyOperation ompl::base::copyStateData ( const StateSpace destS,
State dest,
const StateSpace sourceS,
const State source,
const std::vector< std::string > &  subspaces 
)

Copy data from source (state from space sourceS) to dest (state from space destS) but only for the subspaces indicated by name in subspaces. This uses StateSpace::getSubstateLocationsByName().

Note
For efficiency reasons it is a good idea usually to make sure the elements of subspaces are not subspaces of each other