libpniio
Static Public Member Functions
pni::io::nx::xml::group Struct Reference

read and write groups

#include <group.hpp>

Static Public Member Functions

template<typename GTYPE , typename FTYPE , typename ATYPE , typename LTYPE >
static nxobject< GTYPE, FTYPE,
ATYPE, LTYPE > 
object_from_xml (const nxobject< GTYPE, FTYPE, ATYPE, LTYPE > &parent, const node &group_node)
 create group from XML More...
 
template<typename GTYPE , typename FTYPE , typename ATYPE , typename LTYPE >
static node object_to_xml (const nxobject< GTYPE, FTYPE, ATYPE, LTYPE > &group)
 write group to XML More...
 

Member Function Documentation

template<typename GTYPE , typename FTYPE , typename ATYPE , typename LTYPE >
static nxobject<GTYPE,FTYPE,ATYPE,LTYPE> pni::io::nx::xml::group::object_from_xml ( const nxobject< GTYPE, FTYPE, ATYPE, LTYPE > &  parent,
const node group_node 
)
inlinestatic
Exceptions
parser_errorin case of parsing problems
invalid_object_errorif the parent is not valid
parser_errorif the content of the group node is illformed and cannot be parsed
io_errorif metadadata writing failed
key_errorif the group already exists or the name is otherwise invalid.
object_errorin case of any other error
Template Parameters
GTYPEgroup type
FTYPEfield type
ATYPEattribute type
LTYPElink type
Parameters
parentthe parent group of the new group
group_nodethe node storing the group data
Returns
group instance
template<typename GTYPE , typename FTYPE , typename ATYPE , typename LTYPE >
static node pni::io::nx::xml::group::object_to_xml ( const nxobject< GTYPE, FTYPE, ATYPE, LTYPE > &  group)
inlinestatic

Create an XML group from a Nexus group.

Exceptions
parser_errorin case of problems parsing required XML attributes
type_errorif the passed type is not a group type
io_errorif retrievel of group properties failed
invalid_object_errorif the group is not valid
object_errorin case of any other error
Template Parameters
GTYPEgroup type
Parameters
groupinstance of GTYPE
Returns
node with group information

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