RobWorkProject
Public Types | Public Member Functions | Protected Attributes | List of all members
AssemblyParameterization Class Reference

Interface for a parameterization that can be used by a AssemblyControlStrategy. More...

#include <AssemblyParameterization.hpp>

Inherited by CircularPiHParameterization, PiHParameterization, and SpiralParameterization.

Public Types

typedef rw::common::Ptr< AssemblyParameterizationPtr
 smart pointer type to this class
 

Public Member Functions

 AssemblyParameterization ()
 Construct an empty parameterization.
 
 AssemblyParameterization (rw::common::Ptr< rw::common::PropertyMap > pmap)
 Construct a parameterization from a PropertyMap. More...
 
virtual ~AssemblyParameterization ()
 Destructor.
 
virtual rw::common::Ptr< rw::common::PropertyMaptoPropertyMap () const
 Store the parameterization in a PropertyMap. More...
 
virtual AssemblyParameterization::Ptr clone () const
 Clone the parameterization. More...
 
virtual AssemblyParameterization::Ptr make (rw::common::Ptr< rw::common::PropertyMap > pmap) const
 Construct a parameterization of same type from a PropertyMap. More...
 
virtual void reset (rw::common::Ptr< rw::common::PropertyMap > pmap)
 Reset the parameters by taking new parameters from a PropertyMap. More...
 

Protected Attributes

rw::common::Ptr< rw::common::PropertyMap_pmap
 The PropertyMap.
 

Detailed Description

Interface for a parameterization that can be used by a AssemblyControlStrategy.

Each AssemblyControlStrategy will typically derive its own AssemblyParameterization that includes the parameters necessary to specify the assembly operation when using that specific strategy.

By deriving from this class, the parameterization can be stored and restored via a PropertyMap structure. This is mainly used as a way to extend the assembly assembly specification with additional data, while maintaining the ability to serialize, load and save the AssemblyTask. Derived classes should override the clone(), make(), reset() and toPropertyMap() functions.

Notice that this is also a concrete class, allowing the user to create a parameterization that is always empty, or create a parameterization based on a custom PropertyMap. The latter is especially useful if scripting interfaces are used, where subclassing is not possible.

Constructor & Destructor Documentation

◆ AssemblyParameterization()

Construct a parameterization from a PropertyMap.

Parameters
pmap[in] a PropertyMap.

Member Function Documentation

◆ clone()

virtual AssemblyParameterization::Ptr clone ( ) const
virtual

Clone the parameterization.

Returns
a pointer to the new parameterization.

Reimplemented in PiHParameterization, SpiralParameterization, and CircularPiHParameterization.

◆ make()

Construct a parameterization of same type from a PropertyMap.

Parameters
pmap[in] a PropertyMap.

Reimplemented in CircularPiHParameterization.

◆ reset()

virtual void reset ( rw::common::Ptr< rw::common::PropertyMap pmap)
virtual

Reset the parameters by taking new parameters from a PropertyMap.

Parameters
pmap[in] a PropertyMap.

Reimplemented in PiHParameterization, SpiralParameterization, and CircularPiHParameterization.

◆ toPropertyMap()

virtual rw::common::Ptr<rw::common::PropertyMap> toPropertyMap ( ) const
virtual

Store the parameterization in a PropertyMap.

Returns
a pointer to a PropertyMap, or NULL if parameterization is empty.

Reimplemented in PiHParameterization, SpiralParameterization, and CircularPiHParameterization.


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