A node of a tree structure holding a configuration, where each node may be given attributes, and a node inherits the attributes of parent nodes if those attributes are not redefined. More...

#include <MiniConfigTreeNode.h>

Inheritance diagram for dqi::MiniConfigTreeNode:

Collaboration diagram for dqi::MiniConfigTreeNode:

Classes
class	Visitor
class	Writer

Public Member Functions
	MiniConfigTreeNode (std::string name_, MiniConfigTreeNode *parent_)
virtual	~MiniConfigTreeNode ()
virtual const char *	GetName () const
virtual std::string	GetPathName () const
virtual MiniConfigTreeNode *	GetNewDaughter (std::string name_)
	Returns a daughter of this node, creating one if necessary.
virtual MiniConfigTreeNode *	GetDaughter (std::string name_) const
virtual const MiniConfigTreeNode *	GetParent () const
virtual MiniConfigTreeNode *	GetParent ()
virtual std::map< std::string, dqi::MiniConfigTreeNode * >	GetDaughters () const
virtual const MiniConfigTreeNode *	GetNode (const std::string &name_) const
	This function takes the full path name of a subnode (in UNIX directory style) and returns the corresponding subnode of this node, traversing the entire subtree until it is found.
virtual void	SetAttribute (const std::string &attName, const std::string &attValue, bool isAttribKeyword=false)
virtual std::string	GetAttribute (const std::string &attName, bool calledFromDaughter=false) const
virtual std::string	GetAttributeLocal (const std::string &attName) const
virtual void	GetAttributeNames (std::set< std::string > &attSet, bool calledFromDaughter=false) const
virtual void	GetAttributeNamesLocal (std::set< std::string > &attSet) const
virtual void	Accept (Visitor &visitor) const
virtual void	Accept (Writer &writer)
virtual void	SetAttribKeywordPropagateDown (bool propagateDown)
virtual bool	GetAttribKeywordPropagateDown () const

Protected Types
typedef std::map< std::string, MiniConfigTreeNode * >	NodeMap_t
typedef NodeMap_t::const_iterator	NodeIter_t
typedef std::map< std::string, std::pair< std::string, bool > >	AttMap_t
typedef AttMap_t::const_iterator	AttIter_t

Protected Attributes
const std::string	m_name
MiniConfigTreeNode *	m_parent {}
NodeMap_t	m_daughters
AttMap_t	m_attributes
bool	m_propagateDown {}

Detailed Description

A node of a tree structure holding a configuration, where each node may be given attributes, and a node inherits the attributes of parent nodes if those attributes are not redefined.

Author: Michael Wilson, CERN, March 2007

Definition at line 25 of file MiniConfigTreeNode.h.

Member Typedef Documentation

◆ AttIter_t

typedef AttMap_t::const_iterator dqi::MiniConfigTreeNode::AttIter_t

protected

Definition at line 98 of file MiniConfigTreeNode.h.

◆ AttMap_t

typedef std::map<std::string,std::pair<std::string,bool> > dqi::MiniConfigTreeNode::AttMap_t

protected

Definition at line 97 of file MiniConfigTreeNode.h.

◆ NodeIter_t

typedef NodeMap_t::const_iterator dqi::MiniConfigTreeNode::NodeIter_t

protected

Definition at line 95 of file MiniConfigTreeNode.h.

◆ NodeMap_t

typedef std::map<std::string,MiniConfigTreeNode*> dqi::MiniConfigTreeNode::NodeMap_t

protected

Definition at line 94 of file MiniConfigTreeNode.h.

Constructor & Destructor Documentation

◆ MiniConfigTreeNode()

dqi::MiniConfigTreeNode::MiniConfigTreeNode	(	std::string	name_,
		MiniConfigTreeNode *	parent_ )

Definition at line 25 of file MiniConfigTreeNode.cxx.

  : m_name(std::move(name_))
  , m_parent(parent_)
  , m_propagateDown(true)
{
}

◆ ~MiniConfigTreeNode()

dqi::MiniConfigTreeNode::~MiniConfigTreeNode ( )

virtual

Definition at line 34 of file MiniConfigTreeNode.cxx.

{
  NodeIter_t daugEnd = m_daughters.end();
  for( NodeIter_t i = m_daughters.begin(); i != daugEnd; ++i ) {
    MiniConfigTreeNode* inode = i->second;
    delete inode;
  }
}

Member Function Documentation

◆ Accept() [1/2]

void dqi::MiniConfigTreeNode::Accept ( Visitor & visitor ) const

virtual

Definition at line 207 of file MiniConfigTreeNode.cxx.

{
  visitor.Visit(this);
  NodeIter_t daugEnd = m_daughters.end();
  for( NodeIter_t i = m_daughters.begin(); i != daugEnd; ++i ) {
    MiniConfigTreeNode* node = i->second;
    node->Accept(visitor);
  }
}

◆ Accept() [2/2]

void dqi::MiniConfigTreeNode::Accept ( Writer & writer )

virtual

Definition at line 219 of file MiniConfigTreeNode.cxx.

{
  writer.Write(this);
  NodeIter_t daugEnd = m_daughters.end();
  for( NodeIter_t i = m_daughters.begin(); i != daugEnd; ++i ) {
    MiniConfigTreeNode* node = i->second;
    node->Accept(writer);
  }
}

◆ GetAttribKeywordPropagateDown()

bool dqi::MiniConfigTreeNode::GetAttribKeywordPropagateDown ( ) const

virtual

Definition at line 238 of file MiniConfigTreeNode.cxx.

{
  return this->m_propagateDown;
}

◆ GetAttribute()

std::string dqi::MiniConfigTreeNode::GetAttribute	(	const std::string &	attName,
		bool	calledFromDaughter = false ) const

virtual

Definition at line 147 of file MiniConfigTreeNode.cxx.

{
  AttIter_t i = m_attributes.find( attName );
  if( i == m_attributes.end() ) {
    if( m_parent != 0 )
      return m_parent->GetAttribute( attName, true );
    else
      return std::string("");
  }
  if (calledFromDaughter && ! m_propagateDown && i->second.second) {
      return std::string("");
  }
  return i->second.first;
}

◆ GetAttributeLocal()

std::string dqi::MiniConfigTreeNode::GetAttributeLocal ( const std::string & attName ) const

virtual

Definition at line 166 of file MiniConfigTreeNode.cxx.

{
  AttIter_t i = m_attributes.find( attName );
  if( i == m_attributes.end() ) {
    return std::string("");
  }
  return i->second.first;
}

◆ GetAttributeNames()

void dqi::MiniConfigTreeNode::GetAttributeNames	(	std::set< std::string > &	attSet,
		bool	calledFromDaughter = false ) const

virtual

Definition at line 178 of file MiniConfigTreeNode.cxx.

{
  if( m_parent !=0 ) {
    m_parent->GetAttributeNames( attSet, true );
  }
  AttIter_t attEnd = m_attributes.end();
  for( AttIter_t i = m_attributes.begin(); i != attEnd; ++i ) {
    if (calledFromDaughter && ! m_propagateDown && i->second.second) {
    } else {
      std::set<std::string>::value_type setVal( i->first );
      attSet.insert( std::move(setVal) );
    }
  }
}

◆ GetAttributeNamesLocal()

void dqi::MiniConfigTreeNode::GetAttributeNamesLocal ( std::set< std::string > & attSet ) const

virtual

Definition at line 196 of file MiniConfigTreeNode.cxx.

{
  AttIter_t attEnd = m_attributes.end();
  for( AttIter_t i = m_attributes.begin(); i != attEnd; ++i ) {
    std::set<std::string>::value_type setVal( i->first );
    attSet.insert( std::move(setVal) );
  }
}

◆ GetDaughter()

MiniConfigTreeNode * dqi::MiniConfigTreeNode::GetDaughter ( std::string name_ ) const

virtual

Definition at line 88 of file MiniConfigTreeNode.cxx.

{
  NodeIter_t i = m_daughters.find( name_ );
  if( i != m_daughters.end() ) {
    return i->second;
  }
  return 0;
}

◆ GetDaughters()

std::map< std::string, MiniConfigTreeNode * > dqi::MiniConfigTreeNode::GetDaughters ( ) const

virtual

Definition at line 100 of file MiniConfigTreeNode.cxx.

{
  return m_daughters;
}

◆ GetName()

const char * dqi::MiniConfigTreeNode::GetName ( ) const

virtual

Definition at line 46 of file MiniConfigTreeNode.cxx.

{
  return m_name.c_str();
}

◆ GetNewDaughter()

MiniConfigTreeNode * dqi::MiniConfigTreeNode::GetNewDaughter ( std::string name_ )

virtual

Returns a daughter of this node, creating one if necessary.

This method only returns daughters, not granddaughters.

Definition at line 71 of file MiniConfigTreeNode.cxx.

{
  NodeIter_t i = m_daughters.find( name_ );
  if( i != m_daughters.end() ) {
    return i->second;
  }
 
  MiniConfigTreeNode* node = new MiniConfigTreeNode( name_, this );
  node->SetAttribKeywordPropagateDown(this->m_propagateDown);
  NodeMap_t::value_type nodeVal( name_, node );
  m_daughters.insert( std::move(nodeVal) );
  return node;
}

◆ GetNode()

const MiniConfigTreeNode * dqi::MiniConfigTreeNode::GetNode ( const std::string & name_ ) const

virtual

This function takes the full path name of a subnode (in UNIX directory style) and returns the corresponding subnode of this node, traversing the entire subtree until it is found.

If the bottom of the tree is reached before the full path has been used, the last node found is returned. If any part of the path is invalid before reaching the end of the tree, 0 is returned.

Definition at line 107 of file MiniConfigTreeNode.cxx.

{
  if( m_daughters.size() == 0 ) {
    return this;
  }
 
  std::string::size_type k = name_.find_first_of('/');
  if( k != std::string::npos ) {
    std::string dName( name_, 0, k );
    std::string pName( name_, k+1, std::string::npos );
    if( dName != "" ) {
      NodeIter_t i = m_daughters.find( dName );
      if( i == m_daughters.end() ) {
        return this;
      }
      MiniConfigTreeNode* node = i->second;
      return node->GetNode( pName );
    }
    return GetNode( pName );
  }
 
  NodeIter_t i = m_daughters.find( name_ );
  if( i == m_daughters.end() ) {
    return this;
  }
  return i->second;
}

◆ GetParent() [1/2]

virtual MiniConfigTreeNode * dqi::MiniConfigTreeNode::GetParent ( )

inlinevirtual

Definition at line 59 of file MiniConfigTreeNode.h.

59{ return m_parent; }

◆ GetParent() [2/2]

virtual const MiniConfigTreeNode * dqi::MiniConfigTreeNode::GetParent ( ) const

inlinevirtual

Definition at line 58 of file MiniConfigTreeNode.h.

58{ return m_parent; }

◆ GetPathName()

std::string dqi::MiniConfigTreeNode::GetPathName ( ) const

virtual

Definition at line 54 of file MiniConfigTreeNode.cxx.

{
  std::string path;
  if( m_parent != 0 ) {
    std::string parentPath( m_parent->GetPathName() );
    if( !parentPath.empty() ) {
      path += parentPath;
      path += std::string("/");
    }
    path += m_name;
  }
  return path;
}

◆ SetAttribKeywordPropagateDown()

void dqi::MiniConfigTreeNode::SetAttribKeywordPropagateDown ( bool propagateDown )

virtual

Definition at line 231 of file MiniConfigTreeNode.cxx.

{
  this->m_propagateDown = propagateDown;
}

◆ SetAttribute()

void dqi::MiniConfigTreeNode::SetAttribute	(	const std::string &	attName,
		const std::string &	attValue,
		bool	isAttribKeyword = false )

virtual

Definition at line 138 of file MiniConfigTreeNode.cxx.

{
    AttMap_t::value_type attMapVal( attName, AttMap_t::mapped_type(attValue, isAttribKeyword) );
  m_attributes.insert( std::move(attMapVal) );
}

Member Data Documentation

◆ m_attributes

AttMap_t dqi::MiniConfigTreeNode::m_attributes

protected

Definition at line 104 of file MiniConfigTreeNode.h.

◆ m_daughters

NodeMap_t dqi::MiniConfigTreeNode::m_daughters

protected

Definition at line 103 of file MiniConfigTreeNode.h.

◆ m_name

const std::string dqi::MiniConfigTreeNode::m_name

protected

Definition at line 100 of file MiniConfigTreeNode.h.

◆ m_parent

MiniConfigTreeNode* dqi::MiniConfigTreeNode::m_parent {}

protected

Definition at line 101 of file MiniConfigTreeNode.h.

101{};

◆ m_propagateDown

bool dqi::MiniConfigTreeNode::m_propagateDown {}

protected

Definition at line 106 of file MiniConfigTreeNode.h.

106{};

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

Classes

Public Member Functions

Protected Types

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ AttIter_t

◆ AttMap_t

◆ NodeIter_t

◆ NodeMap_t

Constructor & Destructor Documentation

◆ MiniConfigTreeNode()

◆ ~MiniConfigTreeNode()

Member Function Documentation

◆ Accept() [1/2]

◆ Accept() [2/2]

◆ GetAttribKeywordPropagateDown()

◆ GetAttribute()

◆ GetAttributeLocal()

◆ GetAttributeNames()

◆ GetAttributeNamesLocal()

◆ GetDaughter()

◆ GetDaughters()

◆ GetName()

◆ GetNewDaughter()

◆ GetNode()

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPathName()

◆ SetAttribKeywordPropagateDown()

◆ SetAttribute()

Member Data Documentation

◆ m_attributes

◆ m_daughters

◆ m_name

◆ m_parent

◆ m_propagateDown