libxcks  0.1.0.1
libxcks::XCKSDirStruct::const_file_iterator Class Reference

A forward iterator on files of a directory structure. More...

Collaboration diagram for libxcks::XCKSDirStruct::const_file_iterator:

Public Member Functions

 const_file_iterator ()
 Default constructor. More...
 
 const_file_iterator (const const_file_iterator &)=default
 Copy constructor. More...
 
const_file_iteratoroperator= (const const_file_iterator &)=default
 Assignment operator. More...
 
 const_file_iterator (XCKSDirStruct::File *initFile)
 Constructor. More...
 
bool operator== (const const_file_iterator &it) const
 Equality operator. More...
 
bool operator!= (const const_file_iterator &it) const
 Inequality operator. More...
 
const_file_iteratoroperator++ ()
 Prefix increment operator. More...
 
const_file_iterator operator++ (int)
 Postfix increment operator. More...
 
const XCKSDirStruct::Fileoperator* () const
 Indirection operator. More...
 
const XCKSDirStruct::Fileoperator-> () const
 Member of pointer operator. More...
 

Protected Member Functions

void plusPlus ()
 Do the ++ operation on the iterator. More...
 

Protected Attributes

XCKSDirStruct::Filefile
 Current file. More...
 

Detailed Description

A forward iterator on files of a directory structure.

See also
XCKSDirStruct.

Definition at line 394 of file xcksfilewriter.cpp.

Constructor & Destructor Documentation

◆ const_file_iterator() [1/3]

libxcks::XCKSDirStruct::const_file_iterator::const_file_iterator ( )
inline

Default constructor.

Definition at line 401 of file xcksfilewriter.cpp.

◆ const_file_iterator() [2/3]

libxcks::XCKSDirStruct::const_file_iterator::const_file_iterator ( const const_file_iterator )
default

Copy constructor.

◆ const_file_iterator() [3/3]

libxcks::XCKSDirStruct::const_file_iterator::const_file_iterator ( XCKSDirStruct::File initFile)
inline

Constructor.

Parameters
initFileThe initial file.

Definition at line 414 of file xcksfilewriter.cpp.

Member Function Documentation

◆ operator!=()

bool libxcks::XCKSDirStruct::const_file_iterator::operator!= ( const const_file_iterator it) const
inline

Inequality operator.

Parameters
itThe iterator to compare with the instance.
Returns
false if the iterators are equals, true otherwise.

Definition at line 439 of file xcksfilewriter.cpp.

◆ operator*()

const XCKSDirStruct::File& libxcks::XCKSDirStruct::const_file_iterator::operator* ( ) const
inline

Indirection operator.

Returns
A constant reference to the file.

Definition at line 460 of file xcksfilewriter.cpp.

◆ operator++() [1/2]

const_file_iterator& libxcks::XCKSDirStruct::const_file_iterator::operator++ ( )
inline

Prefix increment operator.

Returns
The new value of the iterator by reference.

Definition at line 446 of file xcksfilewriter.cpp.

◆ operator++() [2/2]

const_file_iterator libxcks::XCKSDirStruct::const_file_iterator::operator++ ( int  )
inline

Postfix increment operator.

Returns
The old value of the iterator.

Definition at line 453 of file xcksfilewriter.cpp.

◆ operator->()

const XCKSDirStruct::File* libxcks::XCKSDirStruct::const_file_iterator::operator-> ( ) const
inline

Member of pointer operator.

Returns
A pointer on the file.

Definition at line 467 of file xcksfilewriter.cpp.

◆ operator=()

const_file_iterator& libxcks::XCKSDirStruct::const_file_iterator::operator= ( const const_file_iterator )
default

Assignment operator.

◆ operator==()

bool libxcks::XCKSDirStruct::const_file_iterator::operator== ( const const_file_iterator it) const
inline

Equality operator.

Parameters
itThe iterator to compare with the instance.
Returns
true if the iterators are equals, false otherwise.

Definition at line 431 of file xcksfilewriter.cpp.

◆ plusPlus()

void libxcks::XCKSDirStruct::const_file_iterator::plusPlus ( )
inlineprotected

Do the ++ operation on the iterator.

Definition at line 418 of file xcksfilewriter.cpp.

Member Data Documentation

◆ file

XCKSDirStruct::File* libxcks::XCKSDirStruct::const_file_iterator::file
protected

Current file.

Definition at line 397 of file xcksfilewriter.cpp.


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