Main Page
Groups
Namespace List
Class Hierarchy
Alphabetical List
Compound List
File
List
Namespace Members
Compound Members
File Members
Concepts
Base class defines an API for classes that generate an ordered sequence of filenames.
More...
#include <itkFileIteratorBase.h>
Inheritance diagram for itk::FileIteratorBase:
[legend]Collaboration diagram for itk::FileIteratorBase:
[legend]List of all members.
Detailed Description
Base class defines an API for classes that generate an ordered sequence of filenames.
FileIteratorBase is a base class for those classes that are used by the ImageSeriesReader and ImageSeriesWriter to read or write a sequence of files. FileIteratorBase defines an API that generates an ordered sequence of filenames that are in turn used by subclasses of ImageIOBase (and similar classes) to read and write data.
To use FileIteratorBase you must specify whether the instance is in read or write mode. (This affects the generation of filename. In read mode, files are assumed to exist. In write mode, filesnames are generated and probably do not initially exist.)
Definition at line 48 of file itkFileIteratorBase.h.
Member Typedef Documentation
Constructor & Destructor Documentation
| itk::FileIteratorBase::FileIteratorBase |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const std::string& itk::FileIteratorBase::Begin |
( |
|
) |
[pure virtual] |
|
|
|
Return the first file in the sequence. If the empty string "" is returned, then there are no files in the sequence. |
| virtual const char* itk::FileIteratorBase::GetClassName |
( |
|
) |
const [virtual] |
|
|
|
Run-time type information (and related methods).
Reimplemented from itk::Object.
|
| virtual const char* itk::FileIteratorBase::GetSeriesFormat |
( |
|
) |
const [virtual] |
|
|
|
The format string used to generate the series. Different subclasses require different characteristics of this string. For example, the subclass NumericSeriesFileIterator requires a "%d" or some integral format specified to be embedded in the string. |
| virtual bool itk::FileIteratorBase::GetWriteMode |
( |
|
) |
[virtual] |
|
|
|
Set the modal behavior of the class: whether it is to be used to write a sequence of files, or read a sequence of existing files. Normally this is set by the ImageSeriesReader or ImageSeriesWriter. |
| virtual const std::string& itk::FileIteratorBase::operator * |
( |
|
) |
const [inline, virtual] |
|
|
|
Return the current filename in the sequence. If the empty string "" is returned, then there are no current file in the sequence. Definition at line 90 of file itkFileIteratorBase.h. |
| virtual const std::string& itk::FileIteratorBase::operator++ |
( |
|
) |
[pure virtual] |
|
|
|
Return the next file in the sequence. If the empty string "" is returned, then there are no additional files in the sequence. |
| virtual const std::string& itk::FileIteratorBase::operator-- |
( |
|
) |
[pure virtual] |
|
|
|
Return the previous file in the sequence. If the empty string "" is returned, then there are no previous files in the sequence. |
| void itk::FileIteratorBase::PrintSelf |
( |
std::ostream & |
os, |
|
|
Indent |
indent |
|
) |
const [protected, virtual] |
|
|
|
Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from itk::Object.
|
| virtual void itk::FileIteratorBase::SetSeriesFormat |
( |
const char * |
_arg |
) |
[virtual] |
|
|
|
The format string used to generate the series. Different subclasses require different characteristics of this string. For example, the subclass NumericSeriesFileIterator requires a "%d" or some integral format specified to be embedded in the string. |
| virtual void itk::FileIteratorBase::SetWriteMode |
( |
bool |
_arg |
) |
[virtual] |
|
|
|
Set the modal behavior of the class: whether it is to be used to write a sequence of files, or read a sequence of existing files. Normally this is set by the ImageSeriesReader or ImageSeriesWriter. |
| virtual void itk::FileIteratorBase::WriteModeOff |
( |
|
) |
[virtual] |
|
|
|
Set the modal behavior of the class: whether it is to be used to write a sequence of files, or read a sequence of existing files. Normally this is set by the ImageSeriesReader or ImageSeriesWriter. |
| virtual void itk::FileIteratorBase::WriteModeOn |
( |
|
) |
[virtual] |
|
|
|
Set the modal behavior of the class: whether it is to be used to write a sequence of files, or read a sequence of existing files. Normally this is set by the ImageSeriesReader or ImageSeriesWriter. |
Member Data Documentation
The documentation for this class was generated from the following file:
Generated at Sat Mar 31 03:02:01 2007 for ITK by 
1.3.8 written by Dimitri van Heesch,
© 1997-2000