Solar
Public Member Functions | List of all members
SolAR::api::storage::IKeyframesManager Class Referenceabstract

Allows to store a set of keyframes. UUID: 2c147595-6c74-4f69-b63d-91e162c311ed More...

#include <IKeyframesManager.h>

Inheritance diagram for SolAR::api::storage::IKeyframesManager:
Inheritance graph
[legend]
Collaboration diagram for SolAR::api::storage::IKeyframesManager:
Collaboration graph
[legend]

Public Member Functions

 IKeyframesManager ()=default
 IKeyframesStorage default constructor.
 
virtual ~IKeyframesManager ()=default
 IKeyframesStorage default destructor.
 
virtual FrameworkReturnCode addKeyframe (const SRef< SolAR::datastructure::Keyframe > keyframe)=0
 This method allow to add a frame to the keyframe manager component. More...
 
virtual FrameworkReturnCode addKeyframe (const SolAR::datastructure::Keyframe &keyframe)=0
 This method allow to add a frame to the key frame manager component. More...
 
virtual FrameworkReturnCode getKeyframe (const uint32_t id, SRef< SolAR::datastructure::Keyframe > &keyframe) const =0
 This method allows to get a keyframe by its id. More...
 
virtual FrameworkReturnCode getKeyframes (const std::vector< uint32_t > &ids, std::vector< SRef< SolAR::datastructure::Keyframe > > &keyframes) const =0
 This method allows to get a set of keyframes by their ids. More...
 
virtual FrameworkReturnCode getAllKeyframes (std::vector< SRef< SolAR::datastructure::Keyframe > > &keyframes) const =0
 This method allows to get all keyframes. More...
 
virtual FrameworkReturnCode suppressKeyframe (const uint32_t id)=0
 This method allow to suppress a keyframe by its id. More...
 
virtual SolAR::datastructure::DescriptorType getDescriptorType () const =0
 This method allows to get the descriptor type used to extract descriptor for each keyframe. More...
 
virtual FrameworkReturnCode setDescriptorType (const SolAR::datastructure::DescriptorType &type)=0
 This method allows to set the descriptor type used to extract descriptor for each keyframe. More...
 
virtual bool isExistKeyframe (const uint32_t id) const =0
 This method allows to know if a keyframe is already stored in the component. More...
 
virtual int getNbKeyframes () const =0
 This method allows to get the number of keyframes stored in the point cloud. More...
 
virtual FrameworkReturnCode saveToFile (const std::string &file) const =0
 This method allows to save the keyframes to the external file. More...
 
virtual FrameworkReturnCode loadFromFile (const std::string &file)=0
 This method allows to load the keyframes from the external file. More...
 
virtual const SRef< SolAR::datastructure::KeyframeCollection > & getConstKeyframeCollection () const =0
 This method returns the keyframe collection. More...
 
virtual std::unique_lock< std::mutex > getKeyframeCollection (SRef< SolAR::datastructure::KeyframeCollection > &keyframeCollection)=0
 This method returns the keyframe collection. More...
 
virtual void setKeyframeCollection (const SRef< SolAR::datastructure::KeyframeCollection > keyframeCollection)=0
 This method is to set the keyframe collection. More...
 

Detailed Description

Allows to store a set of keyframes. UUID: 2c147595-6c74-4f69-b63d-91e162c311ed

This storage component can be accessed by processing components to share persistent data.

Member Function Documentation

◆ addKeyframe() [1/2]

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::addKeyframe ( const SolAR::datastructure::Keyframe keyframe)
pure virtual

This method allow to add a frame to the key frame manager component.

Parameters
[in]framethe frame to add to the set of persistent keyframes
Returns
FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.

◆ addKeyframe() [2/2]

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::addKeyframe ( const SRef< SolAR::datastructure::Keyframe keyframe)
pure virtual

This method allow to add a frame to the keyframe manager component.

Parameters
[in]framethe frame to add to the set of persistent keyframes
Returns
FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.

◆ getAllKeyframes()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::getAllKeyframes ( std::vector< SRef< SolAR::datastructure::Keyframe > > &  keyframes) const
pure virtual

This method allows to get all keyframes.

Parameters
[out]keyframesthe set of keyframes
Returns
FrameworkReturnCode::SUCCESS if succeed, else FrameworkReturnCode::_ERROR.

◆ getConstKeyframeCollection()

virtual const SRef< SolAR::datastructure::KeyframeCollection > & SolAR::api::storage::IKeyframesManager::getConstKeyframeCollection ( ) const
pure virtual

This method returns the keyframe collection.

Returns
the keyframe collection

◆ getDescriptorType()

virtual SolAR::datastructure::DescriptorType SolAR::api::storage::IKeyframesManager::getDescriptorType ( ) const
pure virtual

This method allows to get the descriptor type used to extract descriptor for each keyframe.

Returns
Descriptor type

◆ getKeyframe()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::getKeyframe ( const uint32_t  id,
SRef< SolAR::datastructure::Keyframe > &  keyframe 
) const
pure virtual

This method allows to get a keyframe by its id.

Parameters
[in]idid of the keyframe to get
[out]keyframea keyframe stored in the keyframes manager
Returns
FrameworkReturnCode::SUCCESS if succeed, else FrameworkReturnCode::_ERROR.

◆ getKeyframeCollection()

virtual std::unique_lock< std::mutex > SolAR::api::storage::IKeyframesManager::getKeyframeCollection ( SRef< SolAR::datastructure::KeyframeCollection > &  keyframeCollection)
pure virtual

This method returns the keyframe collection.

Parameters
[out]keyframeCollectionthe keyframe collection of map
Returns
the keyframe collection

◆ getKeyframes()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::getKeyframes ( const std::vector< uint32_t > &  ids,
std::vector< SRef< SolAR::datastructure::Keyframe > > &  keyframes 
) const
pure virtual

This method allows to get a set of keyframes by their ids.

Parameters
[in]idsa vector of ids of the keyframes to get
[out]keyframesa vector of keyframes stored in the keyframe manager
Returns
FrameworkReturnCode::SUCCESS if succeed, else FrameworkReturnCode::_ERROR.

◆ getNbKeyframes()

virtual int SolAR::api::storage::IKeyframesManager::getNbKeyframes ( ) const
pure virtual

This method allows to get the number of keyframes stored in the point cloud.

Returns
The number of keyframes

◆ isExistKeyframe()

virtual bool SolAR::api::storage::IKeyframesManager::isExistKeyframe ( const uint32_t  id) const
pure virtual

This method allows to know if a keyframe is already stored in the component.

Parameters
[in]idid of this keyframe
Returns
true if exist, else false

◆ loadFromFile()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::loadFromFile ( const std::string &  file)
pure virtual

This method allows to load the keyframes from the external file.

Parameters
[in]filethe file name
Returns
FrameworkReturnCode::SUCCESS if the suppression succeed, else FrameworkReturnCode::_ERROR.

◆ saveToFile()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::saveToFile ( const std::string &  file) const
pure virtual

This method allows to save the keyframes to the external file.

Parameters
[in]filethe file name
Returns
FrameworkReturnCode::SUCCESS if the suppression succeed, else FrameworkReturnCode::_ERROR.

◆ setDescriptorType()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::setDescriptorType ( const SolAR::datastructure::DescriptorType &  type)
pure virtual

This method allows to set the descriptor type used to extract descriptor for each keyframe.

Parameters
[in]typethe descriptor type
Returns
FrameworkReturnCode::SUCCESS if succeed, else FrameworkReturnCode::_ERROR.

◆ setKeyframeCollection()

virtual void SolAR::api::storage::IKeyframesManager::setKeyframeCollection ( const SRef< SolAR::datastructure::KeyframeCollection keyframeCollection)
pure virtual

This method is to set the keyframe collection.

Parameters
[in]keyframeCollectionthe keyframe collection of map

◆ suppressKeyframe()

virtual FrameworkReturnCode SolAR::api::storage::IKeyframesManager::suppressKeyframe ( const uint32_t  id)
pure virtual

This method allow to suppress a keyframe by its id.

Parameters
[in]idid of the keyframe to suppress
Returns
FrameworkReturnCode::SUCCESS if the suppression succeed, else FrameworkReturnCode::_ERROR.

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