mial::Beh_UniformScale< Type, nDims > Class Template Reference

#include <Beh_UniformScale.h>

Inheritance diagram for mial::Beh_UniformScale< Type, nDims >:


Public Types
typedef Beh_UniformScale	Self
typedef itk::SmartPointer< Self >	Pointer
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::WeakPointer< const Self >	ConstWeakPointer
typedef Behavior< Type, nDims >::Error	Error
Public Member Functions
virtual bool	run (typename Behavior< Type, nDims >::behaviorIn i, std::stringstream s)
	Example run method that scales the organism.
bool	isFinished ()
virtual bool	update ()
	Public pure virtual function. This method allows behaviors to run in multiple stages.
virtual void	cleanUp ()
	Public pure virtual function. Method of cleaning up after the behavior.
Public Attributes
double	startTime
	Internal recording of when the behavior started running.
double	endTime
	Internal recording of when the behavior is set to end.
Protected Member Functions
	Beh_UniformScale ()
Classes
struct	behaviorIn
	A structure defining the inputs for the behavior. More...

Detailed Description

template<class Type, int nDims>
class mial::Beh_UniformScale< Type, nDims >

A derived class of the behavioral ABC this class performs a uniform scaling of the deformable organism with user provided duration and magnitude. The power of the framework is demonstrated here in that by eliciting its attached physics layer's scale deformation this behavior may be performed on any physics layer providing that deformation.

This behavior does not have any sub-behaviors.

Parameters:

	Type	the internal type used for storage
	nDims	the number of dimensions

Definition at line 24 of file Beh_UniformScale.h.

Member Function Documentation

template<class Type, int nDims>

void mial::Beh_UniformScale< Type, nDims >::cleanUp ( ) [virtual]

Public pure virtual function. Method of cleaning up after the behavior.

Since behaviors may be ran multiple times before being destructed they must provide a method to clean up for the next run. This method will be ran after the behavior asserts itself as finished.

Implements mial::Behavior< Type, nDims >.

Definition at line 56 of file Beh_UniformScale.cxx.

References mial::Beh_UniformScale< Type, nDims >::endTime, and mial::Beh_UniformScale< Type, nDims >::startTime.

template<class Type, int nDims>

virtual bool mial::Beh_UniformScale< Type, nDims >::update ( ) [inline, virtual]

Public pure virtual function. This method allows behaviors to run in multiple stages.

This method will be ran after the run method, until the isFinished() returns true.

Implements mial::Behavior< Type, nDims >.

Definition at line 76 of file Beh_UniformScale.h.

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