g2o::HyperGraphElementAction Class Reference

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

#include <hyper_graph_action.h>

Inheritance diagram for g2o::HyperGraphElementAction:

Classes
struct	Parameters

Public Types
typedef std::shared_ptr< HyperGraphElementAction >	HyperGraphElementActionPtr
typedef std::map< std::string, HyperGraphElementActionPtr >	ActionMap

Public Member Functions
	HyperGraphElementAction (const std::string &typeName_="")
virtual HyperGraphElementAction *	operator() (HyperGraph::HyperGraphElement *element, Parameters *parameters)
virtual HyperGraphElementAction *	operator() (const HyperGraph::HyperGraphElement *element, Parameters *parameters)
virtual	~HyperGraphElementAction ()
const std::string &	typeName () const
	returns the typeid name of the action
const std::string &	name () const
	returns the name of an action, e.g "draw"
void	setTypeName (const std::string &typeName_)
	sets the type on which an action has to operate

Protected Attributes
std::string	_typeName
std::string	_name

Detailed Description

Abstract action that operates on a graph entity.

Definition at line 74 of file hyper_graph_action.h.

Member Typedef Documentation

ActionMap

typedef std::map<std::string, HyperGraphElementActionPtr> g2o::HyperGraphElementAction::ActionMap

Definition at line 80 of file hyper_graph_action.h.

HyperGraphElementActionPtr

typedef std::shared_ptr<HyperGraphElementAction> g2o::HyperGraphElementAction::HyperGraphElementActionPtr

Definition at line 79 of file hyper_graph_action.h.

Constructor & Destructor Documentation

HyperGraphElementAction()

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

explicit

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

Definition at line 56 of file hyper_graph_action.cpp.

    : _typeName(typeName_) {}

~HyperGraphElementAction()

g2o::HyperGraphElementAction::~HyperGraphElementAction ( )

virtual

Definition at line 74 of file hyper_graph_action.cpp.

{}

Member Function Documentation

name()

const std::string & g2o::HyperGraphElementAction::name ( ) const

inline

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

Definition at line 101 of file hyper_graph_action.h.

{ return _name; }

Referenced by g2o::HyperGraphElementActionCollection::registerAction().

operator()() [1/2]

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 68 of file hyper_graph_action.cpp.

                                        {
  return nullptr;
}

operator()() [2/2]

HyperGraphElementAction * g2o::HyperGraphElementAction::operator() ( 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::EdgeSE2WriteGnuplotAction, g2o::EdgeSE2PointXYWriteGnuplotAction, g2o::EdgeSE2PointXYBearingWriteGnuplotAction, g2o::VertexPointXYWriteGnuplotAction, g2o::VertexSE2WriteGnuplotAction, g2o::VertexSegment2DWriteGnuplotAction, g2o::EdgeSE3WriteGnuplotAction, g2o::VertexPointXYZWriteGnuplotAction, g2o::VertexSE3WriteGnuplotAction, and g2o::HyperGraphElementActionCollection.

Definition at line 63 of file hyper_graph_action.cpp.

                                                                      {
  return nullptr;
}

setTypeName()

void g2o::HyperGraphElementAction::setTypeName

(

const std::string &

typeName_

)

sets the type on which an action has to operate

Definition at line 59 of file hyper_graph_action.cpp.

                                                                    {
  _typeName = typeName_;
}

References _typeName.

typeName()

const std::string & g2o::HyperGraphElementAction::typeName ( ) const

inline

returns the typeid name of the action

Definition at line 98 of file hyper_graph_action.h.

{ return _typeName; }

Member Data Documentation

_name

std::string g2o::HyperGraphElementAction::_name

protected

Definition at line 108 of file hyper_graph_action.h.

Referenced by g2o::DrawAction::DrawAction(), g2o::HyperGraphElementActionCollection::HyperGraphElementActionCollection(), and g2o::WriteGnuplotAction::WriteGnuplotAction().

_typeName

std::string g2o::HyperGraphElementAction::_typeName

protected

Definition at line 107 of file hyper_graph_action.h.

Referenced by g2o::EdgeSE2WriteGnuplotAction::operator()(), g2o::EdgeSE2PointXYWriteGnuplotAction::operator()(), g2o::EdgeSE2PointXYBearingWriteGnuplotAction::operator()(), g2o::VertexPointXYWriteGnuplotAction::operator()(), g2o::VertexSE2WriteGnuplotAction::operator()(), g2o::VertexSegment2DWriteGnuplotAction::operator()(), g2o::EdgeSE3WriteGnuplotAction::operator()(), g2o::VertexPointXYZWriteGnuplotAction::operator()(), g2o::VertexSE3WriteGnuplotAction::operator()(), g2o::DrawAction::refreshPropertyPtrs(), and setTypeName().

---

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

• /build/reproducible-path/g2o-0~20230806/g2o/core/hyper_graph_action.h
• /build/reproducible-path/g2o-0~20230806/g2o/core/hyper_graph_action.cpp