Classes | Public Types | Public Member Functions | Protected Attributes
g2o::HyperGraphElementAction Class Reference

Abstract action that operates on a graph entity. More...

#include <hyper_graph_action.h>

Inheritance diagram for g2o::HyperGraphElementAction:
Inheritance graph
[legend]

List of all members.

Classes

struct  Parameters

Public Types

typedef std::map< std::string,
HyperGraphElementAction * > 
ActionMap

Public Member Functions

 HyperGraphElementAction (const std::string &typeName_="")
const std::string & name () const
 returns the name of an action, e.g "draw"
virtual HyperGraphElementActionoperator() (HyperGraph::HyperGraphElement *element, Parameters *parameters)
 redefine this to do the action stuff. If successful, the action returns a pointer to itself
virtual HyperGraphElementActionoperator() (const HyperGraph::HyperGraphElement *element, Parameters *parameters)
 redefine this to do the action stuff. If successful, the action returns a pointer to itself
const std::string & typeName () const
 returns the typeid name of the action
virtual ~HyperGraphElementAction ()
 destroyed actions release the memory

Protected Attributes

std::string _name
std::string _typeName

Detailed Description

Abstract action that operates on a graph entity.

Definition at line 56 of file hyper_graph_action.h.


Member Typedef Documentation

Definition at line 61 of file hyper_graph_action.h.


Constructor & Destructor Documentation

g2o::HyperGraphElementAction::HyperGraphElementAction ( const std::string &  typeName_ = "")

an action should be instantiated with the typeid.name of the graph element on which it operates

Definition at line 49 of file hyper_graph_action.cpp.

destroyed actions release the memory

Definition at line 64 of file hyper_graph_action.cpp.


Member Function Documentation

const std::string& g2o::HyperGraphElementAction::name ( void  ) const [inline]

returns the name of an action, e.g "draw"

Definition at line 79 of file hyper_graph_action.h.

HyperGraphElementAction * g2o::HyperGraphElementAction::operator() ( HyperGraph::HyperGraphElement element,
HyperGraphElementAction::Parameters parameters 
) [virtual]
HyperGraphElementAction * g2o::HyperGraphElementAction::operator() ( const HyperGraph::HyperGraphElement element,
HyperGraphElementAction::Parameters parameters 
) [virtual]

redefine this to do the action stuff. If successful, the action returns a pointer to itself

Reimplemented in g2o::HyperGraphElementActionCollection.

Definition at line 59 of file hyper_graph_action.cpp.

const std::string& g2o::HyperGraphElementAction::typeName ( ) const [inline]

returns the typeid name of the action

Definition at line 76 of file hyper_graph_action.h.


Member Data Documentation

std::string g2o::HyperGraphElementAction::_name [protected]

Definition at line 82 of file hyper_graph_action.h.

std::string g2o::HyperGraphElementAction::_typeName [protected]

Definition at line 81 of file hyper_graph_action.h.


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


re_vision
Author(s): Dorian Galvez-Lopez
autogenerated on Sun Jan 5 2014 11:34:30