Shapeworks Studio  2.1
Shape analysis software suite
List of all members | Public Types | Public Member Functions
itk::PSMProjectReader Class Reference

This class is a reader for PSMProjects. More...

#include <itkPSMProjectReader.h>

+ Inheritance diagram for itk::PSMProjectReader:
+ Collaboration diagram for itk::PSMProjectReader:

Public Types

typedef PSMProjectReader Self
 
typedef PSMDOMNodeXMLReader Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef Superclass::DOMNodeType DOMNodeType
 
typedef Superclass::DOMNodePointer DOMNodePointer
 
- Public Types inherited from itk::PSMDOMNodeXMLReader
typedef PSMDOMNodeXMLReader Self
 
typedef Object Superclass
 
typedef SmartPointer< SelfPointer
 
typedef SmartPointer< const SelfConstPointer
 
typedef PSMDOMNode DOMNodeType
 
typedef DOMNodeType::Pointer DOMNodePointer
 

Public Member Functions

 itkNewMacro (Self)
 
 itkTypeMacro (PSMProjectReader, PSMDOMNodeXMLReader)
 
 itkGetObjectMacro (Output, PSMProject)
 
 itkSetObjectMacro (Output, PSMProject)
 
 itkGetConstObjectMacro (Output, PSMProject)
 
virtual void Update ()
 
- Public Member Functions inherited from itk::PSMDOMNodeXMLReader
 itkNewMacro (Self)
 
 itkTypeMacro (PSMDOMNodeXMLReader, Object)
 
 itkSetStringMacro (FileName)
 
 itkGetStringMacro (FileName)
 
 itkSetObjectMacro (DOMNode, DOMNodeType)
 
 itkGetObjectMacro (DOMNode, DOMNodeType)
 
 itkGetConstObjectMacro (DOMNode, DOMNodeType)
 
void Update (std::istream &is)
 
virtual void StartElement (const char *name, const char **atts)
 
virtual void EndElement (const char *name)
 
virtual void CharacterDataHandler (const char *text, int len)
 

Detailed Description

This class is a reader for PSMProjects.

The following code illustrates how to use this class to read a PSMProject from a file:

Note: Though this class behaves similar to ProcessObject, it is not derived from ProcessObject. This is because the output of this class, i.e. a PSMProject object, is not an image and cannot be connected to an ITK process pipeline.

Definition at line 41 of file itkPSMProjectReader.h.

Member Typedef Documentation

typedef Superclass::DOMNodeType itk::PSMProjectReader::DOMNodeType

Some convenient typedefs

Definition at line 57 of file itkPSMProjectReader.h.

Standard class typedefs.

Definition at line 45 of file itkPSMProjectReader.h.

Member Function Documentation

itk::PSMProjectReader::itkGetObjectMacro ( Output  ,
PSMProject   
)

Get the project data structure generated after calling Update().

itk::PSMProjectReader::itkNewMacro ( Self  )

Method for creation through the object factory.

itk::PSMProjectReader::itkTypeMacro ( PSMProjectReader  ,
PSMDOMNodeXMLReader   
)

Run-time type information (and related methods).

void itk::PSMProjectReader::Update ( )
virtual

Execute the reader.

Reimplemented from itk::PSMDOMNodeXMLReader.

Definition at line 28 of file itkPSMProjectReader.cxx.

29 {
30  // Have the parent class parse the XML file
32 
33  DOMNodeType* dom = this->GetDOMNode();
34 
35  if (dom == 0)
36  {
37  itkExceptionMacro( "Failed to parse the XML file." );
38  }
39  else
40  {
41  // Allocate a new PSM Project.
42  m_Output = PSMProject::New();
43  m_Output->SetDOMNode(dom);
44  }
45 }
Superclass::DOMNodeType DOMNodeType

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