itk::fem::LoadTest< TClass > Class Template Reference
#include <itkFEMLoadTest.h>
Detailed Description
template<class TClass>
class itk::fem::LoadTest< TClass >
Example to show how to define templated load classes.
- Note:
- The class must be instantiated, before the object factory can produce more objects of this class. Instantiate the specific derived classes with: "template class LoadTest<...>;" where required.
Definition at line 35 of file itkFEMLoadTest.h.
Public Types | |
| typedef FEMPArray< Self > | ArrayType |
| typedef Self | Baseclass |
| typedef const Self * | ConstPointer |
| typedef std::vector < Element::ConstPointer > | ElementPointersVectorType |
| typedef Element::Float | Float |
| typedef Self * | Pointer |
| typedef LoadTest | Self |
| typedef LoadElement | Superclass |
Public Member Functions | |
| virtual int | ClassID () const |
| virtual Baseclass::Pointer | Clone () const |
| LoadTest () | |
| virtual void | Read (std::istream &f, void *info) |
| void | Write (std::ostream &f) const |
| virtual Solution::ConstPointer | GetSolution () |
| virtual void | SetSolution (Solution::ConstPointer) |
Static Public Member Functions | |
| static FEMLightObject::Pointer | CreateFromStream (std::istream &f, void *info) |
| static Self::Pointer | New () |
| static void | SkipWhiteSpace (std::istream &f) |
Public Attributes | |
| TClass | data |
| int | GN |
Static Public Attributes | |
| static const int | CLID |
| static const std::string | whitespaces |
Member Typedef Documentation
typedef FEMPArray<Self> itk::fem::Load::ArrayType [inherited] |
Array class that holds special pointers to the load objects
Definition at line 42 of file itkFEMLoadBase.h.
typedef Self itk::fem::FEMLightObject::Baseclass [inherited] |
Store the base class typedef for easy access from derived classes. FEM_CLASS macro also expects this for the FEMOF...
Definition at line 64 of file itkFEMLightObject.h.
| typedef const Self* itk::fem::LoadTest< TClass >::ConstPointer |
Const pointer or SmartPointer to an object.
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
typedef std::vector<Element::ConstPointer> itk::fem::LoadElement::ElementPointersVectorType [inherited] |
Type of array of pointers to element objects
Definition at line 54 of file itkFEMLoadElementBase.h.
typedef Element::Float itk::fem::LoadElement::Float [inherited] |
Float type used in Element and derived classes
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, and itk::fem::ImageMetricLoad< TMoving, TFixed >.
Definition at line 49 of file itkFEMLoadElementBase.h.
| typedef Self* itk::fem::LoadTest< TClass >::Pointer |
Pointer or SmartPointer to an object.
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
| typedef LoadTest itk::fem::LoadTest< TClass >::Self |
Standard Self typedef.
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
| typedef LoadElement itk::fem::LoadTest< TClass >::Superclass |
Standard Superclass typedef.
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
Constructor & Destructor Documentation
| itk::fem::LoadTest< TClass >::LoadTest | ( | ) | [inline] |
Default constructor
Definition at line 43 of file itkFEMLoadTest.h.
Member Function Documentation
| virtual int itk::fem::LoadTest< TClass >::ClassID | ( | ) | const [inline, virtual] |
Virtual function to access the class ID
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
| virtual Baseclass::Pointer itk::fem::LoadTest< TClass >::Clone | ( | ) | const [virtual] |
Create a new object from the existing one
Reimplemented from itk::fem::LoadElement.
| static FEMLightObject::Pointer itk::fem::FEMLightObject::CreateFromStream | ( | std::istream & | f, | |
| void * | info | |||
| ) | [static, inherited] |
Read object of any derived type from stream.
This static function creates an object of a class, which is derived from FEMLightObject. The class of object is first determined from the stream, then the object of that class is constructed using the FEMObjectFactory. Finally the data for this object is read from the stream, by calling the Read() member function.
| virtual Solution::ConstPointer itk::fem::Load::GetSolution | ( | ) | [inline, virtual, inherited] |
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::LoadLandmark.
Definition at line 57 of file itkFEMLoadBase.h.
| static Self::Pointer itk::fem::LoadTest< TClass >::New | ( | void | ) | [inline, static] |
Object creation in an itk compatible way
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
| virtual void itk::fem::LoadTest< TClass >::Read | ( | std::istream & | f, | |
| void * | info | |||
| ) | [inline, virtual] |
pointers to element objects on which the load acts
Reimplemented from itk::fem::LoadElement.
Definition at line 50 of file itkFEMLoadTest.h.
References itk::fem::LoadElement::Read().
| virtual void itk::fem::Load::SetSolution | ( | Solution::ConstPointer | ) | [inline, virtual, inherited] |
Sets the pointer to solution vector. This function is automatically called by the Solver class on every load object.
Some types of external Loads may need access to previous values of solution vector. If a derived class needs that, it should implement this function, and store the passed pointer accordingly. If the result vector is not required, the functionn should be left unimplemented, so that only the dummy implementation in base class is called.
- Parameters:
-
ptr Pointer to the object of Solution class.
Reimplemented in itk::fem::FiniteDifferenceFunctionLoad< TMoving, TFixed >, itk::fem::ImageMetricLoad< TMoving, TFixed >, and itk::fem::LoadLandmark.
Definition at line 56 of file itkFEMLoadBase.h.
| static void itk::fem::FEMLightObject::SkipWhiteSpace | ( | std::istream & | f | ) | [static, inherited] |
Helper function that skips all the whitespace and comments in an input stream.
| void itk::fem::LoadTest< TClass >::Write | ( | std::ostream & | f | ) | const [inline, virtual] |
Write an object to the output stream. Call this member to write the data members in the current object to the output stream. Here we also need to know which derived class we actually are, so that we can write the class name. The class name is obtained by calling the virtual ClassID() member function and passing the result to the FEMObjectFactory.
Implementations of Write member funtion in derived classes should first call the parent's implementation of Write and finaly write whatever they need.
Reimplemented from itk::fem::LoadElement.
Definition at line 54 of file itkFEMLoadTest.h.
References itk::fem::LoadElement::Write().
Member Data Documentation
int itk::fem::LoadTest< TClass >::CLID [inline, static] |
Class ID for FEM object factory
Reimplemented from itk::fem::LoadElement.
Definition at line 37 of file itkFEMLoadTest.h.
| TClass itk::fem::LoadTest< TClass >::data |
Some data that this load defines.
Definition at line 48 of file itkFEMLoadTest.h.
int itk::fem::FEMLightObject::GN [inherited] |
Global number of an object (ID of an object) In general the ID's are required to be unique only within a specific type of derived classes (Elements, Nodes, ...) If the GN is not required, it can be ignored. (normally you need the GN when writing or reading objects to/from stream.
Definition at line 165 of file itkFEMLightObject.h.
Referenced by itk::fem::FEMLightObject::FEMLightObject().
const std::string itk::fem::FEMLightObject::whitespaces [static, inherited] |
Const string of all whitespace characters. This string is used by SkipWhiteSpace function.
Definition at line 135 of file itkFEMLightObject.h.
The documentation for this class was generated from the following file:
