SolAR::api::pipeline::IMapUpdatePipeline Class Reference

Defines a map update pipeline. UUID: 49cbd32c-6dfa-4155-b151-7261dd13f552 More...

#include <IMapUpdatePipeline.h>

Inheritance diagram for SolAR::api::pipeline::IMapUpdatePipeline:

Collaboration diagram for SolAR::api::pipeline::IMapUpdatePipeline:

Public Member Functions
	IMapUpdatePipeline ()=default
	IMapUpdatePipeline default constructor.
virtual	~IMapUpdatePipeline ()=default
	IMapUpdatePipeline default destructor.
virtual FrameworkReturnCode	setCameraParameters (const SolAR::datastructure::CameraParameters &cameraParams)=0
	Set the camera parameters. More...
virtual FrameworkReturnCode	mapUpdateRequest (const SRef< SolAR::datastructure::Map > map)=0
	Request to the map update pipeline to update the global map from a local map. More...
virtual FrameworkReturnCode	getMapRequest (SRef< SolAR::datastructure::Map > &map) const =0
	Request to the map update pipeline to get the global map. More...
virtual FrameworkReturnCode	getSubmapRequest (const SRef< SolAR::datastructure::Frame > frame, SRef< SolAR::datastructure::Map > &map) const =0
	Request to the map update pipeline to get a submap based on a query frame. More...
virtual FrameworkReturnCode	resetMap ()=0
	Reset the map stored by the map update pipeline. More...
Public Member Functions inherited from SolAR::api::pipeline::IPipeline
virtual FrameworkReturnCode	init ()=0
	Initialization of the pipeline. More...
virtual FrameworkReturnCode	start ()=0
	Start the pipeline. More...
virtual FrameworkReturnCode	stop ()=0
	Stop the pipeline. More...

Detailed Description

Defines a map update pipeline. UUID: 49cbd32c-6dfa-4155-b151-7261dd13f552

This class provides the interface to define a map update pipeline.

Member Function Documentation

getMapRequest()

virtual FrameworkReturnCode SolAR::api::pipeline::IMapUpdatePipeline::getMapRequest ( SRef< SolAR::datastructure::Map > &  map ) const

pure virtual

Request to the map update pipeline to get the global map.

Parameters

[out]

map

the output global map

Returns

FrameworkReturnCode::SUCCESS if the global map is available, else FrameworkReturnCode::_ERROR

getSubmapRequest()

virtual FrameworkReturnCode SolAR::api::pipeline::IMapUpdatePipeline::getSubmapRequest ( const SRef< SolAR::datastructure::Frame >  frame, SRef< SolAR::datastructure::Map > &  map  ) const

pure virtual

Request to the map update pipeline to get a submap based on a query frame.

Parameters

[in]	frame	the query frame
[out]	map	the output submap

Returns

FrameworkReturnCode::SUCCESS if submap is found, else FrameworkReturnCode::_ERROR

mapUpdateRequest()

virtual FrameworkReturnCode SolAR::api::pipeline::IMapUpdatePipeline::mapUpdateRequest ( const SRef< SolAR::datastructure::Map >  map )

pure virtual

Request to the map update pipeline to update the global map from a local map.

Parameters

[in]

map

the input local map to process

Returns

FrameworkReturnCode::SUCCESS if the data are ready to be processed, else FrameworkReturnCode::_ERROR

resetMap()

virtual FrameworkReturnCode SolAR::api::pipeline::IMapUpdatePipeline::resetMap ( )

pure virtual

Reset the map stored by the map update pipeline.

Returns

FrameworkReturnCode::SUCCESS if the map is correctly reset, else FrameworkReturnCode::_ERROR

setCameraParameters()

virtual FrameworkReturnCode SolAR::api::pipeline::IMapUpdatePipeline::setCameraParameters ( const SolAR::datastructure::CameraParameters &  cameraParams )

pure virtual

Set the camera parameters.

Parameters

[in]

cameraParams

the camera parameters (its resolution and its focal)

Returns

FrameworkReturnCode::SUCCESS if the camera parameters are correctly set, else FrameworkReturnCode::_ERROR

---

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

• interfaces/api/pipeline/IMapUpdatePipeline.h