CusDtLnkUITreeDataNode Class Reference

#include <CusDtLnkUITreeDataNode.h>

Public Types
enum	TreeDataNodeType { eRootType, eDataBaseType, eAssetType, eValueType }
enum	AssetState { eStatePlaceholder, eStateProvisional, eStateFinal }
typedef object_type	data_type

Public Member Functions
	CusDtLnkUITreeDataNode ()
virtual	~CusDtLnkUITreeDataNode ()
	CusDtLnkUITreeDataNode (const CusDtLnkUITreeDataNode &rhs)
CusDtLnkUITreeDataNode &	operator= (const CusDtLnkUITreeDataNode &rhs)
bool	operator== (const CusDtLnkUITreeDataNode &rhs) const
const CusDtLnkUITreeDataNode &	GetNthChild (int32 indexInParent) const
CusDtLnkUITreeDataNode *	GetParent () const
int32	ChildCount () const
PMString	GetUniqueKey () const
TreeDataNodeType	GetNodeType () const
void	SetNodeType (TreeDataNodeType typ)
void	AddChild (const CusDtLnkUITreeDataNode &o)
void	RemoveChild (const CusDtLnkUITreeDataNode &o)
void	SetParent (const CusDtLnkUITreeDataNode *p)
void	SetUniqueKey (const PMString &uk)
URI	GetURIFromNode () const
void	SetAssetDataBasePath (const PMString &dbPath)
PMString	GetAssetDataBasePath () const
void	AddAssetRecordValue (const PMString &name, const PMString &val)
int32	GetAssetRecordFieldCount () const
PMString	GetNthAssetRecordFieldName (int32 index) const
PMString	GetAssetRecordFieldValue (const PMString &key) const
IDFile	ResolveAssetPath () const
AssetState	GetAssetState () const
PMString	GetDescription () const

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 CusDtLnkUITreeDataNode::data_type

For K2Vector copy semantics

Constructor & Destructor Documentation

CusDtLnkUITreeDataNode::~CusDtLnkUITreeDataNode ( )

virtual

Destructor

CusDtLnkUITreeDataNode::CusDtLnkUITreeDataNode

(

const CusDtLnkUITreeDataNode &

rhs

)

Copy constructor

Parameters

rhs	[IN] node reference

Returns

Member Function Documentation

void CusDtLnkUITreeDataNode::AddChild

(

const CusDtLnkUITreeDataNode &

o

)

Add child to this node (at end of list)

Parameters

o	[IN] child node to add

int32 CusDtLnkUITreeDataNode::ChildCount

(

)

const

Accessor for size of child list on this node

Returns

int32 giving the number of children on this node

const CusDtLnkUITreeDataNode & CusDtLnkUITreeDataNode::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

CusDtLnkUITreeDataNode * CusDtLnkUITreeDataNode::GetParent

(

)

const

Accessor for parent

Returns

reference to parent node

PMString CusDtLnkUITreeDataNode::GetUniqueKey

(

)

const

Returns

CusDtLnkUITreeDataNode & CusDtLnkUITreeDataNode::operator=

(

const CusDtLnkUITreeDataNode &

rhs

)

Operator assignment

Parameters

rhs	[IN] node reference

Returns

CusDtLnkUITreeDataNode&

bool CusDtLnkUITreeDataNode::operator==

(

const CusDtLnkUITreeDataNode &

rhs

)

const

Operator equality

Parameters

rhs	[IN] node reference

Returns

bool

void CusDtLnkUITreeDataNode::RemoveChild

(

const CusDtLnkUITreeDataNode &

o

)

Remove specified child from our list

Parameters

o	[IN] specifies child to remove

void CusDtLnkUITreeDataNode::SetParent

(

const CusDtLnkUITreeDataNode *

p

)

Mutator for the parent of this node

Parameters

p	[IN] specifies new parent to set

void CusDtLnkUITreeDataNode::SetUniqueKey

(

const PMString &

uk

)

Parameters

uk