g2o::PropertyMap Class Reference

a collection of properties mapping from name to the property itself More...

#include <property.h>

Inheritance diagram for g2o::PropertyMap:

Collaboration diagram for g2o::PropertyMap:

Public Types
typedef std::map< std::string, BaseProperty * >	BaseClass
typedef BaseClass::iterator	PropertyMapIterator
typedef BaseClass::const_iterator	PropertyMapConstIterator

Public Member Functions
	~PropertyMap ()
bool	addProperty (BaseProperty *p)
bool	eraseProperty (const std::string &name_)
template<typename P >
P *	getProperty (const std::string &name_)
template<typename P >
const P *	getProperty (const std::string &name_) const
template<typename P >
P *	makeProperty (const std::string &name_, const typename P::ValueType &v)
bool	updatePropertyFromString (const std::string &name, const std::string &value)
bool	updateMapFromString (const std::string &values)
void	writeToCSV (std::ostream &os) const

Detailed Description

a collection of properties mapping from name to the property itself

Definition at line 77 of file property.h.

Member Typedef Documentation

BaseClass

typedef std::map<std::string, BaseProperty*> g2o::PropertyMap::BaseClass

Definition at line 80 of file property.h.

PropertyMapConstIterator

typedef BaseClass::const_iterator g2o::PropertyMap::PropertyMapConstIterator

Definition at line 82 of file property.h.

PropertyMapIterator

typedef BaseClass::iterator g2o::PropertyMap::PropertyMapIterator

Definition at line 81 of file property.h.

Constructor & Destructor Documentation

~PropertyMap()

g2o::PropertyMap::~PropertyMap

(

)

Definition at line 56 of file property.cpp.

                          {
  for (PropertyMapIterator it = begin(); it != end(); ++it) {
    if (it->second) delete it->second;
  }
}

Member Function Documentation

addProperty()

bool g2o::PropertyMap::addProperty

(

BaseProperty *

p

)

add a property to the map

Definition at line 43 of file property.cpp.

                                             {
  std::pair<PropertyMapIterator, bool> result = insert(make_pair(p->name(), p));
  return result.second;
}

References g2o::BaseProperty::name().

eraseProperty()

bool g2o::PropertyMap::eraseProperty

(

const std::string &

name_

)

remove a property from the map

Definition at line 48 of file property.cpp.

                                                     {
  PropertyMapIterator it = find(name);
  if (it == end()) return false;
  delete it->second;
  erase(it);
  return true;
}

getProperty() [1/2]

template<typename P >

P * g2o::PropertyMap::getProperty ( const std::string &  name_ )

inline

return a property by its name

Definition at line 100 of file property.h.

                                         {
    PropertyMapIterator it = find(name_);
    if (it == end()) return nullptr;
    return dynamic_cast<P*>(it->second);
  }

Referenced by PropertiesWidget::applyProperties().

getProperty() [2/2]

template<typename P >

const P * g2o::PropertyMap::getProperty ( const std::string &  name_ ) const

inline

Definition at line 106 of file property.h.

                                                     {
    PropertyMapConstIterator it = find(name_);
    if (it == end()) return nullptr;
    return dynamic_cast<P*>(it->second);
  }

makeProperty()

template<typename P >

P * g2o::PropertyMap::makeProperty ( const std::string &  name_, const typename P::ValueType &  v  )

inline

create a property and insert it

Definition at line 116 of file property.h.

                                                                        {
    PropertyMapIterator it = find(name_);
    if (it == end()) {
      P* p = new P(name_, v);
      addProperty(p);
      return p;
    } else
      return dynamic_cast<P*>(it->second);
  }

Referenced by main(), g2o::OptimizationAlgorithmDogleg::OptimizationAlgorithmDogleg(), g2o::OptimizationAlgorithmLevenberg::OptimizationAlgorithmLevenberg(), g2o::OptimizationAlgorithmWithHessian::OptimizationAlgorithmWithHessian(), and g2o::DrawAction::refreshPropertyPtrs().

updateMapFromString()

bool g2o::PropertyMap::updateMapFromString

(

const std::string &

values

)

update the map based on a name=value string, e.g., name1=val1,name2=val2

Returns

true, if it was possible to update all parameters

Definition at line 83 of file property.cpp.

                                                             {
  bool status = true;
  vector<string> valuesMap = strSplit(values, ",");
  for (size_t i = 0; i < valuesMap.size(); ++i) {
    vector<string> m = strSplit(valuesMap[i], "=");
    if (m.size() != 2) {
      G2O_DEBUG("{}: unable to extract name=value pair from {}",
                __PRETTY_FUNCTION__, valuesMap[i]);
      continue;
    }
    string name = trim(m[0]);
    string value = trim(m[1]);
    status = status && updatePropertyFromString(name, value);
  }
  return status;
}

References __PRETTY_FUNCTION__, G2O_DEBUG, g2o::strSplit(), g2o::trim(), and updatePropertyFromString().

Referenced by g2o::OptimizationAlgorithm::updatePropertiesFromString().

updatePropertyFromString()

bool g2o::PropertyMap::updatePropertyFromString	(	const std::string &	name,
		const std::string &	value
	)

update a specific property with a new value

Returns

true if the params is stored and update was carried out

Definition at line 62 of file property.cpp.

                                                                   {
  PropertyMapIterator it = find(name);
  if (it == end()) return false;
  it->second->fromString(value);
  return true;
}

Referenced by updateMapFromString().

writeToCSV()

void g2o::PropertyMap::writeToCSV

(

std::ostream &

os

)

const

Definition at line 70 of file property.cpp.

                                                 {
  for (auto it = cbegin(); it != cend(); ++it) {
    if (it != cbegin()) os << ",";
    os << it->second->name();
  }
  os << std::endl;
  for (auto it = cbegin(); it != cend(); ++it) {
    if (it != cbegin()) os << ",";
    os << it->second->toString();
  }
  os << std::endl;
}

Referenced by main().

---

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

• /build/reproducible-path/g2o-0~20230806/g2o/stuff/property.h
• /build/reproducible-path/g2o-0~20230806/g2o/stuff/property.cpp