FREE::ComponentSetupBrowser Class Reference
[Setup]

Class is used for searching subcomponents matching a given IDPath. More...

#include <freComponentSetupBrowser.h>

Collaboration diagram for FREE::ComponentSetupBrowser:

[legend]

List of all members.

Public Types
typedef std::vector < ComponentSetup * >	FindingsType
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetRelativeRoot (ComponentSetup *pRelativeRoot)
ComponentSetup *	GetRelativeRoot () const
FindingsType &	GetFindings ()
const FindingsType &	GetFindings () const
bool	SearchForComponents (const IDPath &idPath)
	ComponentSetupBrowser (ComponentSetup *pRelativeRoot=NULL)
virtual	~ComponentSetupBrowser ()
void	Reset ()
Protected Member Functions
void	CrawlComponentByIDPath (ComponentSetup *pRelativeRoot, const IDPath &idPath)
Protected Attributes
ComponentSetup *	m_pRelativeRoot
FindingsType	m_Findings

---

Detailed Description

Class is used for searching subcomponents matching a given IDPath.

Definition at line 35 of file freComponentSetupBrowser.h.

---

Member Typedef Documentation

typedef std::vector<ComponentSetup*> FREE::ComponentSetupBrowser::FindingsType

Definition at line 38 of file freComponentSetupBrowser.h.

---

Constructor & Destructor Documentation

FREE::ComponentSetupBrowser::ComponentSetupBrowser

(

ComponentSetup *

pRelativeRoot = NULL

)

Definition at line 77 of file freComponentSetupBrowser.cxx.

References SetRelativeRoot().

Here is the call graph for this function:

FREE::ComponentSetupBrowser::~ComponentSetupBrowser

(

)

[virtual]

Definition at line 83 of file freComponentSetupBrowser.cxx.

---

Member Function Documentation

virtual const char* FREE::ComponentSetupBrowser::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 40 of file freComponentSetupBrowser.h.

void FREE::ComponentSetupBrowser::SetRelativeRoot

(

ComponentSetup *

pRelativeRoot

)

Implementation of FREE::ComponentSetupBrowser //////////////////////

Definition at line 38 of file freComponentSetupBrowser.cxx.

References m_pRelativeRoot, and Reset().

Referenced by ComponentSetupBrowser().

Here is the call graph for this function:

ComponentSetup * FREE::ComponentSetupBrowser::GetRelativeRoot

(

)

const

Definition at line 46 of file freComponentSetupBrowser.cxx.

References m_pRelativeRoot.

ComponentSetupBrowser::FindingsType & FREE::ComponentSetupBrowser::GetFindings

(

)

Definition at line 53 of file freComponentSetupBrowser.cxx.

References m_Findings.

const ComponentSetupBrowser::FindingsType & FREE::ComponentSetupBrowser::GetFindings

(

)

const

Definition at line 60 of file freComponentSetupBrowser.cxx.

References m_Findings.

bool FREE::ComponentSetupBrowser::SearchForComponents

(

const IDPath &

idPath

)

Definition at line 67 of file freComponentSetupBrowser.cxx.

References CrawlComponentByIDPath(), m_Findings, m_pRelativeRoot, Reset(), throwExceptionMacro, and FREE::IDPath::ToStr().

Here is the call graph for this function:

void FREE::ComponentSetupBrowser::Reset

(

)

Definition at line 87 of file freComponentSetupBrowser.cxx.

References m_Findings.

Referenced by SearchForComponents(), and SetRelativeRoot().

void FREE::ComponentSetupBrowser::CrawlComponentByIDPath	(	ComponentSetup *	pRelativeRoot,
		const IDPath &	idPath
	)			[protected]

Definition at line 94 of file freComponentSetupBrowser.cxx.

References FREE::ComponentSetup::Components(), FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::IDPath::GetFirstComponent(), FREE::ComponentSetup::GetParentComponent(), FREE::ComponentSetup::GetRootComponent(), FREE::IDPath::GetSubIDPath(), FREE::IDPath::IsAbsolute(), FREE::IDPath::IsEmpty(), m_Findings, FREE::IDPath::PTAnyChild, FREE::IDPath::PTAnyDescendant, FREE::IDPath::PTComponent, FREE::IDPath::PTMedia, FREE::IDPath::PTParameter, FREE::IDPath::PTParent, FREE::IDPath::SetAbsolute(), and FREE::CollectionBase< TElement, TStorageType >::Size().

Referenced by SearchForComponents().

Here is the call graph for this function:

---

Member Data Documentation

ComponentSetup* FREE::ComponentSetupBrowser::m_pRelativeRoot [protected]

Definition at line 61 of file freComponentSetupBrowser.h.

Referenced by GetRelativeRoot(), SearchForComponents(), and SetRelativeRoot().

FindingsType FREE::ComponentSetupBrowser::m_Findings [protected]

Definition at line 63 of file freComponentSetupBrowser.h.

Referenced by CrawlComponentByIDPath(), GetFindings(), Reset(), and SearchForComponents().

---

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

• freComponentSetupBrowser.h
• freComponentSetupBrowser.cxx

---