EpetraExt  Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Types | Protected Attributes | List of all members
EpetraExt::Transform_Composite< T > Class Template Reference

Composition Class for Epetra Transform SameType Operators. More...

#include <EpetraExt_Transform_Composite.h>

Inheritance diagram for EpetraExt::Transform_Composite< T >:
Inheritance graph
[legend]

Public Types

typedef SameTypeTransform< T > * TransformTypePtr
 
- Public Types inherited from EpetraExt::SameTypeTransform< T >
typedef T TransformType
 
typedef T * TransformTypePtr
 
typedef T & TransformTypeRef
 
- Public Types inherited from EpetraExt::Transform< T, T >
typedef T OriginalType
 
typedef T * OriginalTypePtr
 
typedef Teuchos::RCP< T > OriginalTypeRCP
 
typedef T & OriginalTypeRef
 
typedef T NewType
 
typedef T * NewTypePtr
 
typedef Teuchos::RCP< T > NewTypeRCP
 
typedef T & NewTypeRef
 

Public Member Functions

 Transform_Composite ()
 EpetraExt::Transform_Composite Constructor. More...
 
virtual ~Transform_Composite ()
 EpetraExt::Transform_Composite Destructor. More...
 
void addTransform (TransformTypePtr new_trans)
 Transform Addition. More...
 
virtual Transform (typename Transform< T, T >::OriginalTypeRef orig)
 Analysis phase generates plan and check feasibility. More...
 
virtual bool fwd ()
 Forward Data Transfer. More...
 
virtual bool rvs ()
 
- Public Member Functions inherited from EpetraExt::SameTypeTransform< T >
virtual ~SameTypeTransform ()
 
- Public Member Functions inherited from EpetraExt::Transform< T, T >
virtual ~Transform ()
 
virtual NewTypeRef operator() (OriginalTypeRef orig)=0
 Analysis of transform operation on original object and construction of new object. More...
 
virtual bool analyze (OriginalTypeRef orig)
 Initial analysis phase of transform. More...
 
virtual NewTypeRef construct ()
 Construction of new object as a result of the transform. More...
 
virtual bool isConstructed ()
 Check for whether transformed object has been constructed. More...
 

Protected Types

typedef std::list
< TransformTypePtr >::iterator 
TransListIter
 
typedef std::list
< TransformTypePtr >
::reverse_iterator 
TransListRvsIter
 

Protected Attributes

std::list< TransformTypePtrtransList_
 
- Protected Attributes inherited from EpetraExt::Transform< T, T >
OriginalTypePtr origObj_
 
NewTypePtr newObj_
 

Additional Inherited Members

- Protected Member Functions inherited from EpetraExt::Transform< T, T >
 Transform ()
 Default constructor, protected to allow only derived classes to use. More...
 

Detailed Description

template<typename T>
class EpetraExt::Transform_Composite< T >

Composition Class for Epetra Transform SameType Operators.

This class allows SameType Transforms to be composed as a single Transform.

Definition at line 60 of file EpetraExt_Transform_Composite.h.

Member Typedef Documentation

template<typename T >
typedef SameTypeTransform<T>* EpetraExt::Transform_Composite< T >::TransformTypePtr

Definition at line 65 of file EpetraExt_Transform_Composite.h.

template<typename T >
typedef std::list<TransformTypePtr>::iterator EpetraExt::Transform_Composite< T >::TransListIter
protected

Definition at line 109 of file EpetraExt_Transform_Composite.h.

template<typename T >
typedef std::list<TransformTypePtr>::reverse_iterator EpetraExt::Transform_Composite< T >::TransListRvsIter
protected

Definition at line 110 of file EpetraExt_Transform_Composite.h.

Constructor & Destructor Documentation

template<typename T >
EpetraExt::Transform_Composite< T >::Transform_Composite ( )
inline

EpetraExt::Transform_Composite Constructor.

Definition at line 68 of file EpetraExt_Transform_Composite.h.

template<typename T >
EpetraExt::Transform_Composite< T >::~Transform_Composite ( )
virtual

EpetraExt::Transform_Composite Destructor.

Definition at line 118 of file EpetraExt_Transform_Composite.h.

Member Function Documentation

template<typename T >
void EpetraExt::Transform_Composite< T >::addTransform ( TransformTypePtr  new_trans)

Transform Addition.

Add SameType Transform to composition. Order of Addition == Order of Application

Definition at line 128 of file EpetraExt_Transform_Composite.h.

template<typename T >
virtual EpetraExt::Transform_Composite< T >::Transform ( typename Transform< T, T >::OriginalTypeRef  orig)
virtual

Analysis phase generates plan and check feasibility.

Analysis of transform operation on original object and construction of new object.

Returns
Returns a pointer to the newly created object of type NewTypePtr. The Transform object maintains ownership of this new object and deletes as a part of it's destruction.
template<typename T >
bool EpetraExt::Transform_Composite< T >::fwd ( )
virtual

Forward Data Transfer.

Forward transfer of data from orig object input in the operator() method call to the new object created in this same call. Returns true is operation is successful.

Implements EpetraExt::Transform< T, T >.

Definition at line 153 of file EpetraExt_Transform_Composite.h.

template<typename T >
bool EpetraExt::Transform_Composite< T >::rvs ( )
virtual

Reverse transfer of data from new object created in the operator() method call to the orig object input to this same method. Returns true if operation is successful.

Implements EpetraExt::Transform< T, T >.

Definition at line 168 of file EpetraExt_Transform_Composite.h.

Member Data Documentation

template<typename T >
std::list<TransformTypePtr> EpetraExt::Transform_Composite< T >::transList_
protected

Definition at line 112 of file EpetraExt_Transform_Composite.h.


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