RobWorkProject  24.5.15-
Public Types | Public Member Functions | Protected Attributes | List of all members
TargetBase Class Reference

Base class for targets. More...

#include <Target.hpp>

Inherits Entity.

Inherited by Target< T >.

Public Types

typedef rw::core::Ptr< TargetBasePtr
 smart pointer type to this class
 
- Public Types inherited from Entity
typedef rw::core::Ptr< EntityPtr
 smart pointer type to this class
 

Public Member Functions

 TargetBase (int targetType=-1)
 Constructs TargetBase with a given type. More...
 
virtual ~TargetBase ()
 Destructor.
 
Type targetType ()
 Returns the type of target.
 
template<class T >
T & getValue ()
 Returns the value of the target. More...
 
- Public Member Functions inherited from Entity
 Entity (EntityType type, const std::string &id="")
 Constructs an Entity with a given type,. More...
 
virtual ~Entity ()
 Destructor.
 
rw::core::PropertyMapgetPropertyMap ()
 Returns reference to rw::core::PropertyMap associated with the Entity. More...
 
const rw::core::PropertyMapgetPropertyMap () const
 Returns reference to rw::core::PropertyMap associated with the Entity. More...
 
void setPropertyMap (const rw::core::PropertyMap &propertymap)
 Sets the content of the propertymap. More...
 
int getIndex () const
 Returns index specifying the position of the Entity in a Task. More...
 
void setIndex (int index)
 Sets the order index of the Entity. More...
 
virtual EntityType entityType () const
 Returns the type of Entity. More...
 
void setId (const std::string &id)
 Set the id for the entity. More...
 
const std::string & getId () const
 Get the id of the entity. More...
 
template<class T >
cast ()
 Method which can be used to explicitly and safely casting an Entity. More...
 

Protected Attributes

Type _targetType
 The type of the target.
 
- Protected Attributes inherited from Entity
rw::core::PropertyMap _properties
 Properties of entity.
 
EntityType _entityType
 The type of entity.
 
int _index
 The index of the entity.
 
std::string _id
 The id of the entity.
 

Detailed Description

Base class for targets.

Constructor & Destructor Documentation

◆ TargetBase()

TargetBase ( int  targetType = -1)
inline

Constructs TargetBase with a given type.

Parameters
targetType[in] Type of the target

Member Function Documentation

◆ getValue()

T & getValue

Returns the value of the target.

The user need to provide the type as template argument.

May throw a rw::core::Exception if type conversion is invalid.

Returns
Value of target

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