OCC Main Page | FoundationClasses | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

FoundationClasses
TKernel
OSD


OSD_DirectoryIterator Class Reference

Manages a breadth-only search for sub-directories in the specified
Path.
There is no specific order of results.
.

#include <OSD_DirectoryIterator.hxx>


Public Member Functions

void * operator new (size_t, void *anAddress)
void * operator new (size_t size)
void operator delete (void *anAddress)
Standard_EXPORT OSD_DirectoryIterator ()
 Instantiates Object as empty Iterator;
.
Standard_EXPORT OSD_DirectoryIterator (const OSD_Path &where, const TCollection_AsciiString &Mask)
 Instantiates Object as Iterator.
Wild-card "*" can be used in Mask the same way it
is used by unix shell for file names
.
Standard_EXPORT void Destroy ()
 ~OSD_DirectoryIterator ()
Standard_EXPORT void Initialize (const OSD_Path &where, const TCollection_AsciiString &Mask)
 Initializes the current File Directory
.
Standard_EXPORT Standard_Boolean More ()
 Returns TRUE if other items are found while
using the 'Tree' method.
.
Standard_EXPORT void Next ()
 Sets the iterator to the next item.
Returns the item value corresponding to the current
position of the iterator.
.
Standard_EXPORT OSD_Directory Values ()
 Returns the next item found .
.
Standard_EXPORT Standard_Boolean Failed () const
 Returns TRUE if an error occurs
.
Standard_EXPORT void Reset ()
 Resets error counter to zero
.
Standard_EXPORT void Perror ()
 Raises OSD_Error
.
Standard_EXPORT Standard_Integer Error () const
 Returns error number if 'Failed' is TRUE.
.

Private Attributes

OSD_Directory TheIterator
Standard_Integer myFlag
TCollection_AsciiString myMask
TCollection_AsciiString myPlace
Standard_Address myDescr
Standard_Address myEntry
Standard_Integer myInit
OSD_Error myError
Standard_Integer myHandle
Standard_Address myData
Standard_Boolean myFirstCall


Constructor & Destructor Documentation

Standard_EXPORT OSD_DirectoryIterator::OSD_DirectoryIterator  ) 
 

Standard_EXPORT OSD_DirectoryIterator::OSD_DirectoryIterator const OSD_Path where,
const TCollection_AsciiString Mask
 

OSD_DirectoryIterator::~OSD_DirectoryIterator  )  [inline]
 


Member Function Documentation

Standard_EXPORT void OSD_DirectoryIterator::Destroy  ) 
 

Standard_EXPORT Standard_Integer OSD_DirectoryIterator::Error  )  const
 

Standard_EXPORT Standard_Boolean OSD_DirectoryIterator::Failed  )  const
 

Standard_EXPORT void OSD_DirectoryIterator::Initialize const OSD_Path where,
const TCollection_AsciiString Mask
 

Standard_EXPORT Standard_Boolean OSD_DirectoryIterator::More  ) 
 

Standard_EXPORT void OSD_DirectoryIterator::Next  ) 
 

void OSD_DirectoryIterator::operator delete void *  anAddress  )  [inline]
 

void* OSD_DirectoryIterator::operator new size_t  size  )  [inline]
 

void* OSD_DirectoryIterator::operator new size_t  ,
void *  anAddress
[inline]
 

Standard_EXPORT void OSD_DirectoryIterator::Perror  ) 
 

Standard_EXPORT void OSD_DirectoryIterator::Reset  ) 
 

Standard_EXPORT OSD_Directory OSD_DirectoryIterator::Values  ) 
 


Field Documentation

Standard_Address OSD_DirectoryIterator::myData [private]
 

Standard_Address OSD_DirectoryIterator::myDescr [private]
 

Standard_Address OSD_DirectoryIterator::myEntry [private]
 

OSD_Error OSD_DirectoryIterator::myError [private]
 

Standard_Boolean OSD_DirectoryIterator::myFirstCall [private]
 

Standard_Integer OSD_DirectoryIterator::myFlag [private]
 

Standard_Integer OSD_DirectoryIterator::myHandle [private]
 

Standard_Integer OSD_DirectoryIterator::myInit [private]
 

TCollection_AsciiString OSD_DirectoryIterator::myMask [private]
 

TCollection_AsciiString OSD_DirectoryIterator::myPlace [private]
 

OSD_Directory OSD_DirectoryIterator::TheIterator [private]
 


The documentation for this class was generated from the following file:
Generated on Mon Aug 25 13:13:03 2008 for OpenCASCADE by  doxygen 1.4.1