FREE::SessionComponentRepositoryKeys Class Reference
[Processing engine (API classes), Session]

Class is used to generate default keys used in the component cache repository. More...

#include <freSessionComponentCache.h>

List of all members.

Static Public Member Functions
static std::string	ParameterValidity (const std::string &sParameterName)
static std::string	MediaValidity (const MediaID &id)
static std::string	Validity (const std::string &id)

---

Detailed Description

Class is used to generate default keys used in the component cache repository.

In the repository of a component cache elementes can be stored and retrieved via a key. This class offers static methods to generate different keys in default style.

Definition at line 228 of file freSessionComponentCache.h.

---

Member Function Documentation

std::string FREE::SessionComponentRepositoryKeys::ParameterValidity

(

const std::string &

sParameterName

)

[static]

Generate keys for the ValidityTag of parameters. The key has following template: "ParameterValidityTag_[sParameterName]" (e.g.: sParameterName = Param1 -> key = ParameterValidityTag_Param1).

Parameters:

sParameterName

Name of the parameter whose ValidityTag key should be generated.

Returns:

Key for the ValidityTag

Implementation of FREE::SessionComponentRepositoryKeys /////////////

Definition at line 353 of file freSessionComponentCache.cxx.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeParameterValidityTag(), and FREE::ComponentControllerBase< TControlledComponent >::GetParameterValidityTag().

std::string FREE::SessionComponentRepositoryKeys::MediaValidity

(

const MediaID &

id

)

[static]

Generate keys for the ValidityTag of media. The key has following template: "MediaValidityTag_[id]" (e.g.: id = Medium1 -> key = MediaValidityTag_Medium1).

Parameters:

id

ID of the medium whose ValidityTag key should be generated.

Returns:

Key for the ValidityTag

Definition at line 360 of file freSessionComponentCache.cxx.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeMediaValidityTag(), FREE::MediaControllerBase< TMedia >::BuildMainComponent(), FREE::MediaActualizerController::GetMediaValidityTag(), and FREE::ComponentControllerBase< TControlledComponent >::GetMediaValidityTag().

std::string FREE::SessionComponentRepositoryKeys::Validity

(

const std::string &

id

)

[static]

Generate keys for the ValidityTag of any element (that is no parameter or media). The key has following template: "ValidityTag_[id]" (e.g.: id = Element1 -> key = ValidityTag_Element1).

Parameters:

id

ID of the element whose ValidityTag key should be generated.

Returns:

Key for the ValidityTag

Definition at line 367 of file freSessionComponentCache.cxx.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeValidityTag(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), and FREE::ComponentControllerBase< TControlledComponent >::GetValidityTag().

---

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

• freSessionComponentCache.h
• freSessionComponentCache.cxx

---