Audacity 3.2.0
Public Member Functions | Private Attributes | Friends | List of all members
WaveTrackUtilities::AllClipsConstIterator Class Reference

#include <WaveTrackUtilities.h>

Inheritance diagram for WaveTrackUtilities::AllClipsConstIterator:
[legend]
Collaboration diagram for WaveTrackUtilities::AllClipsConstIterator:
[legend]

Public Member Functions

 AllClipsConstIterator ()
 
 AllClipsConstIterator (const WaveTrack &track)
 
value_type operator* () const
 
AllClipsConstIteratoroperator++ ()
 

Private Attributes

AllClipsIterator mIter
 

Friends

bool operator== (const AllClipsConstIterator &a, const AllClipsConstIterator &b)
 Define == well enough to serve for loop termination test. More...
 
bool operator!= (const AllClipsConstIterator &a, const AllClipsConstIterator &b)
 

Additional Inherited Members

- Public Types inherited from ValueIterator< IntervalConstHolder >
using iterator_category = std::forward_iterator_tag
 
using value_type = IntervalConstHolder
 
using difference_type = ptrdiff_t
 
using pointer = void
 
using reference = const IntervalConstHolder
 

Detailed Description

Get const access to all clips (in some unspecified sequence), including those hidden in cutlines.

Get mutative access to all clips (in some unspecified sequence), including those hidden in cutlines.

If clips are added to the track during the visit, not all may be visited. If a clip is removed from the track during the visit, there will not be dangling pointers, but a clip not in the track may be visited.

Definition at line 86 of file WaveTrackUtilities.h.

Constructor & Destructor Documentation

◆ AllClipsConstIterator() [1/2]

WaveTrackUtilities::AllClipsConstIterator::AllClipsConstIterator ( )
inline

Definition at line 91 of file WaveTrackUtilities.h.

91{}

◆ AllClipsConstIterator() [2/2]

WaveTrackUtilities::AllClipsConstIterator::AllClipsConstIterator ( const WaveTrack track)
inlineexplicit

Definition at line 94 of file WaveTrackUtilities.h.

95 : mIter{ const_cast<WaveTrack&>(track) }
96 {}
A Track that contains audio waveform data.
Definition: WaveTrack.h:203

Member Function Documentation

◆ operator*()

value_type WaveTrackUtilities::AllClipsConstIterator::operator* ( ) const
inline

Definition at line 98 of file WaveTrackUtilities.h.

98{ return *mIter; }

◆ operator++()

AllClipsConstIterator & WaveTrackUtilities::AllClipsConstIterator::operator++ ( )
inline

Definition at line 100 of file WaveTrackUtilities.h.

101 { ++mIter; return *this; }

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( const AllClipsConstIterator a,
const AllClipsConstIterator b 
)
friend

Definition at line 108 of file WaveTrackUtilities.h.

110 { return !(a == b); }

◆ operator==

bool operator== ( const AllClipsConstIterator a,
const AllClipsConstIterator b 
)
friend

Define == well enough to serve for loop termination test.

Definition at line 104 of file WaveTrackUtilities.h.

106 { return a.mIter == b.mIter; }

Member Data Documentation

◆ mIter

AllClipsIterator WaveTrackUtilities::AllClipsConstIterator::mIter
private

Definition at line 113 of file WaveTrackUtilities.h.


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