ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::PolygonGroupSpatialObjectXMLFileReader Class Reference

#include <itkPolygonGroupSpatialObjectXMLFile.h>

+ Inheritance diagram for itk::PolygonGroupSpatialObjectXMLFileReader:
+ Collaboration diagram for itk::PolygonGroupSpatialObjectXMLFileReader:

Public Types

using GroupSpatialObjectType = GroupSpatialObject< 3 >
 
using GroupType = GroupSpatialObjectType
 
using Pointer = SmartPointer< Self >
 
using PolygonPointListType = std::vector< PolygonPointType >
 
using PolygonPointType = SpatialObjectPoint< 3 >
 
using PolygonSpatialObjectType = PolygonSpatialObject< 3 >
 
using Self = PolygonGroupSpatialObjectXMLFileReader
 
using Superclass = XMLReader< GroupSpatialObject< 3 > >
 
- Public Types inherited from itk::XMLReader< GroupSpatialObject< 3 > >
using Self = XMLReader
 
- Public Types inherited from itk::XMLReaderBase
using Self = XMLReaderBase
 
- Public Types inherited from itk::LightProcessObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

int CanReadFile (const char *name) override
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::XMLReader< GroupSpatialObject< 3 > >
GroupSpatialObject< 3 > * GetOutputObject ()
 
void SetOutputObject (GroupSpatialObject< 3 > *obj)
 
- Public Member Functions inherited from itk::XMLReaderBase
virtual void GenerateOutputInformation ()
 
virtual const char * GetFilename () const
 
virtual void SetFilename (const char *_arg)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float amount)
 
virtual void UpdateOutputData ()
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- 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
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void CharacterDataHandler (const char *inData, int inLength) override
 
void EndElement (const char *name) override
 
 PolygonGroupSpatialObjectXMLFileReader ()=default
 
void StartElement (const char *name, const char **atts) override
 
 ~PolygonGroupSpatialObjectXMLFileReader () override=default
 
- Protected Member Functions inherited from itk::XMLReader< GroupSpatialObject< 3 > >
 XMLReader ()
 
 ~XMLReader () override=default
 
- Protected Member Functions inherited from itk::XMLReaderBase
void parse ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 XMLReaderBase ()=default
 
 ~XMLReaderBase () override=default
 
- Protected Member Functions inherited from itk::LightProcessObject
 LightProcessObject ()
 
 ~LightProcessObject () override
 
virtual void GenerateData ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Private Attributes

std::string m_CurCharacterData
 
PolygonPointListType m_CurPointList
 
PolygonSpatialObjectType::Pointer m_CurPoly
 
GroupSpatialObjectType::Pointer m_Group
 

Additional Inherited Members

- Protected Attributes inherited from itk::XMLReader< GroupSpatialObject< 3 > >
GroupSpatialObject< 3 > * m_OutputObject
 
- Protected Attributes inherited from itk::XMLReaderBase
std::string m_Filename
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

Detailed Description

Reads an XML-format file containing a list of polygons, and creates a corresponding PolygonGroupSpatialObject

Definition at line 34 of file itkPolygonGroupSpatialObjectXMLFile.h.

Member Typedef Documentation

◆ GroupSpatialObjectType

Definition at line 44 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ GroupType

Definition at line 46 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ Pointer

Definition at line 42 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ PolygonPointListType

Definition at line 49 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ PolygonPointType

Definition at line 48 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ PolygonSpatialObjectType

Definition at line 47 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ Self

Standard type alias

Definition at line 40 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ Superclass

Definition at line 41 of file itkPolygonGroupSpatialObjectXMLFile.h.

Constructor & Destructor Documentation

◆ PolygonGroupSpatialObjectXMLFileReader()

itk::PolygonGroupSpatialObjectXMLFileReader::PolygonGroupSpatialObjectXMLFileReader ( )
protecteddefault

◆ ~PolygonGroupSpatialObjectXMLFileReader()

itk::PolygonGroupSpatialObjectXMLFileReader::~PolygonGroupSpatialObjectXMLFileReader ( )
overrideprotecteddefault

Member Function Documentation

◆ CanReadFile()

int itk::PolygonGroupSpatialObjectXMLFileReader::CanReadFile ( const char *  name)
overridevirtual

Determine if a file can be read

Implements itk::XMLReaderBase.

◆ CharacterDataHandler()

void itk::PolygonGroupSpatialObjectXMLFileReader::CharacterDataHandler ( const char *  inData,
int  inLength 
)
overrideprotectedvirtual

Callback function – called from XML parser with the character data for an XML element

Implements itk::XMLReaderBase.

◆ CreateAnother()

virtual::itk::LightObject::Pointer itk::PolygonGroupSpatialObjectXMLFileReader::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::LightProcessObject.

◆ EndElement()

void itk::PolygonGroupSpatialObjectXMLFileReader::EndElement ( const char *  name)
overrideprotectedvirtual

Callback function – called from XML parser when ending tag encountered

Implements itk::XMLReaderBase.

◆ GetNameOfClass()

virtual const char* itk::PolygonGroupSpatialObjectXMLFileReader::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

◆ New()

static Pointer itk::PolygonGroupSpatialObjectXMLFileReader::New ( )
static

Method for creation through the object factory.

◆ StartElement()

void itk::PolygonGroupSpatialObjectXMLFileReader::StartElement ( const char *  name,
const char **  atts 
)
overrideprotectedvirtual

Callback function – called from XML parser with start-of-element information.

Implements itk::XMLReaderBase.

Member Data Documentation

◆ m_CurCharacterData

std::string itk::PolygonGroupSpatialObjectXMLFileReader::m_CurCharacterData
private

Definition at line 79 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ m_CurPointList

PolygonPointListType itk::PolygonGroupSpatialObjectXMLFileReader::m_CurPointList
private

Definition at line 78 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ m_CurPoly

PolygonSpatialObjectType::Pointer itk::PolygonGroupSpatialObjectXMLFileReader::m_CurPoly
private

Definition at line 77 of file itkPolygonGroupSpatialObjectXMLFile.h.

◆ m_Group

GroupSpatialObjectType::Pointer itk::PolygonGroupSpatialObjectXMLFileReader::m_Group
private

Definition at line 76 of file itkPolygonGroupSpatialObjectXMLFile.h.


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