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

Class used as a tag to indicate validity. More...

#include <freValidityTag.h>

List of all members.

Public Types
typedef ValidityTag	Self
typedef itk::LightObject	Superclass
typedef itk::SmartPointer < Self >	Pointer
typedef itk::SmartPointer < const Self >	ConstPointer
typedef clock_t	TagType
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
bool	IsOutdated (const ValidityTag &referenceTag) const
bool	IsOutdated (const ValidityTag *pReferenceTag) const
bool	IsUpdated (const ValidityTag &referenceTag) const
bool	IsUpdated (const ValidityTag *pReferenceTag) const
bool	Equals (const ValidityTag &referenceTag) const
bool	Equals (const ValidityTag *pReferenceTag) const
void	Actualize ()
void	SetTag (const ValidityTag &tag)
void	SetTag (const ValidityTag *pTag)
void	SetTimeStamp (const TagType &tag)
const TagType &	GetTimeStamp () const
Static Public Member Functions
static Pointer	New (void)
static Pointer	New (const ValidityTag &tag)
static Pointer	New (const TagType &tag)
static Pointer	NewNull ()
Protected Member Functions
	ValidityTag ()
Protected Attributes
TagType	m_Tag

---

Detailed Description

Class used as a tag to indicate validity.

ValidityTags are used by controller to control and manage the validity of controlled parameters or media associated with the controlled component. Internal it is a time stamp and a later time stamp has a higher validity respectively others are outdated compared to the later time stamp.

Definition at line 42 of file freValidityTag.h.

---

Member Typedef Documentation

typedef ValidityTag FREE::ValidityTag::Self

Definition at line 45 of file freValidityTag.h.

typedef itk::LightObject FREE::ValidityTag::Superclass

Definition at line 46 of file freValidityTag.h.

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

Definition at line 47 of file freValidityTag.h.

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

Definition at line 48 of file freValidityTag.h.

typedef clock_t FREE::ValidityTag::TagType

Definition at line 50 of file freValidityTag.h.

---

Constructor & Destructor Documentation

FREE::ValidityTag::ValidityTag

(

)

[protected]

Definition at line 141 of file freValidityTag.cxx.

References Actualize().

Here is the call graph for this function:

---

Member Function Documentation

virtual const char* FREE::ValidityTag::GetNameOfClass

(

)

const [inline, virtual]

Definition at line 52 of file freValidityTag.h.

static Pointer FREE::ValidityTag::New

(

void

)

[inline, static]

Definition at line 53 of file freValidityTag.h.

Referenced by FREE::ComponentControllerBase< TControlledComponent >::ActualizeMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::ActualizeParameterValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::ActualizeValidityTag(), FREE::WarpImageFilterControllerBase< FREE::ImageTypes< 3 >::InternalImageType, FREE::ImageTypes< 3 >::TransformationFieldType >::GetMediaValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetMediaValidityTagRequirement(), FREE::ResampleImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::GetMediaValidityTagRequirement(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetMediaValidityTagRequirement(), FREE::ParameterListMediaController::GetMediaValidityTagRequirement(), FREE::MediaActualizerController::GetMediaValidityTagRequirement(), FREE::ImageToImageFilterControllerBase< TControlledFilter >::GetMediaValidityTagRequirement(), FREE::ImageMediaControllerBase< TImage >::GetMediaValidityTagRequirement(), FREE::FEMRegistrationControllerBase< FREE::FEMRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::DemonRegistrationControllerBase< FREE::DemonRegistrationProcessor >::GetMediaValidityTagRequirement(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetMediaValidityTagRequirement(), FREE::CheckerBoardImageFilterControllerBase< FREE::ImageTypes< 2 >::InternalImageType >::GetMediaValidityTagRequirement(), FREE::BinaryFunctorImageFilterControllerBase< TControlledFilter >::GetMediaValidityTagRequirement(), FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::GetValidityTagRequirement(), New(), and NewNull().

virtual ::itk::LightObject::Pointer FREE::ValidityTag::CreateAnother

(

void

)

const [inline, virtual]

Definition at line 53 of file freValidityTag.h.

ValidityTag::Pointer FREE::ValidityTag::New

(

const ValidityTag &

tag

)

[static]

Smartpointer constructor that copies the tag

Parameters:

tag

ValidityTag that is source for the copy operation

Implementation of FREE::ValidityTag ////////////////////////////////

Definition at line 34 of file freValidityTag.cxx.

References New().

Here is the call graph for this function:

ValidityTag::Pointer FREE::ValidityTag::New

(

const TagType &

tag

)

[static]

Smartpointer constructor that initializes the ValidityTag with the passed time stamp.

Parameters:

tag

Time stamp that is used to initialize the validity tag.

Definition at line 43 of file freValidityTag.cxx.

References New().

Here is the call graph for this function:

ValidityTag::Pointer FREE::ValidityTag::NewNull

(

)

[static]

Smartpointer constructor that initializes the ValidityTag with the time stamp 0. Therfore the ValidityTag is always lower than all other normal ValidityTag and will not out date any other tag.

Definition at line 52 of file freValidityTag.cxx.

References New().

Referenced by FREE::RigidRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), FREE::PointSetRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), FREE::MediaControllerBase< TMedia >::BuildMainComponent(), FREE::ClosedFormRegistrationControllerBase< TControlledRigidProcessor >::BuildMainComponent(), FREE::MediaActualizerController::GetMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::GetMediaValidityTag(), FREE::ComponentControllerBase< TControlledComponent >::GetParameterValidityTag(), and FREE::ComponentControllerBase< TControlledComponent >::GetValidityTag().

Here is the call graph for this function:

bool FREE::ValidityTag::IsOutdated

(

const ValidityTag &

referenceTag

)

const

Checks if this is outdated compared to the passed reference tag.

Parameters:

referenceTag

Tag that serves as reference

Returns:

If this is outdated the return is true. IF this is up to date (thus equals or is more up to date than the reference) the return will be false.

Definition at line 61 of file freValidityTag.cxx.

References GetTimeStamp(), and m_Tag.

Referenced by FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), and IsOutdated().

Here is the call graph for this function:

bool FREE::ValidityTag::IsOutdated

(

const ValidityTag *

pReferenceTag

)

const

Definition at line 82 of file freValidityTag.cxx.

References IsOutdated(), and throwStaticExceptionMacro.

Here is the call graph for this function:

bool FREE::ValidityTag::IsUpdated

(

const ValidityTag &

referenceTag

)

const

Checks if this is updated compared to the passed reference tag.

Parameters:

referenceTag

Tag that serves as reference

Returns:

If this is updated (thus equals or is more up to date than the reference) the return is true. IF this is outdate the return will be false.

Definition at line 68 of file freValidityTag.cxx.

References GetTimeStamp(), and m_Tag.

Referenced by IsUpdated().

Here is the call graph for this function:

bool FREE::ValidityTag::IsUpdated

(

const ValidityTag *

pReferenceTag

)

const

Definition at line 90 of file freValidityTag.cxx.

References IsUpdated(), and throwStaticExceptionMacro.

Here is the call graph for this function:

bool FREE::ValidityTag::Equals

(

const ValidityTag &

referenceTag

)

const

Checks if this is equal compared to the passed reference tag.

Parameters:

referenceTag

Tag that serves as reference

Returns:

If this is equal the return is true.

Definition at line 75 of file freValidityTag.cxx.

References GetTimeStamp(), and m_Tag.

Referenced by Equals().

Here is the call graph for this function:

bool FREE::ValidityTag::Equals

(

const ValidityTag *

pReferenceTag

)

const

Definition at line 98 of file freValidityTag.cxx.

References Equals(), and throwStaticExceptionMacro.

Here is the call graph for this function:

void FREE::ValidityTag::Actualize

(

)

Actualizes the ValidityTag to now.

Definition at line 135 of file freValidityTag.cxx.

References m_Tag.

Referenced by ValidityTag().

void FREE::ValidityTag::SetTag

(

const ValidityTag &

tag

)

Sets the ValidityTag to the passed tag.

Definition at line 106 of file freValidityTag.cxx.

References GetTimeStamp(), and m_Tag.

Referenced by FREE::ProcessorControllerBase< TControlledProcessor >::CompareValidityTagRequirement(), and SetTag().

Here is the call graph for this function:

void FREE::ValidityTag::SetTag

(

const ValidityTag *

pTag

)

Definition at line 113 of file freValidityTag.cxx.

References SetTag(), and throwStaticExceptionMacro.

Here is the call graph for this function:

void FREE::ValidityTag::SetTimeStamp

(

const TagType &

tag

)

Sets the ValidityTag via the passed time stamp.

Definition at line 121 of file freValidityTag.cxx.

References m_Tag.

const ValidityTag::TagType & FREE::ValidityTag::GetTimeStamp

(

)

const

Returns the internal tag.

Definition at line 128 of file freValidityTag.cxx.

References m_Tag.

Referenced by Equals(), IsOutdated(), IsUpdated(), and SetTag().

---

Member Data Documentation

TagType FREE::ValidityTag::m_Tag [protected]

Internal time stamp the defines the status of the ValidityTag

Definition at line 106 of file freValidityTag.h.

Referenced by Actualize(), Equals(), GetTimeStamp(), IsOutdated(), IsUpdated(), SetTag(), and SetTimeStamp().

---

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

• freValidityTag.h
• freValidityTag.cxx

---