GDCM  2.4.5
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
gdcm::Directory Class Reference

Class for manipulation directories. More...

#include <gdcmDirectory.h>

Public Types

typedef std::vector< FilenameTypeFilenamesType
 
typedef std::string FilenameType
 

Public Member Functions

 Directory ()
 
 ~Directory ()
 
FilenamesType const & GetDirectories () const
 Return the Directories traversed. More...
 
FilenamesType const & GetFilenames () const
 Set/Get the file names within the directory. More...
 
FilenameType const & GetToplevel () const
 Get the name of the toplevel directory. More...
 
unsigned int Load (FilenameType const &name, bool recursive=false)
 
void Print (std::ostream &os=std::cout) const
 Print. More...
 

Protected Member Functions

unsigned int Explore (FilenameType const &name, bool recursive)
 Return number of file found when 'recursive'ly exploring directory name More...
 

Friends

std::ostream & operator<< (std::ostream &_os, const Directory &d)
 

Detailed Description

Class for manipulation directories.

Note
This implementation provide a cross platform implementation for manipulating directores: basically traversing directories and harvesting files
will not take into account unix type hidden file recursive option will not look into UNIX type hidden directory (those starting with a '.')
Since python or C# provide there own equivalent implementation, in which case gdcm::Directory does not make much sense.
Examples:
DiscriminateVolume.cxx, DumpToSQLITE3.cxx, gdcmorthoplanes.cxx, GenerateRTSTRUCT.cxx, ReadUTF8QtDir.cxx, reslicesphere.cxx, SortImage.cxx, threadgdcm.cxx, and VolumeSorter.cxx.

Member Typedef Documentation

typedef std::string gdcm::Directory::FilenameType

Constructor & Destructor Documentation

gdcm::Directory::Directory ( )
inline
gdcm::Directory::~Directory ( )
inline

Member Function Documentation

unsigned int gdcm::Directory::Explore ( FilenameType const &  name,
bool  recursive 
)
protected

Return number of file found when 'recursive'ly exploring directory name

FilenamesType const& gdcm::Directory::GetDirectories ( ) const
inline

Return the Directories traversed.

FilenamesType const& gdcm::Directory::GetFilenames ( ) const
inline
FilenameType const& gdcm::Directory::GetToplevel ( ) const
inline

Get the name of the toplevel directory.

unsigned int gdcm::Directory::Load ( FilenameType const &  name,
bool  recursive = false 
)

construct a list of filenames and subdirectory beneath directory: name

Warning
: hidden file and hidden directory are not loaded.
Examples:
DecompressImageMultiframe.cs, DiscriminateVolume.cxx, DumpToSQLITE3.cxx, gdcmorthoplanes.cxx, GenerateRTSTRUCT.cxx, ReadUTF8QtDir.cxx, reslicesphere.cxx, SortImage.cxx, threadgdcm.cxx, and VolumeSorter.cxx.
void gdcm::Directory::Print ( std::ostream &  os = std::cout) const

Print.

Examples:
SortImage.cxx.

Referenced by gdcm::operator<<().

Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  _os,
const Directory d 
)
friend

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

Generated on Fri Sep 25 2015 17:58:30 for GDCM by doxygen 1.8.9.1
SourceForge.net Logo