SolAR::datastructure::Map Class Reference

A generic map composed of an identification and a coordinate system. This class provides a generic map. More...

#include <Map.h>

Public Types
enum	MapType { _PointCloud = 0x01 , _Keyframe = 0x02 , _CovisibilityGraph = 0x04 , _KFRetriever = 0x08 }

Public Member Functions
	Map ()
	Map constructor.
	Map (const Map &other)=default
Map &	operator= (const Map &other)=default
	Map (MapType type)
	~Map ()=default
	~Map
bool	handles (MapType type)
	This method is to check an element existed in the map. More...
const SRef< Identification > &	getConstIdentification () const
	This method returns the identification. More...
std::unique_lock< std::mutex >	getIdentification (SRef< Identification > &identification)
	This method returns the identification. More...
void	setIdentification (const SRef< Identification > identification)
	This method is to set the identification. More...
const SRef< CoordinateSystem > &	getConstCoordinateSystem () const
	This method returns the coordinate system. More...
std::unique_lock< std::mutex >	getCoordinateSystem (SRef< CoordinateSystem > &coordinateSystem)
	This method returns the coordinate system. More...
void	setCoordinateSystem (const SRef< CoordinateSystem > coordinateSystem)
	This method is to set the coordinate system. More...
const SRef< PointCloud > &	getConstPointCloud () const
	This method returns the point cloud. More...
std::unique_lock< std::mutex >	getPointCloud (SRef< PointCloud > &pointCloud)
	This method returns the point cloud. More...
void	setPointCloud (const SRef< PointCloud > pointCloud)
	This method is to set the point cloud. More...
const SRef< KeyframeCollection > &	getConstKeyframeCollection () const
	This method returns the keyframe collection. More...
std::unique_lock< std::mutex >	getKeyframeCollection (SRef< KeyframeCollection > &keyframeCollection)
	This method returns the keyframe collection. More...
void	setKeyframeCollection (const SRef< KeyframeCollection > keyframeCollection)
	This method is to set the keyframe collection. More...
const SRef< CovisibilityGraph > &	getConstCovisibilityGraph () const
	This method returns the covisibility graph. More...
std::unique_lock< std::mutex >	getCovisibilityGraph (SRef< CovisibilityGraph > &covisibilityGraph)
	This method returns the covisibility graph. More...
void	setCovisibilityGraph (const SRef< CovisibilityGraph > covisibilityGraph)
	This method is to set the covisibility graph. More...
const SRef< KeyframeRetrieval > &	getConstKeyframeRetrieval () const
	This method returns the keyframe retrieval. More...
std::unique_lock< std::mutex >	getKeyframeRetrieval (SRef< KeyframeRetrieval > &keyframeRetrieval)
	This method returns the keyframe retrieval. More...
void	setKeyframeRetrieval (const SRef< KeyframeRetrieval > keyframeRetrieval)
	This method is to set the keyframe retrieval. More...
template<typename Archive >
void	serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version)

Friends
class	boost::serialization::access

Detailed Description

A generic map composed of an identification and a coordinate system. This class provides a generic map.

Member Function Documentation

getConstCoordinateSystem()

const SRef< CoordinateSystem > & SolAR::datastructure::Map::getConstCoordinateSystem

(

)

const

This method returns the coordinate system.

Returns

the coordinate system

getConstCovisibilityGraph()

const SRef< CovisibilityGraph > & SolAR::datastructure::Map::getConstCovisibilityGraph

(

)

const

This method returns the covisibility graph.

Returns

the covisibility graph

getConstIdentification()

const SRef< Identification > & SolAR::datastructure::Map::getConstIdentification

(

)

const

This method returns the identification.

Returns

the identification

getConstKeyframeCollection()

const SRef< KeyframeCollection > & SolAR::datastructure::Map::getConstKeyframeCollection

(

)

const

This method returns the keyframe collection.

Returns

the keyframe collection

getConstKeyframeRetrieval()

const SRef< KeyframeRetrieval > & SolAR::datastructure::Map::getConstKeyframeRetrieval

(

)

const

This method returns the keyframe retrieval.

Returns

the keyframe retrieval

getConstPointCloud()

const SRef< PointCloud > & SolAR::datastructure::Map::getConstPointCloud

(

)

const

This method returns the point cloud.

Returns

the point cloud

getCoordinateSystem()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getCoordinateSystem

(

SRef< CoordinateSystem > &

coordinateSystem

)

This method returns the coordinate system.

Parameters

[out]

coordinateSystem

the coordinate system of map

Returns

the coordinate system

getCovisibilityGraph()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getCovisibilityGraph

(

SRef< CovisibilityGraph > &

covisibilityGraph

)

This method returns the covisibility graph.

Parameters

[out]

covisibilityGraph

the covisibility graph of map

Returns

the covisibility graph

getIdentification()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getIdentification

(

SRef< Identification > &

identification

)

This method returns the identification.

Parameters

[out]

identification

the identification of map

Returns

the identification

getKeyframeCollection()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getKeyframeCollection

(

SRef< KeyframeCollection > &

keyframeCollection

)

This method returns the keyframe collection.

Parameters

[out]

keyframeCollection

the keyframe collection of map

Returns

the keyframe collection

getKeyframeRetrieval()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getKeyframeRetrieval

(

SRef< KeyframeRetrieval > &

keyframeRetrieval

)

This method returns the keyframe retrieval.

Parameters

[out]

keyframeRetrieval

the keyframe retrieval of map

Returns

the keyframe retrieval

getPointCloud()

std::unique_lock< std::mutex > SolAR::datastructure::Map::getPointCloud

(

SRef< PointCloud > &

pointCloud

)

This method returns the point cloud.

Parameters

[out]

pointCloud

the point cloud

Returns

the point cloud

handles()

bool SolAR::datastructure::Map::handles ( MapType  type )

inline

This method is to check an element existed in the map.

Returns

true if this element exist

setCoordinateSystem()

void SolAR::datastructure::Map::setCoordinateSystem

(

const SRef< CoordinateSystem >

coordinateSystem

)

This method is to set the coordinate system.

Parameters

[in]

coordinateSystem

the coordinate system of map

setCovisibilityGraph()

void SolAR::datastructure::Map::setCovisibilityGraph

(

const SRef< CovisibilityGraph >

covisibilityGraph

)

This method is to set the covisibility graph.

Parameters

[in]

covisibilityGraph

the covisibility graph of map

setIdentification()

void SolAR::datastructure::Map::setIdentification

(

const SRef< Identification >

identification

)

This method is to set the identification.

Parameters

[in]

identification

the identification of map

setKeyframeCollection()

void SolAR::datastructure::Map::setKeyframeCollection

(

const SRef< KeyframeCollection >

keyframeCollection

)

This method is to set the keyframe collection.

Parameters

[in]

keyframeCollection

the keyframe collection of map

setKeyframeRetrieval()

void SolAR::datastructure::Map::setKeyframeRetrieval

(

const SRef< KeyframeRetrieval >

keyframeRetrieval

)

This method is to set the keyframe retrieval.

Parameters

[in]

keyframeRetrieval

the keyframe retrieval of map

setPointCloud()

void SolAR::datastructure::Map::setPointCloud

(

const SRef< PointCloud >

pointCloud

)

This method is to set the point cloud.

Parameters

[in]

pointCloud

the point cloud

---

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

• interfaces/datastructure/Map.h
• src/datastructure/Map.cpp