g2o::HyperGraphActionLibrary Class Reference

library of actions, indexed by the action name; More...

#include <hyper_graph_action.h>

Public Member Functions
	HyperGraphActionLibrary (HyperGraphActionLibrary const &)=delete
HyperGraphActionLibrary &	operator= (HyperGraphActionLibrary const &)=delete
HyperGraphElementAction *	actionByName (const std::string &name)
bool	registerAction (const HyperGraphElementAction::HyperGraphElementActionPtr &action)
bool	unregisterAction (const HyperGraphElementAction::HyperGraphElementActionPtr &action)
HyperGraphElementAction::ActionMap &	actionMap ()

Static Public Member Functions
static HyperGraphActionLibrary *	instance ()
	return the single instance of the HyperGraphActionLibrary
static void	destroy ()
	free the instance

Protected Member Functions
	HyperGraphActionLibrary ()=default

Protected Attributes
HyperGraphElementAction::ActionMap	_actionMap

Static Private Attributes
static std::unique_ptr< HyperGraphActionLibrary >	actionLibInstance

Detailed Description

library of actions, indexed by the action name;

library of actions, indexed by the action name; one can use ti to register a collection of actions

Definition at line 150 of file hyper_graph_action.h.

Constructor & Destructor Documentation

HyperGraphActionLibrary() [1/2]

g2o::HyperGraphActionLibrary::HyperGraphActionLibrary ( HyperGraphActionLibrary const &  )

delete

HyperGraphActionLibrary() [2/2]

g2o::HyperGraphActionLibrary::HyperGraphActionLibrary ( )

protecteddefault

Member Function Documentation

actionByName()

HyperGraphElementAction * g2o::HyperGraphActionLibrary::actionByName

(

const std::string &

name

)

Definition at line 140 of file hyper_graph_action.cpp.

                           {
  HyperGraphElementAction::ActionMap::iterator it = _actionMap.find(name);
  if (it != _actionMap.end()) return it->second.get();
  return nullptr;
}

References _actionMap.

Referenced by g2o::G2oQGLViewer::draw(), g2o::dumpEdges(), g2o::DrawAction::initializeDrawActionsCache(), registerAction(), and g2o::saveGnuplot().

actionMap()

HyperGraphElementAction::ActionMap & g2o::HyperGraphActionLibrary::actionMap ( )

inline

Definition at line 168 of file hyper_graph_action.h.

{ return _actionMap; }

destroy()

void g2o::HyperGraphActionLibrary::destroy ( )

static

free the instance

Definition at line 135 of file hyper_graph_action.cpp.

                                      {
  std::unique_ptr<HyperGraphActionLibrary> aux;
  actionLibInstance.swap(aux);
}

References actionLibInstance.

instance()

HyperGraphActionLibrary * g2o::HyperGraphActionLibrary::instance ( )

static

return the single instance of the HyperGraphActionLibrary

Definition at line 127 of file hyper_graph_action.cpp.

                                                           {
  if (actionLibInstance == 0) {
    actionLibInstance =
        std::unique_ptr<HyperGraphActionLibrary>(new HyperGraphActionLibrary);
  }
  return actionLibInstance.get();
}

References actionLibInstance.

Referenced by g2o::G2oQGLViewer::draw(), g2o::dumpEdges(), g2o::G2O_ATTRIBUTE_CONSTRUCTOR(), g2o::DrawAction::initializeDrawActionsCache(), g2o::RegisterActionProxy< T >::RegisterActionProxy(), and g2o::saveGnuplot().

operator=()

HyperGraphActionLibrary & g2o::HyperGraphActionLibrary::operator= ( HyperGraphActionLibrary const &  )

delete

registerAction()

bool g2o::HyperGraphActionLibrary::registerAction

(

const HyperGraphElementAction::HyperGraphElementActionPtr &

action

)

Definition at line 147 of file hyper_graph_action.cpp.

                                                                     {
  HyperGraphElementAction* oldAction = actionByName(action->name());
  HyperGraphElementActionCollection* collection = nullptr;
  if (oldAction) {
    collection = dynamic_cast<HyperGraphElementActionCollection*>(oldAction);
    if (!collection) {
      G2O_ERROR(
          "{}: : fatal error, a collection is not at the first level in the "
          "library",
          __PRETTY_FUNCTION__);
      return false;
    }
  }
  if (collection) {
    return collection->registerAction(action);
  }
#ifdef G2O_DEBUG_ACTIONLIB
  G2O_DEBUG("{}: creating collection for {}", __PRETTY_FUNCTION__,
            action->name());
#endif
  collection = new HyperGraphElementActionCollection(action->name());
  _actionMap.insert(make_pair(
      action->name(),
      HyperGraphElementAction::HyperGraphElementActionPtr(collection)));
  return collection->registerAction(action);
}

References __PRETTY_FUNCTION__, _actionMap, actionByName(), G2O_DEBUG, G2O_ERROR, and g2o::HyperGraphElementActionCollection::registerAction().

Referenced by g2o::G2O_ATTRIBUTE_CONSTRUCTOR(), and g2o::RegisterActionProxy< T >::RegisterActionProxy().

unregisterAction()

bool g2o::HyperGraphActionLibrary::unregisterAction

(

const HyperGraphElementAction::HyperGraphElementActionPtr &

action

)

Definition at line 175 of file hyper_graph_action.cpp.

                                                                     {
  list<HyperGraphElementActionCollection*> collectionDeleteList;
 
  // Search all the collections and delete the registered actions; if a
  // collection becomes empty, schedule it for deletion; note that we can't
  // delete the collections as we go because this will screw up the state of the
  // iterators
  for (HyperGraphElementAction::ActionMap::iterator it = _actionMap.begin();
       it != _actionMap.end(); ++it) {
    HyperGraphElementActionCollection* collection =
        dynamic_cast<HyperGraphElementActionCollection*>(it->second.get());
    if (collection != nullptr) {
      collection->unregisterAction(action);
      if (collection->actionMap().size() == 0) {
        collectionDeleteList.push_back(collection);
      }
    }
  }
 
  // Delete any empty action collections
  for (list<HyperGraphElementActionCollection*>::iterator itc =
           collectionDeleteList.begin();
       itc != collectionDeleteList.end(); ++itc) {
    // cout << "Deleting collection " << (*itc)->name() << endl;
    _actionMap.erase((*itc)->name());
  }
 
  return true;
}

References _actionMap, g2o::HyperGraphElementActionCollection::actionMap(), and g2o::HyperGraphElementActionCollection::unregisterAction().

Member Data Documentation

_actionMap

HyperGraphElementAction::ActionMap g2o::HyperGraphActionLibrary::_actionMap

protected

Definition at line 172 of file hyper_graph_action.h.

Referenced by actionByName(), registerAction(), and unregisterAction().

actionLibInstance

std::unique_ptr< HyperGraphActionLibrary > g2o::HyperGraphActionLibrary::actionLibInstance

staticprivate

Definition at line 175 of file hyper_graph_action.h.

Referenced by destroy(), and instance().

---

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