bes::CatalogNode Class Reference

Inheritance diagram for bes::CatalogNode:

Collaboration diagram for bes::CatalogNode:

Public Types
typedef std::vector< CatalogItem * >::const_iterator	item_citer
typedef std::vector< CatalogItem * >::iterator	item_iter

Public Member Functions
void	add_leaf (CatalogItem *leaf)
	Add information about an leaf that is in this node of the catalog.
void	add_node (CatalogItem *node)
	Add information about an node that is in this node of the catalog.
	CatalogNode ()
	Make an empty instance.
	CatalogNode (const std::string &name)
virtual void	dump (std::ostream &strm) const
void	encode_node (BESInfo *info)
	Encode this CatalogNode in an info object.
std::string	get_catalog_name () const
	The name of the catalog.
size_t	get_item_count () const
CatalogItem *	get_leaf () const
size_t	get_leaf_count () const
	How many leaves are in this node of the catalog?
std::string	get_lmt () const
	Get the last modified time for this node.
std::string	get_name () const
	The name of this node in the catalog.
size_t	get_node_count () const
	How many nodes are in this node of the catalog?
item_iter	leaves_begin ()
item_iter	leaves_end ()
item_iter	nodes_begin ()
item_iter	nodes_end ()
void	set_catalog_name (std::string cn)
	Set the name of the catalog.
void	set_leaf (CatalogItem *leaf)
void	set_lmt (std::string lmt)
	Set the LMT for this node.
void	set_name (std::string n)
	Set the name of the catalog's node.

Detailed Description

Definition at line 45 of file CatalogNode.h.

Member Typedef Documentation

item_citer

typedef std::vector<CatalogItem*>::const_iterator bes::CatalogNode::item_citer

Definition at line 94 of file CatalogNode.h.

item_iter

typedef std::vector<CatalogItem*>::iterator bes::CatalogNode::item_iter

Definition at line 95 of file CatalogNode.h.

Constructor & Destructor Documentation

CatalogNode() [1/2]

bes::CatalogNode::CatalogNode ( )

inline

Make an empty instance.

Definition at line 69 of file CatalogNode.h.

CatalogNode() [2/2]

bes::CatalogNode::CatalogNode ( const std::string & name )

inline

Definition at line 71 of file CatalogNode.h.

~CatalogNode()

CatalogNode::~CatalogNode ( )

virtual

Definition at line 43 of file CatalogNode.cc.

Member Function Documentation

add_leaf()

void bes::CatalogNode::add_leaf ( CatalogItem * leaf )

inline

Add information about an leaf that is in this node of the catalog.

Definition at line 124 of file CatalogNode.h.

add_node()

void bes::CatalogNode::add_node ( CatalogItem * node )

inline

Add information about an node that is in this node of the catalog.

Definition at line 116 of file CatalogNode.h.

dump()

void CatalogNode::dump ( std::ostream & strm ) const

virtual

Dump out information about this object

Parameters

strm	Write to this stream

Implements BESObj.

Definition at line 123 of file CatalogNode.cc.

encode_node()

void CatalogNode::encode_node

(

BESInfo *

info

)

Encode this CatalogNode in an info object.

A CatalogNode is encoded as XML using the following grammar, where XML attributes in square brackets are optional.

<node name="path" catalog="catalog name" lastModified="date T time"
      count="number of child nodes" >

The <node> element may contain zero or more <leaf> elements.

Parameters

info	Add information to this instance of BESInfo.

See also

CatalogItem::encode_item()

Definition at line 79 of file CatalogNode.cc.

get_catalog_name()

std::string bes::CatalogNode::get_catalog_name ( ) const

inline

The name of the catalog.

Definition at line 85 of file CatalogNode.h.

get_item_count()

size_t bes::CatalogNode::get_item_count ( ) const

inline

Definition at line 111 of file CatalogNode.h.

get_leaf()

CatalogItem * bes::CatalogNode::get_leaf ( ) const

inline

Definition at line 77 of file CatalogNode.h.

get_leaf_count()

size_t bes::CatalogNode::get_leaf_count ( ) const

inline

How many leaves are in this node of the catalog?

Definition at line 122 of file CatalogNode.h.

get_lmt()

std::string bes::CatalogNode::get_lmt ( ) const

inline

Get the last modified time for this node.

Definition at line 90 of file CatalogNode.h.

get_name()

std::string bes::CatalogNode::get_name ( ) const

inline

The name of this node in the catalog.

Definition at line 80 of file CatalogNode.h.

get_node_count()

size_t bes::CatalogNode::get_node_count ( ) const

inline

How many nodes are in this node of the catalog?

Definition at line 114 of file CatalogNode.h.

leaves_begin()

item_iter bes::CatalogNode::leaves_begin ( )

inline

Definition at line 118 of file CatalogNode.h.

leaves_end()

item_iter bes::CatalogNode::leaves_end ( )

inline

Definition at line 119 of file CatalogNode.h.

nodes_begin()

item_iter bes::CatalogNode::nodes_begin ( )

inline

Definition at line 108 of file CatalogNode.h.

nodes_end()

item_iter bes::CatalogNode::nodes_end ( )

inline

Definition at line 109 of file CatalogNode.h.

set_catalog_name()

void bes::CatalogNode::set_catalog_name ( std::string cn )

inline

Set the name of the catalog.

Definition at line 87 of file CatalogNode.h.

set_leaf()

void bes::CatalogNode::set_leaf ( CatalogItem * leaf )

inline

Definition at line 76 of file CatalogNode.h.

set_lmt()

void bes::CatalogNode::set_lmt ( std::string lmt )

inline

Set the LMT for this node.

Definition at line 92 of file CatalogNode.h.

set_name()

void bes::CatalogNode::set_name ( std::string n )

inline

Set the name of the catalog's node.

Definition at line 82 of file CatalogNode.h.

---

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

• CatalogNode.h
• CatalogNode.cc