ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor > Class Template Reference

#include <itkCellInterfaceVisitor.h>

+ Inheritance diagram for itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >:
+ Collaboration diagram for itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >:

Public Types

using CellIdentifier = typename TCellTraits::CellIdentifier
 
using Pointer = SmartPointer< Self >
 
using Self = CellInterfaceVisitorImplementation
 
- Public Types inherited from itk::CellInterfaceVisitor< TPixelType, TCellTraits >
using CellIdentifier = typename TCellTraits::CellIdentifier
 
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = CellInterfaceVisitor
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
CellGeometryEnum GetCellTopologyId () override
 
virtual const char * GetNameOfClass () const
 
void VisitFromCell (CellIdentifier cellId, CellInterface< TPixelType, TCellTraits > *c) override
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 CellInterfaceVisitorImplementation ()=default
 
 ~CellInterfaceVisitorImplementation () override=default
 
- Protected Member Functions inherited from itk::CellInterfaceVisitor< TPixelType, TCellTraits >
 CellInterfaceVisitor ()=default
 
 ~CellInterfaceVisitor () override=default
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Additional Inherited Members

- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

template<typename TPixelType, typename TCellTraits, typename CellTopology, typename UserVisitor>
class itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >

A template class used to implement a visitor object.

A template class used to implement a visitor object.

The Visitor implementation does the down cast to the specific cell type that is being visited. After the cast, a member of the UserVisitor type called Visit is passed the exact cell type being visited. To use this class, write a class that implements a function Visit(int id, CellTopology*). Then, use that as the UserVisitor template parameter.

Template parameters for CellInterfaceVisitorImplementation: TPixelType = see CellInterface

TCellTraits = see CellInterface

CellTopology = The specific type of cell that needs to be visited.

UserVisitor = A user supplied class that implements the function Visit(int id, CellTopology*)

Examples
Examples/DataRepresentation/Mesh/MeshCellVisitor.cxx, Examples/DataRepresentation/Mesh/MeshCellVisitor2.cxx, and SphinxExamples/src/Core/Mesh/ConvertMeshToUnstructeredGrid/Code.cxx.

Definition at line 100 of file itkCellInterfaceVisitor.h.

Member Typedef Documentation

◆ CellIdentifier

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
using itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::CellIdentifier = typename TCellTraits::CellIdentifier

Definition at line 110 of file itkCellInterfaceVisitor.h.

◆ Pointer

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
using itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::Pointer = SmartPointer<Self>

Definition at line 109 of file itkCellInterfaceVisitor.h.

◆ Self

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
using itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::Self = CellInterfaceVisitorImplementation

Standard class type aliases.

Definition at line 108 of file itkCellInterfaceVisitor.h.

Constructor & Destructor Documentation

◆ CellInterfaceVisitorImplementation()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::CellInterfaceVisitorImplementation ( )
protecteddefault

◆ ~CellInterfaceVisitorImplementation()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::~CellInterfaceVisitorImplementation ( )
overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
virtual::itk::LightObject::Pointer itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightObject.

◆ GetCellTopologyId()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
CellGeometryEnum itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::GetCellTopologyId ( )
inlineoverridevirtual

Call the static method GetTopologyId for the CellTopology type that we are templated over.

Implements itk::CellInterfaceVisitor< TPixelType, TCellTraits >.

Definition at line 121 of file itkCellInterfaceVisitor.h.

◆ GetNameOfClass()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
virtual const char* itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::CellInterfaceVisitor< TPixelType, TCellTraits >.

◆ New()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
static Pointer itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::New ( )
static

Method for creation through the object factory.

◆ VisitFromCell()

template<typename TPixelType , typename TCellTraits , typename CellTopology , typename UserVisitor >
void itk::CellInterfaceVisitorImplementation< TPixelType, TCellTraits, CellTopology, UserVisitor >::VisitFromCell ( CellIdentifier  cellId,
CellInterface< TPixelType, TCellTraits > *  c 
)
inlineoverridevirtual

Call the method Visit from the UserVisitor template parameter that this class inherits from. I am my own gradpa...

Implements itk::CellInterfaceVisitor< TPixelType, TCellTraits >.

Definition at line 129 of file itkCellInterfaceVisitor.h.


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