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

Used to define layout of HDF5 file with NDFileHDF5 plugin. More...

#include <NDFileHDF5LayoutXML.h>

Public Member Functions

 LayoutXML ()
 
 ~LayoutXML ()
 
int load_xml ()
 
int load_xml (const std::string &filename)
 
int verify_xml (const std::string &filename)
 
int unload_xml ()
 Free all resources and reset the xml tree. More...
 
Rootget_hdftree ()
 
std::string get_global (const std::string &name)
 
bool getAutoNDAttrDefault ()
 

Static Public Attributes

static const std::string ATTR_ELEMENT_NAME = "name"
 
static const std::string ATTR_ROOT = "hdf5_layout"
 
static const std::string ATTR_GROUP = "group"
 
static const std::string ATTR_DATASET = "dataset"
 
static const std::string ATTR_ATTRIBUTE = "attribute"
 
static const std::string ATTR_GLOBAL = "global"
 
static const std::string ATTR_HARDLINK = "hardlink"
 
static const std::string ATTR_ROOT_NDATTR_DEFAULT = "auto_ndattr_default"
 
static const std::string ATTR_SOURCE = "source"
 
static const std::string ATTR_SRC_DETECTOR = "detector"
 
static const std::string ATTR_SRC_DET_DEFAULT = "det_default"
 
static const std::string ATTR_SRC_NDATTR = "ndattribute"
 
static const std::string ATTR_SRC_CONST = "constant"
 
static const std::string ATTR_SRC_CONST_VALUE = "value"
 
static const std::string ATTR_SRC_CONST_TYPE = "type"
 
static const std::string ATTR_GRP_NDATTR_DEFAULT = "ndattr_default"
 
static const std::string ATTR_SRC_WHEN = "when"
 
static const std::string ATTR_GLOBAL_NAME = "name"
 
static const std::string ATTR_GLOBAL_VALUE = "ndattribute"
 
static const std::string ATTR_HARDLINK_NAME = "name"
 
static const std::string ATTR_HARDLINK_TARGET = "target"
 
static const std::string DEFAULT_LAYOUT
 

Detailed Description

Used to define layout of HDF5 file with NDFileHDF5 plugin.

Constructor & Destructor Documentation

◆ LayoutXML()

hdf5::LayoutXML::LayoutXML ( )

◆ ~LayoutXML()

hdf5::LayoutXML::~LayoutXML ( )

Member Function Documentation

◆ get_global()

std::string hdf5::LayoutXML::get_global ( const std::string &  name)

◆ get_hdftree()

Root * hdf5::LayoutXML::get_hdftree ( )

◆ getAutoNDAttrDefault()

bool hdf5::LayoutXML::getAutoNDAttrDefault ( )

◆ load_xml() [1/2]

int hdf5::LayoutXML::load_xml ( )

◆ load_xml() [2/2]

int hdf5::LayoutXML::load_xml ( const std::string &  filename)

◆ unload_xml()

int hdf5::LayoutXML::unload_xml ( )

Free all resources and reset the xml tree.

◆ verify_xml()

int hdf5::LayoutXML::verify_xml ( const std::string &  filename)

Member Data Documentation

◆ ATTR_ATTRIBUTE

const std::string hdf5::LayoutXML::ATTR_ATTRIBUTE = "attribute"
static

◆ ATTR_DATASET

const std::string hdf5::LayoutXML::ATTR_DATASET = "dataset"
static

◆ ATTR_ELEMENT_NAME

const std::string hdf5::LayoutXML::ATTR_ELEMENT_NAME = "name"
static

◆ ATTR_GLOBAL

const std::string hdf5::LayoutXML::ATTR_GLOBAL = "global"
static

◆ ATTR_GLOBAL_NAME

const std::string hdf5::LayoutXML::ATTR_GLOBAL_NAME = "name"
static

◆ ATTR_GLOBAL_VALUE

const std::string hdf5::LayoutXML::ATTR_GLOBAL_VALUE = "ndattribute"
static

◆ ATTR_GROUP

const std::string hdf5::LayoutXML::ATTR_GROUP = "group"
static

◆ ATTR_GRP_NDATTR_DEFAULT

const std::string hdf5::LayoutXML::ATTR_GRP_NDATTR_DEFAULT = "ndattr_default"
static

◆ ATTR_HARDLINK

const std::string hdf5::LayoutXML::ATTR_HARDLINK = "hardlink"
static

◆ ATTR_HARDLINK_NAME

const std::string hdf5::LayoutXML::ATTR_HARDLINK_NAME = "name"
static

◆ ATTR_HARDLINK_TARGET

const std::string hdf5::LayoutXML::ATTR_HARDLINK_TARGET = "target"
static

◆ ATTR_ROOT

const std::string hdf5::LayoutXML::ATTR_ROOT = "hdf5_layout"
static

◆ ATTR_ROOT_NDATTR_DEFAULT

const std::string hdf5::LayoutXML::ATTR_ROOT_NDATTR_DEFAULT = "auto_ndattr_default"
static

◆ ATTR_SOURCE

const std::string hdf5::LayoutXML::ATTR_SOURCE = "source"
static

◆ ATTR_SRC_CONST

const std::string hdf5::LayoutXML::ATTR_SRC_CONST = "constant"
static

◆ ATTR_SRC_CONST_TYPE

const std::string hdf5::LayoutXML::ATTR_SRC_CONST_TYPE = "type"
static

◆ ATTR_SRC_CONST_VALUE

const std::string hdf5::LayoutXML::ATTR_SRC_CONST_VALUE = "value"
static

◆ ATTR_SRC_DET_DEFAULT

const std::string hdf5::LayoutXML::ATTR_SRC_DET_DEFAULT = "det_default"
static

◆ ATTR_SRC_DETECTOR

const std::string hdf5::LayoutXML::ATTR_SRC_DETECTOR = "detector"
static

◆ ATTR_SRC_NDATTR

const std::string hdf5::LayoutXML::ATTR_SRC_NDATTR = "ndattribute"
static

◆ ATTR_SRC_WHEN

const std::string hdf5::LayoutXML::ATTR_SRC_WHEN = "when"
static

◆ DEFAULT_LAYOUT

const std::string hdf5::LayoutXML::DEFAULT_LAYOUT
static
Initial value:
= " \
<group name=\"entry\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXentry\" type=\"string\"></attribute> \
<group name=\"instrument\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXinstrument\" type=\"string\"></attribute> \
<group name=\"detector\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXdetector\" type=\"string\"></attribute> \
<dataset name=\"data\" source=\"detector\" det_default=\"true\"> \
<attribute name=\"signal\" source=\"constant\" value=\"1\" type=\"int\"></attribute> \
</dataset> \
<group name=\"NDAttributes\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXcollection\" type=\"string\"></attribute> \
<dataset name=\"ColorMode\" source=\"ndattribute\" ndattribute=\"ColorMode\"> \
</dataset> \
</group> <!-- end group NDAttribute --> \
</group> <!-- end group detector --> \
<group name=\"NDAttributes\" ndattr_default=\"true\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXcollection\" type=\"string\"></attribute> \
</group> <!-- end group NDAttribute (default) --> \
<group name=\"performance\"> \
<dataset name=\"timestamp\"></dataset> \
</group> <!-- end group performance --> \
</group> <!-- end group instrument --> \
<group name=\"data\"> \
<attribute name=\"NX_class\" source=\"constant\" value=\"NXdata\" type=\"string\"></attribute> \
<hardlink name=\"data\" target=\"/entry/instrument/detector/data\"></hardlink> \
</group> <!-- end group data --> \
</group> <!-- end group entry --> "

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