FREE::SessionInfo Class Reference
[Session]

Class that contains all elemantry inforamtion for a session. More...

#include <freSessionInfo.h>

Collaboration diagram for FREE::SessionInfo:

[legend]

List of all members.

Public Types
typedef SessionInfo	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef SessionComponentCache::ComponentCacheCollectionType	ComponentCacheCollectionType
Public Member Functions
virtual const char *	GetNameOfClass () const
Setup *	GetSetup () const
void	SetSetup (Setup *pSetup)
const SessionComponentCache *	GetSessionCache () const
SessionComponentCache *	GetSessionCache ()
const ComponentCacheCollectionType &	GetComponentCaches () const
ComponentCacheCollectionType &	GetComponentCaches ()
void	SetStatistic (Statistics *pStatistic)
const Statistics *	GetStatistic () const
Statistics *	GetStatistic ()
SessionComponentCache *	GetCacheByIDPath (const IDPath &idPath) const
virtual SessionInfo &	operator= (const SessionInfo &rSessionInfo)
Static Public Member Functions
static Pointer	New (Setup *pSetup)
Protected Member Functions
	SessionInfo (Setup *pSetup)
Protected Attributes
Setup *	m_pSetup
SessionComponentCache::Pointer	m_smpRootCache
Statistics *	m_pStatistic
Private Member Functions
	SessionInfo (const SessionInfo &rSessionInfo)

---

Detailed Description

Class that contains all elemantry inforamtion for a session.

SessionInfo is used to store information needed within a session (e.g. component cache of the session, media related to the session, setup, statistic...).

Definition at line 41 of file freSessionInfo.h.

---

Member Typedef Documentation

typedef SessionInfo FREE::SessionInfo::Self

Definition at line 44 of file freSessionInfo.h.

typedef itk::LightObject FREE::SessionInfo::Superclass

Definition at line 45 of file freSessionInfo.h.

typedef itk::SmartPointer<Self> FREE::SessionInfo::Pointer

Definition at line 46 of file freSessionInfo.h.

typedef itk::SmartPointer<const Self> FREE::SessionInfo::ConstPointer

Definition at line 47 of file freSessionInfo.h.

typedef SessionComponentCache::ComponentCacheCollectionType FREE::SessionInfo::ComponentCacheCollectionType

Definition at line 53 of file freSessionInfo.h.

---

Constructor & Destructor Documentation

FREE::SessionInfo::SessionInfo

(

Setup *

pSetup

)

[protected]

Constructor. The default section ID will be 0

Parameters:

[in]

pSetup

Pointer to the associated setup

Definition at line 93 of file freSessionInfo.cxx.

References m_pStatistic, m_smpRootCache, and SetSetup().

Referenced by New().

Here is the call graph for this function:

FREE::SessionInfo::SessionInfo

(

const SessionInfo &

rSessionInfo

)

[private]

suppress default copy constructor

---

Member Function Documentation

virtual const char* FREE::SessionInfo::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 49 of file freSessionInfo.h.

SessionInfo::Pointer FREE::SessionInfo::New

(

Setup *

pSetup

)

[static]

Definition at line 114 of file freSessionInfo.cxx.

References SessionInfo().

Referenced by FREE::SessionBuilder::BuildSession().

Here is the call graph for this function:

Setup * FREE::SessionInfo::GetSetup

(

)

const

Function to access the member variable m_pComponentSetup.

Returns:

Pointer to m_pSetup.

Implementation of FREE::freSessionInfo /////////////////////////////

Definition at line 34 of file freSessionInfo.cxx.

References m_pSetup.

Referenced by operator=().

void FREE::SessionInfo::SetSetup

(

Setup *

pSetup

)

Definition at line 41 of file freSessionInfo.cxx.

References FREE::Setup::GetRootComponent(), m_pSetup, m_smpRootCache, and FREE::SessionComponentCache::New().

Referenced by SessionInfo().

Here is the call graph for this function:

const SessionComponentCache * FREE::SessionInfo::GetSessionCache

(

)

const

Function to access the member variable m_pRootCache.

Returns:

Pointer to m_pRootCache.

Definition at line 49 of file freSessionInfo.cxx.

Referenced by FREE::MediaActualizer::ActualizeMediaByField(), FREE::MediaActualizer::ActualizeMediaByFunction(), operator=(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

SessionComponentCache * FREE::SessionInfo::GetSessionCache

(

)

Definition at line 57 of file freSessionInfo.cxx.

References m_smpRootCache.

const SessionInfo::ComponentCacheCollectionType & FREE::SessionInfo::GetComponentCaches

(

)

const

Function to access the collection of first level component caches.

Returns:

Pointer to m_pRootCache->SubCaches().

Definition at line 64 of file freSessionInfo.cxx.

References m_smpRootCache, and throwExceptionMacro.

Referenced by FREE::SessionBuilder::ActualizeSession().

SessionInfo::ComponentCacheCollectionType & FREE::SessionInfo::GetComponentCaches

(

)

Definition at line 75 of file freSessionInfo.cxx.

References m_smpRootCache, and throwExceptionMacro.

void FREE::SessionInfo::SetStatistic

(

Statistics *

pStatistic

)

[inline]

Function to access the member variable m_pStatistic. m_pStatistic points to a Statistics object, where information for statistical evaluation is stored. The default value is Null, if he isn't changed no statistical information will be gathered.

Parameters:

[in]

pStatistic

Pointer of Statistics

Definition at line 76 of file freSessionInfo.h.

References m_pStatistic.

const Statistics* FREE::SessionInfo::GetStatistic

(

)

const [inline]

Function to access the member variable m_pStatistic. m_pStatistic points to a Statistics object, where information for statistical evaluation is stored.

Returns:

Pointer to m_pStatistic

Definition at line 81 of file freSessionInfo.h.

References m_pStatistic.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::AddStatisticEntry(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextIteration(), FREE::RegistrationProcessEventHandler< TRegistrationProcessor >::OnNextLevel(), and FREE::ComponentControllerBase< TControlledComponent >::SetStatisticEntry().

Statistics* FREE::SessionInfo::GetStatistic

(

)

[inline]

Definition at line 82 of file freSessionInfo.h.

References m_pStatistic.

SessionComponentCache * FREE::SessionInfo::GetCacheByIDPath

(

const IDPath &

idPath

)

const

Retrieve a component cache via a given component ID path

Parameters:

[in]

idPath

The component ID path addressing the wanted component.

Returns:

Returns the pointer to the addressed component. If cache is not set or no component has been found under the specified path, the return is NULL

Definition at line 86 of file freSessionInfo.cxx.

References m_smpRootCache.

Referenced by FREE::SessionAccessor::GetMedia(), and FREE::SessionAccessor::SetMedia().

SessionInfo & FREE::SessionInfo::operator=

(

const SessionInfo &

rSessionInfo

)

[virtual]

Assignment operator.

Definition at line 102 of file freSessionInfo.cxx.

References GetSessionCache(), GetSetup(), m_pSetup, and m_smpRootCache.

Here is the call graph for this function:

---

Member Data Documentation

Setup* FREE::SessionInfo::m_pSetup [protected]

Pointer to the associated setup for this registration session.

Definition at line 99 of file freSessionInfo.h.

Referenced by GetSetup(), operator=(), and SetSetup().

SessionComponentCache::Pointer FREE::SessionInfo::m_smpRootCache [protected]

Pointer to the root section cache (corresponding the root component in the setup).

Definition at line 102 of file freSessionInfo.h.

Referenced by GetCacheByIDPath(), GetComponentCaches(), GetSessionCache(), operator=(), SessionInfo(), and SetSetup().

Statistics* FREE::SessionInfo::m_pStatistic [protected]

Pointer to the associated statistic object. If NULL, no statistical information will be gathered.

Definition at line 106 of file freSessionInfo.h.

Referenced by GetStatistic(), SessionInfo(), and SetStatistic().

---

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

• freSessionInfo.h
• freSessionInfo.cxx

---