evio::evioToStringConfig Class Reference

Configuration options for toString() method. More...

#include <evioUtil.hxx>

Public Member Functions
	evioToStringConfig ()
	No-arg constructor with no dictionary. More...
	evioToStringConfig (const evioDictionary *dictionary)
	Constructor accepts dictionary. More...
	evioToStringConfig (const evioDictionary &dictionary)
	Constructor accepts dictionary. More...
virtual	~evioToStringConfig ()=default
virtual void	setDictionary (const evioDictionary *dict)
virtual void	setDictionary (const evioDictionary &dict)
virtual const evioDictionary *	getDictionary () const
bool	skipNode (const evioDOMNodeP pNode) const
	Checks if bank tag/num is listed in include/exclude vectors by tag/num OR by name. More...

Public Attributes
bool	xtod
	True print unsigned values as decimal. More...
bool	noData
	True do not dump leaf node data. More...
int	maxDepth
	Max depth to dump. More...
int	indentSize
	Indent size per unit of depth. More...
bool	verbose
	Turn on verbose mode. More...
vector< uint16_t >	bankOk
	Vector of bank tags to dump. More...
vector< uint16_t >	noBank
	Vector of bank tags to skip. More...
vector< string >	bankNameOk
	Vector of bank names to dump. More...
vector< string >	noBankName
	Vector of bank names to skip. More...
const evioDictionary *	toStringDictionary
	Dictionary to use. More...

Protected Member Functions
void	init ()
	Initializes config. More...

Detailed Description

Configuration options for toString() method.

max_depth: depth to convert to, 0 means no limit, default 0. no_data: true to not dump data of leaf nodes, default false. indentSize indent size for increasing bank level depth, default 3 toStringDictionary dictionary to use, overrides default dictionary

Constructor & Destructor Documentation

evioToStringConfig() [1/3]

evioToStringConfig::evioToStringConfig

(

)

No-arg constructor with no dictionary.

evioToStringConfig() [2/3]

evioToStringConfig::evioToStringConfig

(

const evioDictionary *

dictionary

)

Constructor accepts dictionary.

Parameters

dictionary

evioDictionary

evioToStringConfig() [3/3]

evioToStringConfig::evioToStringConfig

(

const evioDictionary &

dictionary

)

Constructor accepts dictionary.

Parameters

dictionary

evioDictionary

~evioToStringConfig()

virtual evio::evioToStringConfig::~evioToStringConfig ( )

virtualdefault

Member Function Documentation

getDictionary()

virtual const evioDictionary* evio::evioToStringConfig::getDictionary ( ) const

inlinevirtual

init()

void evioToStringConfig::init ( )

protected

Initializes config.

setDictionary() [1/2]

virtual void evio::evioToStringConfig::setDictionary ( const evioDictionary &  dict )

inlinevirtual

setDictionary() [2/2]

virtual void evio::evioToStringConfig::setDictionary ( const evioDictionary *  dict )

inlinevirtual

Referenced by evio::evioDOMTree::toString().

skipNode()

bool evioToStringConfig::skipNode

(

const evioDOMNodeP

pNode

)

const

Checks if bank tag/num is listed in include/exclude vectors by tag/num OR by name.

Parameters

pNode

Node under consideration

Returns

true to skip this node

References evio::evioDOMNode::num, and evio::evioDOMNode::tag.

Member Data Documentation

bankNameOk

vector<string> evio::evioToStringConfig::bankNameOk

Vector of bank names to dump.

bankOk

vector<uint16_t> evio::evioToStringConfig::bankOk

Vector of bank tags to dump.

indentSize

int evio::evioToStringConfig::indentSize

Indent size per unit of depth.

Referenced by evio::evioCompositeDOMLeafNode::getBody(), evio::evioDOMContainerNode::getFooter(), and evio::evioDOMContainerNode::getHeader().

maxDepth

int evio::evioToStringConfig::maxDepth

Max depth to dump.

noBank

vector<uint16_t> evio::evioToStringConfig::noBank

Vector of bank tags to skip.

noBankName

vector<string> evio::evioToStringConfig::noBankName

Vector of bank names to skip.

noData

bool evio::evioToStringConfig::noData

True do not dump leaf node data.

toStringDictionary

const evioDictionary* evio::evioToStringConfig::toStringDictionary

Dictionary to use.

Referenced by evio::evioDOMContainerNode::getFooter(), evio::evioDOMContainerNode::getHeader(), and evio::evioDOMTree::toString().

verbose

bool evio::evioToStringConfig::verbose

Turn on verbose mode.

Referenced by evio::evioDOMContainerNode::getHeader().

xtod

bool evio::evioToStringConfig::xtod

True print unsigned values as decimal.

---

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

• evioUtil.hxx
• evioUtil.cc