PnlTrvDataNode Class Reference

#include <PnlTrvDataNode.h>

Public Types
typedef object_type	data_type

Public Member Functions
	PnlTrvDataNode ()
virtual	~PnlTrvDataNode ()
	PnlTrvDataNode (const PnlTrvDataNode &rhs)
PnlTrvDataNode &	operator= (const PnlTrvDataNode &rhs)
bool	operator== (const PnlTrvDataNode &rhs) const
const PnlTrvDataNode &	GetNthChild (int32 indexInParent) const
PnlTrvDataNode *	GetParent () const
int32	ChildCount () const
PMString	GetData () const
void	AddChild (const PnlTrvDataNode &o)
void	RemoveChild (const PnlTrvDataNode &o)
void	SetParent (const PnlTrvDataNode *p)
void	SetData (const PMString &data)

Detailed Description

Class to represent a generic node within a tree, with data that is encapsulated in a PMString.

Member Typedef Documentation

typedef object_type PnlTrvDataNode::data_type

For K2Vector copy semantics

Constructor & Destructor Documentation

PnlTrvDataNode::~PnlTrvDataNode ( )

virtual

Destructor

PnlTrvDataNode::PnlTrvDataNode

(

const PnlTrvDataNode &

rhs

)

Copy constructor

Parameters

rhs	[IN] node reference

Returns

Member Function Documentation

void PnlTrvDataNode::AddChild

(

const PnlTrvDataNode &

o

)

Add child to this node (at end of list)

Parameters

o	[IN] child node to add

int32 PnlTrvDataNode::ChildCount

(

)

const

Accessor for size of child list on this node

Returns

int32 giving the number of children on this node

PMString PnlTrvDataNode::GetData

(

)

const

Get the data associated with this node (path or whatever)

Returns

data represented here

const PnlTrvDataNode & PnlTrvDataNode::GetNthChild

(

int32

indexInParent

)

const

Accessor for child by zerobased index in parent's list of kids

Parameters

indexInParent

[IN] which child by zero-based index

Returns

child at given index

PnlTrvDataNode * PnlTrvDataNode::GetParent

(

)

const

Accessor for parent

Returns

reference to parent node

PnlTrvDataNode & PnlTrvDataNode::operator=

(

const PnlTrvDataNode &

rhs

)

Operator assignment

Parameters

rhs	[IN] node reference

Returns

PnlTrvDataNode&

bool PnlTrvDataNode::operator==

(

const PnlTrvDataNode &

rhs

)

const

Operator equality

Parameters

rhs	[IN] node reference

Returns

bool

void PnlTrvDataNode::RemoveChild

(

const PnlTrvDataNode &

o

)

Remove specified child from our list

Parameters

o	[IN] specifies child to remove

void PnlTrvDataNode::SetData

(

const PMString &

data

)

Mutator for data stored on this

Parameters

data	[IN] specifies the new data to store

void PnlTrvDataNode::SetParent

(

const PnlTrvDataNode *

p

)

Mutator for the parent of this node

Parameters

p	[IN] specifies new parent to set