IGSTK
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | List of all members
igstk::MeshReader Class Reference

This class reads 3D Mesh in the metaIO format. More...

#include <igstkMeshReader.h>

Inheritance diagram for igstk::MeshReader:
Inheritance graph
[legend]
Collaboration diagram for igstk::MeshReader:
Collaboration graph
[legend]

Public Types

typedef SpatialObjectReader
< 3, float > 
SuperclassType
 Typedef for the superclass is needed because the StandardClassTraitsMacro would get confused with the commas in the template. More...
 
typedef
SpatialObjectType::ConstPointer 
SpatialObjectTypeConstPointer
 
typedef igstk::MeshObject MeshObjectType
 
- Public Types inherited from igstk::SpatialObjectReader< 3, float >
typedef
::itk::DefaultDynamicMeshTraits
< float, TDimension,
TDimension > 
MeshTraitsType
 
typedef
::itk::SpatialObjectReader
< TDimension, float,
MeshTraitsType
SpatialObjectReaderType
 
typedef ::itk::SpatialObject
< TDimension > 
SpatialObjectType
 
typedef
::itk::GroupSpatialObject
< TDimension > 
GroupSpatialObjectType
 
typedef std::string FileNameType
 Type for representing the string of the filename. More...
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

Public Member Functions

 igstkEventMacro (MeshReaderEvent, ObjectReaderEvent) igstkEventMacro(MeshReadingErrorEvent
 Event type. More...
 
- Public Member Functions inherited from igstk::SpatialObjectReader< 3, float >
void RequestSetFileName (const FileNameType &filename)
 Method to pass the directory name containing the spatial object data. More...
 
void RequestReadObject ()
 This method request Object read. More...
 
void RequestGetOutput ()
 This method will invoke a event from derived reader class, such as: MeshModifiedEvent for igstkMeshReader TubeModifiedEvent for igstkTubeReader. More...
 
 igstkEventMacro (ObjectReaderEvent, IGSTKEvent)
 
 igstkEventMacro (ObjectReadingErrorEvent, IGSTKErrorEvent)
 
 igstkEventMacro (ObjectReadingSuccessEvent, ObjectReaderEvent)
 
 igstkEventMacro (ObjectInvalidRequestErrorEvent, ObjectReadingErrorEvent)
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Public Attributes

igstkStandardClassTraitsMacro(MeshReader,
SuperclassType) public typedef
Superclass::GroupSpatialObjectType 
GroupSpatialObjectType
 Macro with standard traits declarations. More...
 
- Public Attributes inherited from igstk::SpatialObjectReader< 3, float >
igstkStandardTemplatedClassTraitsMacro(SpatialObjectReader,
Object) public typedef float 
PixelType
 Macro with standard traits declarations. More...
 

Protected Member Functions

 MeshReader (void)
 Declare the MeshReaderToMeshSpatialObject class to be a friend in order to give it access to the private method GetITKMesh(). More...
 
 ~MeshReader (void)
 
void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object information in a stream. More...
 
void AttemptReadObjectProcessing ()
 This method tries to read the Object. More...
 
void ReportObjectProcessing ()
 This method will invoke the MeshModifiedEvent. More...
 
void ConnectMesh ()
 Connect the ITK mesh to the output MeshSpatialObject. More...
 
- Protected Member Functions inherited from igstk::SpatialObjectReader< 3, float >
 SpatialObjectReader (void)
 
virtual ~SpatialObjectReader (void)
 
void PrintSelf (std::ostream &os,::itk::Indent indent) const
 Print the object information in a stream. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~Object (void)
 
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 
- Protected Attributes inherited from igstk::SpatialObjectReader< 3, float >
SpatialObjectReaderType::Pointer m_SpatialObjectReader
 
std::string m_FileNameToBeSet
 
std::string m_FileName
 

Detailed Description

This class reads 3D Mesh in the metaIO format.

The file describes a list of points corresponding to the nodes in the Mesh, and a list of links between the nodes. The output of this reader is of type MeshSpatialObject.

igstkMeshReader.png
Mesh Reader State Machine Diagram
See Also
MeshObject

Definition at line 70 of file igstkMeshReader.h.

Member Typedef Documentation

Typedef for the superclass is needed because the StandardClassTraitsMacro would get confused with the commas in the template.

Definition at line 77 of file igstkMeshReader.h.

typedef SpatialObjectType::ConstPointer igstk::MeshReader::SpatialObjectTypeConstPointer

Definition at line 87 of file igstkMeshReader.h.

Definition at line 88 of file igstkMeshReader.h.

Constructor & Destructor Documentation

igstk::MeshReader::MeshReader ( void  )
protected

Declare the MeshReaderToMeshSpatialObject class to be a friend in order to give it access to the private method GetITKMesh().

igstk::MeshReader::~MeshReader ( void  )
protected

Member Function Documentation

igstk::MeshReader::igstkEventMacro ( MeshReaderEvent  ,
ObjectReaderEvent   
)

Event type.

void igstk::MeshReader::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const
protectedvirtual

Print the object information in a stream.

Reimplemented from igstk::Object.

void igstk::MeshReader::AttemptReadObjectProcessing ( )
protectedvirtual

This method tries to read the Object.

This method is invoked by the State Machine of the superclass.

Reimplemented from igstk::SpatialObjectReader< 3, float >.

void igstk::MeshReader::ReportObjectProcessing ( )
protectedvirtual

This method will invoke the MeshModifiedEvent.

Reimplemented from igstk::SpatialObjectReader< 3, float >.

void igstk::MeshReader::ConnectMesh ( )
protected

Connect the ITK mesh to the output MeshSpatialObject.

Member Data Documentation

Macro with standard traits declarations.

Typedefs

Definition at line 80 of file igstkMeshReader.h.


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