creaImageIO::tree::Descriptor Class Reference
[Attributed tree management]

Descriptor of the structure of a Tree (number of levels, descriptors of each level, ...). More...

#include <creaImageIOTreeDescriptor.h>

List of all members.

Public Types
typedef std::vector < LevelDescriptor >	LevelDescriptorListType
	The type of LevelDescriptor container.
Public Member Functions
	Descriptor ()
	Ctor : creates the mandatory level 0 descriptor called "Root".
	~Descriptor ()
	Destructor.
void	LoadXML (const std::string &filename)
	Loads from a xml description file.
void	CreateDefault ()
	Creates the default descriptor.
unsigned int	GetNumberOfLevels ()
	Returns the number of levels of the tree.
const LevelDescriptor &	GetLevelDescriptor (int level) const
	Returns the LevelDescriptor of a given level (const ref).
const LevelDescriptor::AttributeDescriptorListType &	GetAttributeDescriptorList (int level) const
	Returns the AttributeDescriptorList of a given level (const ref).
void	Add (const LevelDescriptor &)
	Adds a LevelDescriptor at the end of the list.
void	Add (const AttributeDescriptor &, int l)
	Adds an AttributeDescriptor to level l.
void	BuildAttributeMap (AttributeMapType &) const
	Builds the key to value map of all the attributes of the tree.
const LevelDescriptorListType &	GetLevelDescriptorList () const
	Returns the list of tree levels (const).
void	Clear ()
	Clears the Descriptor.
void	createDescriptorfromFile (const std::string &i_file)
Private Member Functions
void	CreateLevel0Descriptor ()
Private Attributes
LevelDescriptorListType	mLevelDescriptorList

---

Detailed Description

Descriptor of the structure of a Tree (number of levels, descriptors of each level, ...).

Definition at line 21 of file creaImageIOTreeDescriptor.h.

---

Member Typedef Documentation

typedef std::vector<LevelDescriptor> creaImageIO::tree::Descriptor::LevelDescriptorListType

The type of LevelDescriptor container.

Definition at line 58 of file creaImageIOTreeDescriptor.h.

---

Constructor & Destructor Documentation

creaImageIO::tree::Descriptor::Descriptor

(

)

Ctor : creates the mandatory level 0 descriptor called "Root".

creaImageIO::tree::Descriptor::~Descriptor

(

)

Destructor.

---

Member Function Documentation

void creaImageIO::tree::Descriptor::LoadXML

(

const std::string &

filename

)

Loads from a xml description file.

void creaImageIO::tree::Descriptor::CreateDefault

(

)

Creates the default descriptor.

unsigned int creaImageIO::tree::Descriptor::GetNumberOfLevels

(

)

[inline]

Returns the number of levels of the tree.

Definition at line 35 of file creaImageIOTreeDescriptor.h.

References mLevelDescriptorList.

Referenced by creaImageIO::tree::Tree::GetNumberOfLevels().

      { return mLevelDescriptorList.size(); }

Here is the caller graph for this function:

const LevelDescriptor& creaImageIO::tree::Descriptor::GetLevelDescriptor

(

int

level

)

const [inline]

Returns the LevelDescriptor of a given level (const ref).

Definition at line 39 of file creaImageIOTreeDescriptor.h.

References mLevelDescriptorList.

Referenced by creaImageIO::tree::Tree::GetLevelDescriptor().

      { return mLevelDescriptorList[level]; }

Here is the caller graph for this function:

const LevelDescriptor::AttributeDescriptorListType& creaImageIO::tree::Descriptor::GetAttributeDescriptorList

(

int

level

)

const [inline]

Returns the AttributeDescriptorList of a given level (const ref).

Definition at line 44 of file creaImageIOTreeDescriptor.h.

References mLevelDescriptorList.

Referenced by creaImageIO::tree::Tree::GetAttributeDescriptorList().

      { return mLevelDescriptorList[level].GetAttributeDescriptorList(); }

Here is the caller graph for this function:

void creaImageIO::tree::Descriptor::Add

(

const LevelDescriptor &

)

Adds a LevelDescriptor at the end of the list.

void creaImageIO::tree::Descriptor::Add	(	const AttributeDescriptor &	,
		int	l
	)

Adds an AttributeDescriptor to level l.

void creaImageIO::tree::Descriptor::BuildAttributeMap

(

AttributeMapType &

)

const

Builds the key to value map of all the attributes of the tree.

const LevelDescriptorListType& creaImageIO::tree::Descriptor::GetLevelDescriptorList

(

)

const [inline]

Returns the list of tree levels (const).

Definition at line 61 of file creaImageIOTreeDescriptor.h.

References mLevelDescriptorList.

{ return mLevelDescriptorList; }

void creaImageIO::tree::Descriptor::Clear

(

)

Clears the Descriptor.

void creaImageIO::tree::Descriptor::createDescriptorfromFile

(

const std::string &

i_file

)

void creaImageIO::tree::Descriptor::CreateLevel0Descriptor

(

)

[private]

Creates the mandatory level 0 descriptor called "Root" (assumes the list is empty)

---

Member Data Documentation

LevelDescriptorListType creaImageIO::tree::Descriptor::mLevelDescriptorList [private]

Definition at line 70 of file creaImageIOTreeDescriptor.h.

Referenced by GetAttributeDescriptorList(), GetLevelDescriptor(), GetLevelDescriptorList(), and GetNumberOfLevels().

---

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

• C:/Creatis/creaImageIO/src2/creaImageIOTreeDescriptor.h

---