hdtree::BaseBranch Class Reference

Empty data base allowing recursion. More...

#include <AbstractBranch.h>

Inheritance diagram for hdtree::BaseBranch:

Collaboration diagram for hdtree::BaseBranch:

Public Member Functions
	BaseBranch (const std::string &full_name)
	define the full name of the branch
virtual	~BaseBranch ()=default
	virtual destructor so inherited classes can be properly destructed.
virtual void	attach (Reader &f)=0
	pure virtual method for loading data from the input file More...
virtual void	load ()=0
virtual void	attach (Writer &f)=0
	we should persist our hierarchy into the output file More...
virtual void	save ()=0
	pure virtual method for saving the current data More...
virtual void	clear ()=0
	pure virtual method for resetting the current data to a blank state
	BaseBranch (const BaseBranch &)=delete
	no copying
BaseBranch &	operator= (const BaseBranch &)=delete
	no copying

Protected Attributes
std::string	name_
	name of branch

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.

Member Function Documentation

attach() [1/2]

virtual void hdtree::BaseBranch::attach ( Reader &  f )

pure virtual

pure virtual method for loading data from the input file

Parameters

[in]

f

Reader to load from

Implemented in hdtree::AbstractBranch< DataType >, hdtree::AbstractBranch< AtomicType >, hdtree::AbstractBranch< std::map< KeyType, ValType > >, hdtree::AbstractBranch< std::vector< ContentType > >, hdtree::Branch< std::vector< ContentType > >, hdtree::Branch< std::map< KeyType, ValType > >, hdtree::Branch< DataType, Enable >, hdtree::Branch< ValType >, hdtree::Branch< std::size_t >, hdtree::Branch< KeyType >, hdtree::Branch< ContentType >, and hdtree::Branch< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >.

attach() [2/2]

virtual void hdtree::BaseBranch::attach ( Writer &  f )

pure virtual

we should persist our hierarchy into the output file

Parameters

[in]

f

Writer to write to

Implemented in hdtree::AbstractBranch< DataType >, hdtree::AbstractBranch< AtomicType >, hdtree::AbstractBranch< std::map< KeyType, ValType > >, hdtree::AbstractBranch< std::vector< ContentType > >, hdtree::Branch< std::vector< ContentType > >, hdtree::Branch< std::map< KeyType, ValType > >, hdtree::Branch< DataType, Enable >, hdtree::Branch< ValType >, hdtree::Branch< std::size_t >, hdtree::Branch< KeyType >, hdtree::Branch< ContentType >, and hdtree::Branch< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >.

save()

virtual void hdtree::BaseBranch::save ( )

pure virtual

pure virtual method for saving the current data

Parameters

[in]

f

Writer to write to

Implemented in hdtree::AbstractBranch< DataType >, hdtree::AbstractBranch< AtomicType >, hdtree::AbstractBranch< std::map< KeyType, ValType > >, hdtree::AbstractBranch< std::vector< ContentType > >, hdtree::Branch< std::vector< ContentType > >, hdtree::Branch< std::map< KeyType, ValType > >, hdtree::Branch< DataType, Enable >, hdtree::Branch< ValType >, hdtree::Branch< std::size_t >, hdtree::Branch< KeyType >, hdtree::Branch< ContentType >, and hdtree::Branch< AtomicType, std::enable_if_t< is_atomic_v< AtomicType > > >.

---

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

• cpp/include/hdtree/AbstractBranch.h