Reader Class Reference

#include <armarx/navigation/memory/client/graph/Reader.h>

Inheritance diagram for Reader:

Public Member Functions
void	connect (armarx::armem::client::MemoryNameSystem &mns) override
Properties	defaultProperties () const override
std::vector< armarx::navigation::core::Graph >	graphs ()
std::vector< core::Location >	locations ()
std::string	propertyPrefix () const override
std::vector< core::Location >	resolveLocation (const std::string &locationName, const std::optional< std::string > &provider)
ResolveLocationNameResult	resolveLocationName (const std::string &locationName, double minMatchRatio, std::ostream *log=nullptr)
	Resolve a location by human-readable name.
	SimpleReaderBase ()
Public Member Functions inherited from SimpleReaderBase
const Properties &	properties () const
void	registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &def)
void	setProperties (const Properties &p)
	SimpleReaderBase ()
virtual	~SimpleReaderBase ()=default

Static Public Member Functions
static ResolveLocationNameResult	ResolveLocationName (const std::map< armem::MemoryID, location::arondto::Location > &locations, const std::string &locationName, double minMatchRatio, std::ostream *log=nullptr)
	Resolve a location by human-readable name.

Protected Member Functions
armem::wm::CoreSegment	allGraphs ()
armem::wm::CoreSegment	allLocations ()
std::map< armem::MemoryID, location::arondto::Location >	queryLocations ()
Protected Member Functions inherited from SimpleReaderBase
const armem::client::Reader &	memoryReader () const

Member Function Documentation

allGraphs()

armem::wm::CoreSegment allGraphs ( )

protected

allLocations()

armem::wm::CoreSegment allLocations ( )

protected

connect()

void connect ( armarx::armem::client::MemoryNameSystem & mns )

overridevirtual

Reimplemented from SimpleReaderBase.

defaultProperties()

Reader::Properties defaultProperties ( ) const

overridevirtual

Implements SimpleReaderBase.

graphs()

std::vector< armarx::navigation::core::Graph > graphs

(

)

locations()

std::vector< core::Location > locations

(

)

propertyPrefix()

std::string propertyPrefix ( ) const

overridevirtual

Implements SimpleReaderBase.

queryLocations()

std::map< armem::MemoryID, location::arondto::Location > queryLocations ( )

protected

resolveLocation()

std::vector< core::Location > resolveLocation	(	const std::string &	locationName,
		const std::optional< std::string > &	provider )

ResolveLocationName()

ResolveLocationNameResult ResolveLocationName ( const std::map< armem::MemoryID, location::arondto::Location > & locations, const std::string & locationName, double minMatchRatio, std::ostream * log = nullptr )

static

Resolve a location by human-readable name.

Matches the given name to the locations' names, and returns the ID of the location with the best match.

Parameters

locations	Locations, e.g. as returned by Reader::queryLocations().
locationName	The human-readable name.
minMatchRatio	The minimum match ratio required to accept a match.
log	Optional out-stream for logging about the matching.

Returns

Resolved location name or error message.

resolveLocationName()

ResolveLocationNameResult resolveLocationName	(	const std::string &	locationName,
		double	minMatchRatio,
		std::ostream *	log = nullptr )

Resolve a location by human-readable name.

Queries location names from the navigation memory, matches the given name to the locations' names, and returns the ID of the location with the best match.

Parameters

locationName	The human-readable name.
minMatchRatio	The minimum match ratio required to accept a match.
log	Optional out-stream for logging about the matching.

Returns

Resolved location name or error message.

SimpleReaderBase()

SimpleReaderBase

(

)

---

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

• armarx/navigation/memory/client/graph/Reader.h
• armarx/navigation/memory/client/graph/Reader.cpp