Public Member Functions | Protected Attributes | List of all members
lvr2::FileKernel Class Referenceabstract

#include <FileKernel.hpp>

Inheritance diagram for lvr2::FileKernel:
Inheritance graph
[legend]

Public Member Functions

virtual bool exists (const std::string &group) const =0
 
virtual bool exists (const std::string &group, const std::string &container) const =0
 
 FileKernel ()=delete
 
 FileKernel (const std::string &res)
 
virtual doubleArr loadDoubleArray (const std::string &group, const std::string &constainer, std::vector< size_t > &dims) const =0
 
virtual floatArr loadFloatArray (const std::string &group, const std::string &constainer, std::vector< size_t > &dims) const =0
 
virtual boost::optional< cv::Mat > loadImage (const std::string &group, const std::string &container) const =0
 
virtual MeshBufferPtr loadMeshBuffer (const std::string &group, const std::string container) const =0
 
virtual void loadMetaYAML (const std::string &group, const std::string &container, YAML::Node &node) const =0
 
virtual PointBufferPtr loadPointBuffer (const std::string &group, const std::string &container) const =0
 
virtual ucharArr loadUCharArray (const std::string &group, const std::string &constainer, std::vector< size_t > &dims) const =0
 
virtual void saveDoubleArray (const std::string &groupName, const std::string &datasetName, const std::vector< size_t > &dimensions, const boost::shared_array< double > &data) const =0
 
virtual void saveFloatArray (const std::string &groupName, const std::string &datasetName, const std::vector< size_t > &dimensions, const boost::shared_array< float > &data) const =0
 
virtual void saveImage (const std::string &group, const std::string &container, const cv::Mat &image) const =0
 
virtual void saveMeshBuffer (const std::string &group, const std::string &container, const MeshBufferPtr &buffer) const =0
 
virtual void saveMetaYAML (const std::string &group, const std::string &metaName, const YAML::Node &node) const =0
 
virtual void savePointBuffer (const std::string &group, const std::string &container, const PointBufferPtr &buffer) const =0
 
virtual void saveUCharArray (const std::string &groupName, const std::string &datasetName, const std::vector< size_t > &dimensions, const boost::shared_array< unsigned char > &data) const =0
 
virtual void subGroupNames (const std::string &group, std::vector< string > &subGroupNames) const =0
 
virtual void subGroupNames (const std::string &group, const std::regex &filter, std::vector< string > &subGroupNames) const =0
 

Protected Attributes

std::string m_fileResourceName
 

Detailed Description

Definition at line 20 of file FileKernel.hpp.

Constructor & Destructor Documentation

◆ FileKernel() [1/2]

lvr2::FileKernel::FileKernel ( )
delete

◆ FileKernel() [2/2]

lvr2::FileKernel::FileKernel ( const std::string &  res)
inline

Definition at line 25 of file FileKernel.hpp.

Member Function Documentation

◆ exists() [1/2]

virtual bool lvr2::FileKernel::exists ( const std::string &  group) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ exists() [2/2]

virtual bool lvr2::FileKernel::exists ( const std::string &  group,
const std::string &  container 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadDoubleArray()

virtual doubleArr lvr2::FileKernel::loadDoubleArray ( const std::string &  group,
const std::string &  constainer,
std::vector< size_t > &  dims 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadFloatArray()

virtual floatArr lvr2::FileKernel::loadFloatArray ( const std::string &  group,
const std::string &  constainer,
std::vector< size_t > &  dims 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadImage()

virtual boost::optional<cv::Mat> lvr2::FileKernel::loadImage ( const std::string &  group,
const std::string &  container 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadMeshBuffer()

virtual MeshBufferPtr lvr2::FileKernel::loadMeshBuffer ( const std::string &  group,
const std::string  container 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadMetaYAML()

virtual void lvr2::FileKernel::loadMetaYAML ( const std::string &  group,
const std::string &  container,
YAML::Node &  node 
) const
pure virtual

That we don't return the YAML node is on purpose to use the initial structure to look for the fields that should be loaded!

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadPointBuffer()

virtual PointBufferPtr lvr2::FileKernel::loadPointBuffer ( const std::string &  group,
const std::string &  container 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ loadUCharArray()

virtual ucharArr lvr2::FileKernel::loadUCharArray ( const std::string &  group,
const std::string &  constainer,
std::vector< size_t > &  dims 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveDoubleArray()

virtual void lvr2::FileKernel::saveDoubleArray ( const std::string &  groupName,
const std::string &  datasetName,
const std::vector< size_t > &  dimensions,
const boost::shared_array< double > &  data 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveFloatArray()

virtual void lvr2::FileKernel::saveFloatArray ( const std::string &  groupName,
const std::string &  datasetName,
const std::vector< size_t > &  dimensions,
const boost::shared_array< float > &  data 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveImage()

virtual void lvr2::FileKernel::saveImage ( const std::string &  group,
const std::string &  container,
const cv::Mat &  image 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveMeshBuffer()

virtual void lvr2::FileKernel::saveMeshBuffer ( const std::string &  group,
const std::string &  container,
const MeshBufferPtr &  buffer 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveMetaYAML()

virtual void lvr2::FileKernel::saveMetaYAML ( const std::string &  group,
const std::string &  metaName,
const YAML::Node &  node 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ savePointBuffer()

virtual void lvr2::FileKernel::savePointBuffer ( const std::string &  group,
const std::string &  container,
const PointBufferPtr &  buffer 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ saveUCharArray()

virtual void lvr2::FileKernel::saveUCharArray ( const std::string &  groupName,
const std::string &  datasetName,
const std::vector< size_t > &  dimensions,
const boost::shared_array< unsigned char > &  data 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ subGroupNames() [1/2]

virtual void lvr2::FileKernel::subGroupNames ( const std::string &  group,
std::vector< string > &  subGroupNames 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

◆ subGroupNames() [2/2]

virtual void lvr2::FileKernel::subGroupNames ( const std::string &  group,
const std::regex &  filter,
std::vector< string > &  subGroupNames 
) const
pure virtual

Implemented in lvr2::HDF5Kernel, and lvr2::DirectoryKernel.

Member Data Documentation

◆ m_fileResourceName

std::string lvr2::FileKernel::m_fileResourceName
protected

Definition at line 107 of file FileKernel.hpp.

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

lvr2
Author(s): Thomas Wiemann , Sebastian Pütz , Alexander Mock , Lars Kiesow , Lukas Kalbertodt , Tristan Igelbrink , Johan M. von Behren , Dominik Feldschnieders , Alexander Löhr
autogenerated on Mon Feb 28 2022 22:46:11