fire::io::BaseData Class Reference

Empty data base allowing recursion. More...

#include <AbstractData.h>

Inheritance diagram for fire::io::BaseData:

Collaboration diagram for fire::io::BaseData:

Public Member Functions
	BaseData (const std::string &path)
	Define the full in-file path to the data set of this data. More...
virtual	~BaseData ()=default
	virtual destructor so inherited classes can be properly destructed.
virtual void	load (h5::Reader &f)=0
	pure virtual method for loading data from the input file More...
virtual void	save (Writer &f)=0
	pure virtual method for saving the current data More...
virtual void	structure (Writer &f)=0
	we should persist our hierarchy into the output file More...
virtual void	clear ()=0
	pure virtual method for resetting the current data to a blank state More...

Protected Attributes
std::string	path_
	path of data set

Detailed Description

Empty data base allowing recursion.

This does not have the type information of the data stored in any of the derived datasets, it simply instructs the derived data sets to define a load and save mechanism for loading/saving the dataset from/to the file.

Note

Users should never interact with this class.

Constructor & Destructor Documentation

BaseData()

fire::io::BaseData::BaseData ( const std::string &  path )

inlineexplicit

Define the full in-file path to the data set of this data.

Parameters

[in]

path

full in-file path to the data set

Member Function Documentation

clear()

virtual void fire::io::BaseData::clear ( )

pure virtual

pure virtual method for resetting the current data to a blank state

Implemented in fire::io::AbstractData< DataType >, fire::io::AbstractData< AtomicType >, fire::io::AbstractData< ParameterStorage >, fire::io::AbstractData< std::map< KeyType, ValType > >, and fire::io::AbstractData< std::vector< ContentType > >.

load()

virtual void fire::io::BaseData::load ( h5::Reader &  f )

pure virtual

pure virtual method for loading data from the input file

Parameters

[in]

f

h5::Reader to load from

Implemented in fire::io::Data< DataType, Enable >, fire::io::Data< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >, fire::io::Data< std::vector< ContentType > >, fire::io::Data< std::map< KeyType, ValType > >, fire::io::AbstractData< DataType >, fire::io::AbstractData< AtomicType >, fire::io::AbstractData< ParameterStorage >, fire::io::AbstractData< std::map< KeyType, ValType > >, fire::io::AbstractData< std::vector< ContentType > >, and fire::io::Data< ParameterStorage >.

save()

virtual void fire::io::BaseData::save ( Writer &  f )

pure virtual

pure virtual method for saving the current data

Parameters

[in]

f

Writer to write to

Implemented in fire::io::Data< DataType, Enable >, fire::io::Data< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >, fire::io::Data< std::vector< ContentType > >, fire::io::Data< std::map< KeyType, ValType > >, fire::io::AbstractData< DataType >, fire::io::AbstractData< AtomicType >, fire::io::AbstractData< ParameterStorage >, fire::io::AbstractData< std::map< KeyType, ValType > >, fire::io::AbstractData< std::vector< ContentType > >, and fire::io::Data< ParameterStorage >.

structure()

virtual void fire::io::BaseData::structure ( Writer &  f )

pure virtual

we should persist our hierarchy into the output file

Parameters

[in]

f

Writer to write to

Implemented in fire::io::Data< DataType, Enable >, fire::io::Data< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >, fire::io::Data< std::vector< ContentType > >, fire::io::Data< std::map< KeyType, ValType > >, fire::io::AbstractData< DataType >, fire::io::AbstractData< AtomicType >, fire::io::AbstractData< ParameterStorage >, fire::io::AbstractData< std::map< KeyType, ValType > >, fire::io::AbstractData< std::vector< ContentType > >, and fire::io::Data< ParameterStorage >.

---

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

• include/fire/io/AbstractData.h