itk::Directory Class Reference

#include <itkDirectory.h>

Inheritance diagram for itk::Directory:

Collaboration diagram for itk::Directory:

Detailed Description

Portable directory/filename traversal.

itk::Directory provides a portable way of finding the names of the files in a system directory.

itk::Directory works with Windows and Unix (POSIX) operating systems.

See also itksys::Directory

Definition at line 39 of file itkDirectory.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Directory
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
const char *	GetFile (unsigned int index)
virtual const char *	GetNameOfClass () const
std::vector< std::string > ::size_type	GetNumberOfFiles ()
bool	Load (const char *dir)
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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 noexceptoverride
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::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
	Directory ()
void	PrintSelf (std::ostream &os, Indent indent) const override
	~Directory () override
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &time)
	~Object () override
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
::itksys::Directory *	m_Internal

Additional Inherited Members
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

Member Typedef Documentation

using itk::Directory::ConstPointer = SmartPointer< const Self >

Definition at line 48 of file itkDirectory.h.

using itk::Directory::Pointer = SmartPointer< Self >

Definition at line 47 of file itkDirectory.h.

using itk::Directory::Self = Directory

Standard class type aliases.

Definition at line 45 of file itkDirectory.h.

using itk::Directory::Superclass = Object

Definition at line 46 of file itkDirectory.h.

Constructor & Destructor Documentation

itk::Directory::Directory ( )

protected

itk::Directory::~Directory ( )

overrideprotected

Member Function Documentation

const char* itk::Directory::GetFile

(

unsigned int

index

)

Return the file at the given index, the indexing is 0 based

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

virtual

Return the class name as a string.

Reimplemented from itk::Object.

std::vector< std::string >::size_type itk::Directory::GetNumberOfFiles

(

)

Return the number of files in the current directory.

bool itk::Directory::Load

(

const char *

dir

)

Load the specified directory and load the names of the files in that directory. 0 is returned if the directory can not be opened, 1 if it is opened.

static Pointer itk::Directory::New ( )

inlinestatic

Method for creation through the object factory.

Definition at line 51 of file itkDirectory.h.

References itk::SmartPointer< TObjectType >::UnRegister().

void itk::Directory::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

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::LightObject.

Member Data Documentation

::itksys::Directory* itk::Directory::m_Internal

private

Definition at line 74 of file itkDirectory.h.

---

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

• itkDirectory.h