evio  5.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
evio::evioCompositeDOMLeafNode Class Reference

Sub-class of evioDOMLeafNode<uint32_t> represents composite leaf node. More...

#include <evioUtil.hxx>

Inheritance diagram for evio::evioCompositeDOMLeafNode:
evio::evioDOMLeafNode< uint32_t > evio::evioDOMNode

Public Member Functions

virtual string getBody (int depth, const evioToStringConfig *config=&defaultToStringConfig) const
 Returns XML string containing body needed by toString. More...
 
virtual int getSize (void) const
 Returns numnber of data elements. More...
 
- Public Member Functions inherited from evio::evioDOMLeafNode< uint32_t >
virtual string getHeader (int depth, const evioToStringConfig *config=&defaultToStringConfig) const
 
virtual string getFooter (int depth, const evioToStringConfig *config=&defaultToStringConfig) const
 
- Public Member Functions inherited from evio::evioDOMNode
virtual ~evioDOMNode (void)
 
virtual void addNode (evioDOMNodeP node) throw (evioException)
 Adds node to container node. More...
 
void append (const string &s) throw (evioException)
 Appends string to leaf node. More...
 
void append (const char *s) throw (evioException)
 Appends const char* to leaf node. More...
 
void append (char *s) throw (evioException)
 Appends char* to leaf node. More...
 
void append (const char **ca, int len) throw (evioException)
 Appends array of const char* to leaf node. More...
 
void append (char **ca, int len) throw (evioException)
 Appends array of const char* to leaf node. More...
 
template<typename T >
void append (T tVal) throw (evioException)
 
template<typename T >
void append (const vector< T > &tVec) throw (evioException)
 
template<typename T >
void append (const T *tBuf, int len) throw (evioException)
 
template<typename T >
void replace (const vector< T > &tVec) throw (evioException)
 
template<typename T >
void replace (const T *tBuf, int len) throw (evioException)
 
virtual evioDOMNodeP cut (void) throw (evioException)
 Cleanly removes node from tree or node hierarchy. More...
 
virtual void cutAndDelete (void) throw (evioException)
 Cleanly removes node from tree or node hierarchy and recursively deletes node and its contents. More...
 
virtual evioDOMNodeP move (evioDOMNodeP newParent) throw (evioException)
 Changes node parent. More...
 
virtual bool operator== (uint16_t tag) const
 True if node tag equals value. More...
 
virtual bool operator!= (uint16_t tag) const
 True if node tag does not equal value. More...
 
bool operator== (evioDictEntry tnPair) const
 True if node tag and num same as in evioDictEntry pair. More...
 
bool operator!= (evioDictEntry tnPair) const
 True if node tag and num NOT the same as in evioDictEntry pair. More...
 
evioDOMNodeoperator<< (evioDOMNodeP node) throw (evioException)
 Adds node to container node. More...
 
evioDOMNodeoperator<< (const string &s) throw (evioException)
 Appends single string to leaf node. More...
 
evioDOMNodeoperator<< (const char *s) throw (evioException)
 Appends single const char* to leaf node. More...
 
evioDOMNodeoperator<< (char *s) throw (evioException)
 Appends single char* to leaf node. More...
 
template<typename T >
evioDOMNodeoperator<< (T tVal) throw (evioException)
 
template<typename T >
evioDOMNodeoperator<< (const vector< T > &tVec) throw (evioException)
 
evioDOMNodeListgetChildList (void) throw (evioException)
 Returns pointer to child list of container node. More...
 
evioDOMNodeListP getChildren (void) throw (evioException)
 Returns copy of child list of container node. More...
 
template<class Predicate >
evioDOMNodeListP getChildren (Predicate pred) throw (evioException)
 
template<typename T >
vector< T > * getVector (void) throw (evioException)
 
virtual string toString (void) const
 Returns XML string listing container node contents. More...
 
evioDOMNodeP getParent (void) const
 Returns parent evioDOMNode. More...
 
int getContentType (void) const
 Returns content type. More...
 
evioDOMTreegetParentTree (void) const
 Returns parent evioDOMTree. More...
 
bool isContainer (void) const
 True if node is a container node. More...
 
bool isLeaf (void) const
 True if node is a leaf node. More...
 

Public Attributes

uint16_t formatTag
 Tag to use for the internal format bank. More...
 
string formatString
 The format string. More...
 
uint16_t dataTag
 Tag to use for the internal data bank. More...
 
uint8_t dataNum
 Num to use for the internal data bank. More...
 
- Public Attributes inherited from evio::evioDOMLeafNode< uint32_t >
vector< uint32_t > data
 Vector<T> of node data. More...
 
- Public Attributes inherited from evio::evioDOMNode
uint16_t tag
 The node tag, max 16-bits depending on container type. More...
 
uint8_t num
 The node num, max 8 bits, used by BANK and String container types (2-word header). More...
 

Protected Member Functions

 evioCompositeDOMLeafNode (evioDOMNodeP par, uint16_t tag, uint8_t num, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const vector< uint32_t > &v) throw (evioException)
 Composite leaf node constructor used internally. More...
 
 evioCompositeDOMLeafNode (evioDOMNodeP par, uint16_t tag, uint8_t num, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const uint32_t *p, int ndata) throw (evioException)
 Composite leaf node constructor used internally. More...
 
 ~evioCompositeDOMLeafNode (void)
 
 evioCompositeDOMLeafNode (const evioCompositeDOMLeafNode &lNode) throw (evioException)
 
bool operator= (const evioCompositeDOMLeafNode &lNode)
 
- Protected Member Functions inherited from evio::evioDOMLeafNode< uint32_t >
 evioDOMLeafNode (evioDOMNodeP par, uint16_t tag, uint8_t num) throw (evioException)
 
 evioDOMLeafNode (evioDOMNodeP par, uint16_t tag, uint8_t num, const vector< uint32_t > &v) throw (evioException)
 
 evioDOMLeafNode (evioDOMNodeP par, uint16_t tag, uint8_t num, const uint32_t *p, int ndata) throw (evioException)
 
 evioDOMLeafNode (const evioDOMLeafNode< uint32_t > &lNode) throw (evioException)
 
virtual ~evioDOMLeafNode (void)
 
bool operator= (const evioDOMLeafNode< uint32_t > &lNode)
 
- Protected Member Functions inherited from evio::evioDOMNode
 evioDOMNode (evioDOMNodeP parent, uint16_t tag, uint8_t num, int contentType) throw (evioException)
 Container node constructor used internally. More...
 
 evioDOMNode (evioDOMNodeP parent, const string &name, const evioDictionary *dictionary, int contentType) throw (evioException)
 Container node constructor used internally. More...
 

Friends

class evioDOMNode
 Allows evioDOMNode to use private subclass methods. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from evio::evioDOMNode
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node. More...
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, const vector< T > &tVec) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, const T *t, int len) throw (evioException)
 
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, const evioSerializable &o, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node holding evioSerializable object. More...
 
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, void(*f)(evioDOMNodeP c, void *userArg), void *userArg, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node using C function to fill container. More...
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, T *t, void *userArg, ContainerType cType=BANK) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, T *t, void *T::*mfp(evioDOMNodeP c, void *userArg), void *userArg, ContainerType cType=BANK) throw (evioException)
 
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const vector< uint32_t > &tVec) throw (evioException)
 Static factory method to create composite leaf node. More...
 
static evioDOMNodeP createEvioDOMNode (uint16_t tag, uint8_t num, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const uint32_t *t, int len) throw (evioException)
 Static factory method to create composite leaf node. More...
 
static evioDOMNodeP createUnknownEvioDOMNode (uint16_t tag, uint8_t num, const vector< uint32_t > &tVec) throw (evioException)
 Unknown type node constructor used internally. More...
 
static evioDOMNodeP createUnknownEvioDOMNode (uint16_t tag, uint8_t num, const uint32_t *t, int len) throw (evioException)
 Unknown type node constructor used internally. More...
 
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node. More...
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, const vector< T > &tVec) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, const T *t, int len) throw (evioException)
 
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, const evioSerializable &o, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node holding evioSerializable object. More...
 
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, void(*f)(evioDOMNodeP c, void *userArg), void *userArg, ContainerType cType=BANK) throw (evioException)
 Static factory method to create container node using C function to fill container. More...
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, T *t, void *userArg, ContainerType cType=BANK) throw (evioException)
 
template<typename T >
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, T *t, void *T::*mfp(evioDOMNodeP c, void *userArg), void *userArg, ContainerType cType=BANK) throw (evioException)
 
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const vector< uint32_t > &tVec) throw (evioException)
 Static factory method to create composite leaf node. More...
 
static evioDOMNodeP createEvioDOMNode (const string &name, const evioDictionary *dictionary, uint16_t formatTag, const string &formatString, uint16_t dataTag, uint8_t dataNum, const uint32_t *t, int len) throw (evioException)
 Static factory method to create composite leaf node. More...
 
static evioDOMNodeP createUnknownEvioDOMNode (const string &name, const evioDictionary *dictionary, const vector< uint32_t > &tVec) throw (evioException)
 Unknown type node constructor used internally. More...
 
static evioDOMNodeP createUnknownEvioDOMNode (const string &name, const evioDictionary *dictionary, const uint32_t *t, int len) throw (evioException)
 Unknown type node constructor used internally. More...
 
- Static Protected Member Functions inherited from evio::evioDOMNode
static string getIndent (int depth, int size=3)
 Returns indent for pretty-printing, used internally. More...
 
- Protected Attributes inherited from evio::evioDOMNode
evioDOMNodeP parent
 Pointer to node parent. More...
 
evioDOMTreeparentTree
 Pointer to parent tree if this node is the root. More...
 
int contentType
 Content type. More...
 

Detailed Description

Sub-class of evioDOMLeafNode<uint32_t> represents composite leaf node.

Only accessible to users via pointer to evioDOMNode object.

Constructor & Destructor Documentation

evioCompositeDOMLeafNode::evioCompositeDOMLeafNode ( evioDOMNodeP  par,
uint16_t  tg,
uint8_t  num,
uint16_t  formatTag,
const string &  formatString,
uint16_t  dataTag,
uint8_t  dataNum,
const vector< uint32_t > &  v 
)
throw (evioException
)
protected

Composite leaf node constructor used internally.

Parameters
parParent node
tgNode tag
numNode num
evioCompositeDOMLeafNode::evioCompositeDOMLeafNode ( evioDOMNodeP  par,
uint16_t  tg,
uint8_t  num,
uint16_t  formatTag,
const string &  formatString,
uint16_t  dataTag,
uint8_t  dataNum,
const uint32_t *  p,
int  ndata 
)
throw (evioException
)
protected

Composite leaf node constructor used internally.

Parameters
parParent node
tgNode tag
numNode num
evioCompositeDOMLeafNode::~evioCompositeDOMLeafNode ( void  )
protected
evio::evioCompositeDOMLeafNode::evioCompositeDOMLeafNode ( const evioCompositeDOMLeafNode lNode)
throw (evioException
)
protected

Member Function Documentation

string evioCompositeDOMLeafNode::getBody ( int  depth,
const evioToStringConfig config = &defaultToStringConfig 
) const
virtual

Returns XML string containing body needed by toString.

Parameters
depthCurrent depth
Returns
XML string

Reimplemented from evio::evioDOMLeafNode< uint32_t >.

References evio::evioToStringConfig::indentSize.

int evioCompositeDOMLeafNode::getSize ( void  ) const
virtual

Returns numnber of data elements.

Returns
number of data elements

Reimplemented from evio::evioDOMLeafNode< uint32_t >.

bool evio::evioCompositeDOMLeafNode::operator= ( const evioCompositeDOMLeafNode lNode)
protected

Friends And Related Function Documentation

friend class evioDOMNode
friend

Allows evioDOMNode to use private subclass methods.

Member Data Documentation

uint8_t evio::evioCompositeDOMLeafNode::dataNum

Num to use for the internal data bank.

uint16_t evio::evioCompositeDOMLeafNode::dataTag

Tag to use for the internal data bank.

string evio::evioCompositeDOMLeafNode::formatString

The format string.

uint16_t evio::evioCompositeDOMLeafNode::formatTag

Tag to use for the internal format bank.


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