areaDetector  3-12-1
EPICS areaDetector framework
Public Member Functions | List of all members
hdf5::Root Class Reference

Class used for writing the root of the file with the NDFileHDF5 plugin. More...

#include <NDFileHDF5Layout.h>

Inheritance diagram for hdf5::Root:
hdf5::Group hdf5::Element

Public Member Functions

 Root ()
 
 Root (const std::string &name)
 
 Root (const char *name)
 
virtual ~Root ()
 
virtual void merge_ndattributes (MapNDAttrSrc_t::const_iterator it_begin, MapNDAttrSrc_t::const_iterator it_end, std::set< std::string > &used_ndattribute_srcs)
 
std::string get_full_name ()
 
std::string get_path (bool trailing_slash=false)
 
- Public Member Functions inherited from hdf5::Group
 Group ()
 
 Group (const std::string &name)
 
 Group (const char *name)
 
 Group (const Group &src)
 
virtual ~Group ()
 
Groupoperator= (const Group &src)
 
Datasetnew_dset (const std::string &name)
 
Datasetnew_dset (const char *name)
 
Groupnew_group (const std::string &name)
 Create a new group, insert it into the group list, set the full path name, and finally return a pointer to the newly created object. More...
 
Groupnew_group (const char *name)
 
HardLinknew_hardlink (const std::string &name)
 Create a new HardLink, insert it into the group list, set the full path name, and finally return a pointer to the newly created object. More...
 
HardLinknew_hardlink (const char *name)
 
int find_dset_ndattr (const std::string &ndattr_name, Dataset **dset)
 
int find_dset_ndattr (const char *ndattr_name, Dataset **dset)
 << Find and return a reference to the dataset for a given NDAttribute More...
 
int find_dset (std::string &dsetname, Dataset **dest)
 
int find_dset (const char *dsetname, Dataset **dest)
 
void set_default_ndattr_group ()
 
Groupfind_ndattr_default_group ()
 
int find_detector_default_dset (Dataset **dset)
 << search through subgroups to return a pointer to the NDAttribute default container group More...
 
int num_groups ()
 
int num_datasets ()
 
std::string _str_ ()
 
MapGroups_tget_groups ()
 
MapDatasets_tget_datasets ()
 
MapHardLinks_tget_hardlinks ()
 
void find_dsets (DataSrc_t source, MapDatasets_t &dsets)
 
- Public Member Functions inherited from hdf5::Element
 Element ()
 
 Element (const Element &src)
 
 Element (const std::string &name)
 
 ~Element ()
 
Elementoperator= (const Element &src)
 
const std::string & get_name ()
 
int add_attribute (Attribute &attr)
 
bool has_attribute (const std::string &attr_name)
 
int tree_level ()
 
Elementget_parent ()
 
MapAttributes_tget_attributes ()
 

Additional Inherited Members

- Public Types inherited from hdf5::Group
typedef std::map< std::string, Group * > MapGroups_t
 Return a string representation of the object. More...
 
typedef std::map< std::string, Dataset * > MapDatasets_t
 
typedef std::map< std::string, HardLink * > MapHardLinks_t
 
typedef std::map< std::string, DataSource * > MapNDAttrSrc_t
 return a map of datasets [string name, Dataset dset] which contains all datasets, marked as [source] data. More...
 
- Public Types inherited from hdf5::Element
typedef std::map< std::string, AttributeMapAttributes_t
 
- Protected Member Functions inherited from hdf5::Element
void _copy (const Element &src)
 
- Protected Attributes inherited from hdf5::Element
MapAttributes_t attributes
 
std::string name
 

Detailed Description

Class used for writing the root of the file with the NDFileHDF5 plugin.

Constructor & Destructor Documentation

◆ Root() [1/3]

hdf5::Root::Root ( )

◆ Root() [2/3]

hdf5::Root::Root ( const std::string &  name)

◆ Root() [3/3]

hdf5::Root::Root ( const char *  name)

◆ ~Root()

virtual hdf5::Root::~Root ( )
inlinevirtual

Member Function Documentation

◆ get_full_name()

std::string hdf5::Root::get_full_name ( )
inlinevirtual

Reimplemented from hdf5::Element.

◆ get_path()

std::string hdf5::Root::get_path ( bool  trailing_slash = false)
inlinevirtual

Reimplemented from hdf5::Element.

◆ merge_ndattributes()

void hdf5::Root::merge_ndattributes ( MapNDAttrSrc_t::const_iterator  it_begin,
MapNDAttrSrc_t::const_iterator  it_end,
std::set< std::string > &  used_ndattribute_srcs 
)
virtual

Reimplemented from hdf5::Group.


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