FREE::SessionAccessor Class Reference
[Processing engine (API classes)]

Manages the access and retreavel of media and parameters of setup components. More...

#include <freSessionAccessor.h>

List of all members.

Public Types
typedef GenericMediaType::Pointer	GenericMediaPointer
Static Public Member Functions
static ValidityTag::Pointer	GetValidityTag (const IDPath &path, SessionComponentCache *pComponentCache)
static ValidityTag::Pointer	GetValidityTagRequirement (const IDPath &path, SessionComponentCache *pComponentCache)
static GenericMediaPointer	GetMedia (const IDPath &mediaID, SessionInfo *pInfo)
static GenericMediaPointer	GetLinkedMedia (const std::string &sMediaID, SessionComponentCache *pComponentCache, SessionInfo *pInfo, bool bMissingLinkException=false)
static void	SetMedia (const IDPath &mediaID, GenericMediaPointer &rMedia, SessionInfo *pInfo)
static std::string	GetMediaControllerID (const IDPath &mediaID, SessionComponentCache *pComponentCache)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, std::string &value, bool bGetLastValidLayer=false)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, bool &value, bool bGetLastValidLayer=false)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, double &value, bool bGetLastValidLayer=false)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, int &value, bool bGetLastValidLayer=false)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, long &value, bool bGetLastValidLayer=false)
static void	GetParameterValueByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID, unsigned long &value, bool bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, std::string &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, bool &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, double &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, int &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, long &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static void	GetParameterValue (const SessionComponentCache *pComponentCache, const std::string &sParameterName, unsigned long &value, const Parameter::ValueCountType &iItemPos=0, const Parameter::LayerCountType &iLayer=0, const bool &bGetLastValidLayer=false)
static Parameter::Pointer	GetParameter (const SessionComponentCache *pComponentCache, const std::string &sParameterName)
static Parameter::Pointer	GetParameterByIDPath (const SessionComponentCache *pComponentCache, const IDPath &parameterID)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const std::string &value)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const bool &value)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const double &value)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const int &value)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const long &value)
static void	SetParameterValueByIDPath (SessionComponentCache *pComponentCache, const IDPath &parameterID, const unsigned long &value)

---

Detailed Description

Manages the access and retreavel of media and parameters of setup components.

Definition at line 41 of file freSessionAccessor.h.

---

Member Typedef Documentation

typedef GenericMediaType::Pointer FREE::SessionAccessor::GenericMediaPointer

Definition at line 68 of file freSessionAccessor.h.

---

Member Function Documentation

ValidityTag::Pointer FREE::SessionAccessor::GetValidityTag	(	const IDPath &	path,
		SessionComponentCache *	pComponentCache
	)			[static]

Retrieves the ValidityTag of the media/parameter specified by the passed IDPath by locating the associated ComponentCache and calling GetMediaValidityTag or GetParameterValidityTag of the corresponding controller.

Parameters:

[in]	path	IDPath specifying the wanted media/parameter.
[in]	pComponentCache	Pointer to any component cache of the session the media/parameter should be located in.

Definition at line 39 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::SessionComponentCache::GetCacheByIDPath(), FREE::IDPath::GetMediaID(), FREE::ComponentControllerInterface::GetMediaValidityTag(), FREE::IDPath::GetParameterName(), FREE::ComponentControllerInterface::GetParameterValidityTag(), FREE::IDPath::IsMediaSelection(), FREE::IDPath::IsParameterSelection(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::MediaBridgeController::GetMediaValidityTag(), and FREE::MediaActualizerController::GetMediaValidityTag().

Here is the call graph for this function:

ValidityTag::Pointer FREE::SessionAccessor::GetValidityTagRequirement	(	const IDPath &	path,
		SessionComponentCache *	pComponentCache
	)			[static]

Retrieves the ValidityTag requirement of the media/parameter specified by the passed IDPath by locating the associated ComponentCache and calling GetMediaValidityTagRequirement or GetParameterValidityTagRequirement of the corresponding controller. A ValidityTag requirement is the highest tag occurring in the dependency chain of the specified media/parameter.

Parameters:

[in]	path	IDPath specifying the wanted media/parameter.
[in]	pComponentCache	Pointer to any component cache of the session the media/parameter should be located in.

Definition at line 57 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::SessionComponentCache::GetCacheByIDPath(), FREE::IDPath::GetMediaID(), FREE::ComponentControllerInterface::GetMediaValidityTagRequirement(), FREE::IDPath::GetParameterName(), FREE::ComponentControllerInterface::GetParameterValidityTagRequirement(), FREE::IDPath::IsMediaSelection(), FREE::IDPath::IsParameterSelection(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), FREE::MediaBridgeController::GetMediaValidityTagRequirement(), FREE::MediaActualizerController::GetMediaValidityTagRequirement(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GetMediaValidityTagRequirement(), and FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement().

Here is the call graph for this function:

SessionAccessor::GenericMediaPointer FREE::SessionAccessor::GetMedia	(	const IDPath &	mediaID,
		SessionInfo *	pInfo
	)			[static]

Uses the passed session info to retrieve the media specified by the ID path mediaID.

Parameters:

[in]	mediaID	IDPath specifying the location of the media within the session info.
[in]	pInfo	Pointer to the session info.

Returns:

Smart pointer, that will reference the media if the fetching was successful (can be null).

Remarks:

If MediaID is unknown and cannot be fetched an excetpion will be thrown.

Definition at line 79 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionInfo::GetCacheByIDPath(), FREE::ComponentControllerInterface::GetMedia(), FREE::IDPath::GetMediaID(), FREE::IDPath::GetParentComponentIDPath(), FREE::SessionComponentCache::IsActive(), FREE::IDPath::IsMediaSelection(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::MediaActualizer::ActualizeMediaByField(), FREE::MediaActualizer::ActualizeMediaByFunction(), FREE::AccuracySOMetricThread< VImageDimension >::EvaluateField(), FREE::AccuracySOMetricThread< VImageDimension >::EvaluatePoints(), GetLinkedMedia(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::SessionProcessor::GetOutput(), FREE::SessionBuilder::LinkMediaToComponent(), FREE::SessionBuilder::LinkMediaToComponentByID(), FREE::ImageDifferenceSOMetricThread< VImageDimension >::ProcessSetup(), FREE::ImageClassificationSOMetricThread< VImageDimension >::ProcessSetup(), and FREE::MediaDrainController::SaveMedia().

Here is the call graph for this function:

SessionAccessor::GenericMediaPointer FREE::SessionAccessor::GetLinkedMedia	(	const std::string &	sMediaID,
		SessionComponentCache *	pComponentCache,
		SessionInfo *	pInfo,
		bool	bMissingLinkException = false
	)			[static]

Uses the passed session info to retrieve the media linked to the passed component (cache) by the specified link.

Parameters:

[in]	sMediaID	ID of the link that specifies the media.
[in,out]	pComponentCache	Pointer to the component cache containing the link.
[in]	pInfo	Pointer to the session info.
[in]	bMissingLinkException	Indicates if the function should throw an exception if the link cannot be found in the setup of the pComponentCache (true) or if it just should return a null pointer (false). Last option is appropriate for optional media links.

Returns:

Smart pointer, that will reference the media if the fetching was successful. The smartpointer can be null, either because the responsible controller returned null when the media was requested or because there was no link and bMissingLinkException is false.

Definition at line 96 of file freSessionAccessor.cxx.

References FREE::KeyedCollectionBase< TKey, TElement, TIdentifierClass >::GetElement(), FREE::SessionComponentCache::GetIDPath(), GetMedia(), FREE::ComponentSetup::MediaLinks(), FREE::SessionComponentCache::Setup(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::OrientImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, 3 >::ActualizeMainComponent(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MediaBridgeController::GetMediaCasted(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues(), FREE::CenteredAffine3DTransformController::SetInitialTransformValues(), FREE::CenteredAffine2DTransformController::SetInitialTransformValues(), and FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues().

Here is the call graph for this function:

void FREE::SessionAccessor::SetMedia	(	const IDPath &	mediaID,
		GenericMediaPointer &	rMedia,
		SessionInfo *	pInfo
	)			[static]

Stores the media in the passed session info at a location specified by mediaID.

Parameters:

[in]	mediaID	IDPath specifying the storing location of the media within the session info.
[out]	rMedia	Reference to a smart pointer to the media.
[in]	pInfo	Pointer to the session info.

Remarks:

If MediaID is unknown and media cannot be set an excetpion will be thrown.

Definition at line 121 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionInfo::GetCacheByIDPath(), FREE::IDPath::GetMediaID(), FREE::IDPath::GetParentComponentIDPath(), FREE::SessionComponentCache::IsActive(), FREE::IDPath::IsMediaSelection(), FREE::ComponentControllerInterface::SetMedia(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::MediaBridgeController::SetMediaCasted().

Here is the call graph for this function:

std::string FREE::SessionAccessor::GetMediaControllerID	(	const IDPath &	mediaID,
		SessionComponentCache *	pComponentCache
	)			[static]

Retrieves the ID of the actual controller of the given media.

Parameters:

[in]	mediaID	Path specifying the wanted media.
[in]	pComponentCache	Pointer to a component cache of the session the media should be located in.

Definition at line 138 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::SessionComponentCache::GetCacheByIDPath(), FREE::ComponentControllerInterface::GetMediaControllerID(), FREE::IDPath::GetMediaID(), FREE::IDPath::IsMediaSelection(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::MediaActualizer::ActualizeMediaByField(), FREE::MediaActualizer::ActualizeMediaByFunction(), FREE::MediaBridgeController::GetMediaControllerID(), FREE::MediaActualizerController::GetMediaControllerID(), and FREE::ComponentControllerBase< TControlledComponent >::GetMediaControllerID().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		std::string &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Returns a value of a specified parameter. To address the component, parameter, layer and value index an IDPath is used: ComponentName\.. (e.g. component@StepSize) If the parameter does not exist or the iItemPos or iLayer is out of range an exception will be thrown.

Parameters:

[in]	pComponentCache	Pointer to a component cache within the session where the parameter should be located. If the given IDPath is relative this component cache will be the starting point for the search.
[in]	parameterID	The IDPath specifying the component, parameter, layer and value index within the session.
[out]	value	Wanted value of the parameter.
[in]	bGetLastValidLayer	Indicates that if the layer index is out of bound the last existant layer will be used for retrieval (true), instead of throwing an exception (false). (E.g. only 3 parameter layer are specified but layer 7 is requested, then the value of layer 3 will be used, if the flag is true)iLayer Indicates the layer of the wanted value.

Definition at line 157 of file freSessionAccessor.cxx.

References FREE::DispatchParameterIDPath(), FREE::SessionComponentCache::GetIDPath(), GetParameterByIDPath(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by GetParameterValueByIDPath().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		bool &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Definition at line 185 of file freSessionAccessor.cxx.

References GetParameterValueByIDPath(), and FREE::Convert::ToBool().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		double &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Definition at line 195 of file freSessionAccessor.cxx.

References GetParameterValueByIDPath(), and FREE::Convert::ToDouble().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		int &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Definition at line 205 of file freSessionAccessor.cxx.

References GetParameterValueByIDPath(), and FREE::Convert::ToInt().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		long &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Definition at line 215 of file freSessionAccessor.cxx.

References GetParameterValueByIDPath(), and FREE::Convert::ToLong().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValueByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		unsigned long &	value,
		bool	bGetLastValidLayer = false
	)			[static]

Definition at line 225 of file freSessionAccessor.cxx.

References GetParameterValueByIDPath(), and FREE::Convert::ToULong().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		std::string &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Returns a value of a specified parameter. It is assumed that the wanted parameter belongs to the component passed with the component cache. If the parameter does not exist or the iItemPos or iLayer is out of range an exception will be thrown.

Parameters:

[in]	pComponentCache	Pointer to the component cache containing the parameter.
[in]	sParameterName	The name of the parameter whose value should be retrieved.
[out]	value	Wanted value of the parameter.
[in]	iItemPos	Indicates the position of the wanted value.
[in]	iLayer	Indicates the layer of the wanted value.
[in]	bGetLastValidLayer	Indicates that if the layer index is out of bound the last existant layer will be used for retrieval (true), instead of throwing an exception (false). (E.g. only 3 parameter layer are specified but layer 7 is requested, then the value of layer 3 will be used, if the flag is true)iLayer Indicates the layer of the wanted value.

Definition at line 235 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::GetIDPath(), GetParameter(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::SPSASOOptimizerController::ActualizeFinalization(), FREE::SPSAOptimizerController::ActualizeFinalization(), FREE::WeightedAddImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::WarpImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::TransformationFieldType >::ActualizeMainComponent(), FREE::VnlSetupOptimizationOptimizerControllerBase< TControlledVnlOptimizer >::ActualizeMainComponent(), FREE::VersorTransformOptimizerController::ActualizeMainComponent(), FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::SPSASOOptimizerController::ActualizeMainComponent(), FREE::SPSAOptimizerController::ActualizeMainComponent(), FREE::SpatialRegionOfInterestImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::ActualizeMainComponent(), FREE::SetupOptimizationProcessorController::ActualizeMainComponent(), FREE::SetupOptimizationMultiThreadMetricControllerBase< TControlledMetric >::ActualizeMainComponent(), FREE::ROICoupleControllerBase< FREE::ImageMaskedROICouple< VImageDimension > >::ActualizeMainComponent(), FREE::ROIControllerBase< FREE::ImageROIBase< 3 > >::ActualizeMainComponent(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::RegStepGradDescOptimizerControllerBase< TOptimizer >::ActualizeMainComponent(), FREE::PowellSOOptimizerController::ActualizeMainComponent(), FREE::PowellOptimizerController::ActualizeMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::ActualizeMainComponent(), FREE::OrientImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, 3 >::ActualizeMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::ActualizeMainComponent(), FREE::OnePlusOneEvolutionaryOptimizerController::ActualizeMainComponent(), FREE::NormalVariateGeneratorController::ActualizeMainComponent(), FREE::MVNonLinearVNLOptimizerControllerBase< TControlledVNLOptimizer >::ActualizeMainComponent(), FREE::MutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MeanReciprocalSquaresMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MaskImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::MaskedROICoupleControllerBase< 3 >::ActualizeMainComponent(), FREE::MaskedROIControllerBase< 3 >::ActualizeMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::ActualizeMainComponent(), FREE::LevenbergMarquardtOptimizerController::ActualizeMainComponent(), FREE::LBFGSOptimizerController::ActualizeMainComponent(), FREE::IterativeInverseDeformationFieldImageFilterControllerBase< FREE::ImageTypes< 2 >::TransformationFieldType >::ActualizeMainComponent(), FREE::IsoContourDistanceImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::ImageToImageFilterControllerBase< TControlledFilter >::ActualizeMainComponent(), FREE::ImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent(), FREE::ImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::ActualizeMainComponent(), FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >::ActualizeMainComponent(), FREE::GradientDescentOptimizerController::ActualizeMainComponent(), FREE::FastChamferDistanceImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent(), FREE::ExhaustiveOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategyOptimizerControllerBase< TOptimizer >::ActualizeMainComponent(), FREE::EvolutionaryStrategyOptimizerController::ActualizeMainComponent(), FREE::ESRankRecombinatorController::ActualizeMainComponent(), FREE::ESRandomMultiParentSelectorController::ActualizeMainComponent(), FREE::ESCommaSelectionController::ActualizeMainComponent(), FREE::ESCMAMutationController::ActualizeMainComponent(), FREE::ESAsymmetricMutationController::ActualizeMainComponent(), FREE::ESAdaptiveScaleMutationController::ActualizeMainComponent(), FREE::ESAdaptiveNormalMutationController::ActualizeMainComponent(), FREE::DiscreteGaussianImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::DanielssonDistanceMapImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::ContinuousLBFGSOptimizerController::ActualizeMainComponent(), FREE::ConstrainedSetupTransformController::ActualizeMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::ActualizeMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::ActualizeMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::ActualizeMainComponent(), FREE::BSplineInterpolateControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::BinaryThresholdImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::AmoebaSOOptimizerController::ActualizeMainComponent(), FREE::AmoebaOptimizerController::ActualizeMainComponent(), FREE::AccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::ActualizeMainComponent(), FREE::PointSetMediaControllerBase< PixelType, 2 >::BuildMainComponent(), FREE::ImageMediaControllerBase< TImage >::BuildMainComponent(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::GenerateProfile(), FREE::PointSetMediaControllerBase< PixelType, 2 >::GetComponent(), FREE::ImageMediaControllerBase< TImage >::GetComponent(), FREE::SPSASOOptimizerController::GetMaxIterationCount(), FREE::PowellSOOptimizerController::GetMaxIterationCount(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetMaxIterationCount(), FREE::OnePlusOneEvolutionarySOOptimizerController::GetMaxIterationCount(), FREE::LimitedAxisAmoebaSOOptimizerController::GetMaxIterationCount(), FREE::EvolutionaryStrategySOOptimizerController::GetMaxIterationCount(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::GetMaxIterationCount(), FREE::AmoebaSOOptimizerController::GetMaxIterationCount(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::MediaActualizerController::GetMediaCasted(), FREE::ImageToImageFilterControllerBase< TControlledFilter >::GetMediaCasted(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaCasted(), FREE::ImageMediaControllerBase< TImage >::GetMediaValidityTagRequirement(), GetParameterValue(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::LoadMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::LoadMedia(), FREE::TransformFieldMediaControllerBase< FREE::ImageTypes< 3 >::VectorType, 3 >::SaveMedia(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SaveMedia(), FREE::VersorRigid3DTransformController::SetInitialTransformValues(), FREE::MatrixOffsetTransformControllerBase< TMatrixOffsetTransform, VDimension >::SetInitialTransformValues(), FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues(), FREE::StoreableMediaControllerBase< TMedia >::SetStatisticEntryMainComponent(), FREE::PointSupportedMetricControllerBase< ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::PointSetType >::SetStatisticEntryMainComponent(), FREE::IntensityImageMediaControllerBase< float, unsigned short, VDimension >::SetStatisticEntryMainComponent(), and FREE::MediaActualizerController::UseField().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		bool &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Definition at line 257 of file freSessionAccessor.cxx.

References GetParameterValue(), and FREE::Convert::ToBool().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		double &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Definition at line 267 of file freSessionAccessor.cxx.

References GetParameterValue(), and FREE::Convert::ToDouble().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		int &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Definition at line 277 of file freSessionAccessor.cxx.

References GetParameterValue(), and FREE::Convert::ToInt().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		long &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Definition at line 287 of file freSessionAccessor.cxx.

References GetParameterValue(), and FREE::Convert::ToLong().

Here is the call graph for this function:

void FREE::SessionAccessor::GetParameterValue	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName,
		unsigned long &	value,
		const Parameter::ValueCountType &	iItemPos = 0,
		const Parameter::LayerCountType &	iLayer = 0,
		const bool &	bGetLastValidLayer = false
	)			[static]

Definition at line 297 of file freSessionAccessor.cxx.

References GetParameterValue(), and FREE::Convert::ToULong().

Here is the call graph for this function:

Parameter::Pointer FREE::SessionAccessor::GetParameter	(	const SessionComponentCache *	pComponentCache,
		const std::string &	sParameterName
	)			[static]

Returns a smart pointer to the specified parameter which is provided by the component controller.

Remarks:

The parameter is passed as a smart pointer because it could be possible that the controller has generated the parameter values explicit for this call (e.g. Parameter with access type "get") and is not responsible for the deallocation; this will be handled by the smart pointer.

Parameters:

[in]	pComponentCache	Pointer to component where the parameter should be located.
[in]	sParameterName	Name of the parameter with the wanted value.

Returns:

Smart pointer with the parameter. If the smart pointer is NULL the specified parameter couldn't be found. (See remarks concerning the result nature)

Definition at line 307 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::ComponentControllerInterface::GetParameter(), and throwStaticExceptionMacro.

Referenced by FREE::TransformControllerBase< TControlledTransform, iDimension >::ActualizeMainComponent(), FREE::ShrinkImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::SetupTransformControllerBase< FREE::ConstrainedSetupTransform >::ActualizeMainComponent(), FREE::MattesMutualInformationMetricControllerBase< ImageTypes< 3 >::InternalImageType >::ActualizeMainComponent(), FREE::LimitedAxisAmoebaSOOptimizerController::ActualizeMainComponent(), FREE::ExhaustiveSOOptimizerController::ActualizeMainComponent(), FREE::ExhaustiveOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategyOptimizerController::ActualizeMainComponent(), FREE::DiscreteGaussianImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::ConstrainedSetupTransformController::ActualizeMainComponent(), FREE::ConstrainedImageDifferenceSOMetricControllerBase< FREE::ConstrainedImageDifferenceSOMetric< 2 > >::ActualizeMainComponent(), FREE::ConstrainedImageClassificationSOMetricControllerBase< FREE::ConstrainedImageClassificationSOMetric< 2 > >::ActualizeMainComponent(), FREE::ConstrainedAccuracySOMetricControllerBase< FREE::ConstrainedAccuracySOMetric< 3 > >::ActualizeMainComponent(), FREE::CheckerBoardImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::ActualizeMainComponent(), FREE::AmoebaSOOptimizerController::ActualizeMainComponent(), GetParameterByIDPath(), GetParameterValue(), and FREE::BSplineDeformableTransformControllerBase< 3, 3 >::SetInitialTransformValues().

Here is the call graph for this function:

Parameter::Pointer FREE::SessionAccessor::GetParameterByIDPath	(	const SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID
	)			[static]

Returns a smart pointer to the specified parameter which is provided by the component controller. To address the component and parameter an IDPath is used: ComponentName\.. (e.g. component@StepSize)

Remarks:

The parameter is passed as a smart pointer because it could be possible that the controller has generated the parameter values explicit for this call (e.g. Parameter with access type "get") and is not responsible for the deallocation; this will be handled by the smart pointer.

Parameters:

[in]	pComponentCache	Pointer to a component cache of the session where the parameter is located in.
[in]	parameterID	The IDPath specifying the component, parameter, layer and value index within the session.
[in]	sParameterName	Name of the parameter with the wanted value.

Returns:

Smart pointer with the parameter. If the smart pointer is NULL the specified parameter couldn't be found. (See remarks concerning the result nature)

Definition at line 317 of file freSessionAccessor.cxx.

References FREE::DispatchParameterIDPath(), GetParameter(), FREE::IDPath::IsParameterSelection(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by FREE::SPSASOOptimizerController::ActualizeMainComponent(), FREE::PowellSOOptimizerController::ActualizeMainComponent(), FREE::OnePlusOneEvolutionarySOOptimizerController::ActualizeMainComponent(), FREE::EvolutionaryStrategySOOptimizerController::ActualizeMainComponent(), FREE::ConstrainedOnePlusOneEvolutionarySOOptimizerController::ActualizeMainComponent(), FREE::PrecisionSOMetricController::GenerateProfile(), FREE::HistogramMetricControllerBase< TControlledCompareHistogramMetric >::GenerateProfile(), GetParameterValueByIDPath(), FREE::OptimizerControllerBase< TControlledOptimizer >::GetTransformScales(), and FREE::ParameterListIO::SaveListToFile().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const std::string &	value
	)			[static]

Sets a value of the given parameter. To address the component, parameter, layer and value index an IDPath is used: ComponentName\.. (e.g. component@StepSize) If the parameter does not exist, the iItemPos or iLayer is out of range or for any other reason the value cannot been set an exception will be thrown.

Parameters:

[in]	pComponentCache	Pointer to a component cache within the session where the parameter should be located. If the given IDPath is relative this component cache will be the starting point for the search.
[in]	parameterID	The IDPath specifying the component, parameter, layer and value index within the session.
[in]	value	New value of the parameter.

Definition at line 337 of file freSessionAccessor.cxx.

References FREE::SessionComponentCache::Controller(), FREE::SessionComponentCache::ControllerIsAssigned(), FREE::DispatchParameterIDPath(), FREE::SessionComponentCache::GetCacheByIDPath(), FREE::IDPath::IsParameterSelection(), FREE::ComponentControllerInterface::SetParameterValue(), throwStaticExceptionMacro, and FREE::IDPath::ToStr().

Referenced by SetParameterValueByIDPath().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const bool &	value
	)			[static]

Definition at line 357 of file freSessionAccessor.cxx.

References SetParameterValueByIDPath(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const double &	value
	)			[static]

Definition at line 365 of file freSessionAccessor.cxx.

References SetParameterValueByIDPath(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const int &	value
	)			[static]

Definition at line 372 of file freSessionAccessor.cxx.

References SetParameterValueByIDPath(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const long &	value
	)			[static]

Definition at line 379 of file freSessionAccessor.cxx.

References SetParameterValueByIDPath(), and FREE::Convert::ToStr().

Here is the call graph for this function:

void FREE::SessionAccessor::SetParameterValueByIDPath	(	SessionComponentCache *	pComponentCache,
		const IDPath &	parameterID,
		const unsigned long &	value
	)			[static]

Definition at line 386 of file freSessionAccessor.cxx.

References SetParameterValueByIDPath(), and FREE::Convert::ToStr().

Here is the call graph for this function:

---

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

• freSessionAccessor.h
• freSessionAccessor.cxx

---