FREE::SessionProcessor Class Reference
[Registration controller, Processor controller]

Class coordinates for the whole session procession. More...

#include <freSessionProcessor.h>

Collaboration diagram for FREE::SessionProcessor:

[legend]

List of all members.

Public Types
typedef SessionProcessor	Self
typedef SessionBuilder::GenericMediaType	GenericMediaType
typedef GenericMediaType::Pointer	GenericMediaPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
void	SetSetup (Setup *pSetup)
const Setup *	GetSetup () const
Setup *	GetSetup ()
SessionInfo *	GetSessionInfo ()
void	SetStatistic (Statistics *pStatistic)
const Statistics *	GetStatistic () const
Statistics *	GetStatistic ()
void	DefineOutput (const std::string &sOutputID, const IDPath &idPath)
void	ResetOutputs ()
GenericMediaPointer	GetOutput (const std::string &sOutputID)
GenericMediaPointer	GetOutput (const IDPath &idPath)
template<class TMediaType>
TMediaType::Pointer	GetCastedOutput (const std::string &sOutputID)
void	InitializeSession ()
void	Update ()
void	ResetSession ()
	SessionProcessor ()
virtual	~SessionProcessor ()
Protected Types
typedef std::map < std::string, IDPath >	MediaIDMapType
Protected Attributes
SessionInfo::Pointer	m_smpSessionInfo
Setup *	m_pSetup
Statistics *	m_pStatistic
MediaIDMapType	m_MediaMap
bool	m_bInitialized

---

Detailed Description

Class coordinates for the whole session procession.

Registrator interacts with the "outside" to realize a registration.

Definition at line 43 of file freSessionProcessor.h.

---

Member Typedef Documentation

typedef SessionProcessor FREE::SessionProcessor::Self

Definition at line 47 of file freSessionProcessor.h.

typedef SessionBuilder::GenericMediaType FREE::SessionProcessor::GenericMediaType

Definition at line 48 of file freSessionProcessor.h.

typedef GenericMediaType::Pointer FREE::SessionProcessor::GenericMediaPointer

Definition at line 49 of file freSessionProcessor.h.

typedef std::map<std::string, IDPath > FREE::SessionProcessor::MediaIDMapType [protected]

Definition at line 126 of file freSessionProcessor.h.

---

Constructor & Destructor Documentation

FREE::SessionProcessor::SessionProcessor

(

)

Definition at line 116 of file freSessionProcessor.cxx.

References m_pStatistic, and ResetSession().

Here is the call graph for this function:

FREE::SessionProcessor::~SessionProcessor

(

)

[virtual]

Definition at line 123 of file freSessionProcessor.cxx.

References ResetSession().

Here is the call graph for this function:

---

Member Function Documentation

virtual const char* FREE::SessionProcessor::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 51 of file freSessionProcessor.h.

void FREE::SessionProcessor::SetSetup

(

Setup *

pSetup

)

Function to access the member variable m_pSetup. m_pSetup points to the Setup, which defines the registration. Setup is normally set by the BuildSetup function of the SessionBuilder.

Parameters:

[in]

pSetup

Pointer of Setup

Definition at line 29 of file freSessionProcessor.cxx.

References m_pSetup, and ResetSession().

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

Here is the call graph for this function:

const Setup* FREE::SessionProcessor::GetSetup

(

)

const [inline]

Function to access the member variable m_pSetup. m_pSetup points to the Setup, which defines the registration.

Returns:

Pointer m_pSetup

Definition at line 63 of file freSessionProcessor.h.

References m_pSetup.

Setup* FREE::SessionProcessor::GetSetup

(

)

[inline]

Definition at line 64 of file freSessionProcessor.h.

References m_pSetup.

SessionInfo* FREE::SessionProcessor::GetSessionInfo

(

)

[inline]

Definition at line 66 of file freSessionProcessor.h.

References m_smpSessionInfo.

Referenced by FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

void FREE::SessionProcessor::SetStatistic

(

Statistics *

pStatistic

)

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 40 of file freSessionProcessor.cxx.

References m_pStatistic.

const Statistics* FREE::SessionProcessor::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 77 of file freSessionProcessor.h.

References m_pStatistic.

Statistics* FREE::SessionProcessor::GetStatistic

(

)

[inline]

Definition at line 78 of file freSessionProcessor.h.

References m_pStatistic.

void FREE::SessionProcessor::DefineOutput	(	const std::string &	sOutputID,
		const IDPath &	idPath
	)

Definition at line 47 of file freSessionProcessor.cxx.

References m_MediaMap.

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

void FREE::SessionProcessor::ResetOutputs

(

)

Definition at line 63 of file freSessionProcessor.cxx.

References m_MediaMap.

SessionProcessor::GenericMediaPointer FREE::SessionProcessor::GetOutput

(

const std::string &

sOutputID

)

Definition at line 70 of file freSessionProcessor.cxx.

References m_MediaMap, and throwExceptionMacro.

Referenced by GetCastedOutput().

SessionProcessor::GenericMediaPointer FREE::SessionProcessor::GetOutput

(

const IDPath &

idPath

)

Definition at line 82 of file freSessionProcessor.cxx.

References FREE::SessionAccessor::GetMedia(), InitializeSession(), m_bInitialized, and m_smpSessionInfo.

Here is the call graph for this function:

template<class TMediaType>

TMediaType::Pointer FREE::SessionProcessor::GetCastedOutput

(

const std::string &

sOutputID

)

[inline]

Definition at line 88 of file freSessionProcessor.h.

References catchAllNPassMacro, and GetOutput().

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

Here is the call graph for this function:

void FREE::SessionProcessor::InitializeSession

(

)

Function initialize the session (builds it and prepares it for the processing).

Definition at line 91 of file freSessionProcessor.cxx.

References FREE::SessionBuilder::BuildSession(), m_bInitialized, m_pSetup, m_pStatistic, m_smpSessionInfo, and ResetSession().

Referenced by FREE::PrecisionSOMetric< VImageDimension >::ComputeDecomposedValue(), GetOutput(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::AccuracySOMetricThread< VImageDimension >::ProcessSetup().

Here is the call graph for this function:

void FREE::SessionProcessor::Update

(

)

Definition at line 103 of file freSessionProcessor.cxx.

void FREE::SessionProcessor::ResetSession

(

)

Definition at line 109 of file freSessionProcessor.cxx.

References m_bInitialized, and m_smpSessionInfo.

Referenced by InitializeSession(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), SessionProcessor(), SetSetup(), and ~SessionProcessor().

---

Member Data Documentation

SessionInfo::Pointer FREE::SessionProcessor::m_smpSessionInfo [protected]

Session info of the process contains the component caches.

Definition at line 116 of file freSessionProcessor.h.

Referenced by GetOutput(), GetSessionInfo(), InitializeSession(), and ResetSession().

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

Pointer to the Setup, which defines the session. The processing will only start, if it is set != Null.

Definition at line 120 of file freSessionProcessor.h.

Referenced by GetSetup(), InitializeSession(), and SetSetup().

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

Pointer to a statistic object. If m_pStatistic == Null, no statistical information will be gathered.

Definition at line 124 of file freSessionProcessor.h.

Referenced by GetStatistic(), InitializeSession(), SessionProcessor(), and SetStatistic().

MediaIDMapType FREE::SessionProcessor::m_MediaMap [protected]

Definition at line 128 of file freSessionProcessor.h.

Referenced by DefineOutput(), GetOutput(), and ResetOutputs().

bool FREE::SessionProcessor::m_bInitialized [protected]

Definition at line 130 of file freSessionProcessor.h.

Referenced by GetOutput(), InitializeSession(), and ResetSession().

---

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

• freSessionProcessor.h
• freSessionProcessor.cxx

---