itk::Directory Class Reference

#include <itkDirectory.h>

Inheritance diagram for itk::Directory:

Collaboration diagram for itk::Directory:

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
::itksys::Directory *	m_Internal
static Pointer	New ()
virtual const char *	GetNameOfClass () const
bool	Load (const char *dir)
std::vector< std::string >::size_type	GetNumberOfFiles ()
const char *	GetFile (unsigned int index)
	Directory ()
	~Directory () override
void	PrintSelf (std::ostream &os, Indent indent) const override

Additional Inherited Members
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
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 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
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()
Protected Member Functions inherited from itk::Object
	Object ()
	~Object () override
void	PrintSelf (std::ostream &os, Indent indent) const override
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
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 ()
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount

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.

Member Typedef Documentation

ConstPointer

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

Definition at line 48 of file itkDirectory.h.

Pointer

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

Definition at line 47 of file itkDirectory.h.

Self

using itk::Directory::Self = Directory

Standard class type aliases.

Definition at line 45 of file itkDirectory.h.

Superclass

using itk::Directory::Superclass = Object

Definition at line 46 of file itkDirectory.h.

Constructor & Destructor Documentation

Directory()

itk::Directory::Directory ( )

protected

Method for creation through the object factory.

~Directory()

itk::Directory::~Directory ( )

overrideprotected

Method for creation through the object factory.

Member Function Documentation

GetFile()

const char* itk::Directory::GetFile

(

unsigned int

index

)

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

GetNameOfClass()

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

virtual

Return the class name as a string.

Reimplemented from itk::Object.

GetNumberOfFiles()

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

(

)

Return the number of files in the current directory.

Load()

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.

New()

static Pointer itk::Directory::New ( )

inlinestatic

Method for creation through the object factory.

Definition at line 52 of file itkDirectory.h.

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

PrintSelf()

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

overrideprotectedvirtual

Method for creation through the object factory.

Reimplemented from itk::LightObject.

Member Data Documentation

m_Internal

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

private

Method for creation through the object factory.

Definition at line 84 of file itkDirectory.h.

---

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

• itkDirectory.h