Channel Class Reference

#include <Channel.h>

Inheritance diagram for Channel:

Classes
class	IntervalIterator

Public Member Functions
virtual	~Channel ()
ChannelGroup &	GetChannelGroup ()
	Channel object's lifetime is assumed to be nested in its Track's. More...
const ChannelGroup &	GetChannelGroup () const
	Channel object's lifetime is assumed to be nested in its Track's. More...
size_t	GetChannelIndex () const
size_t	ReallyGetChannelIndex () const

Protected Member Functions
virtual ChannelGroup &	DoGetChannelGroup () const =0
	Subclass must override. More...
virtual ChannelGroup &	ReallyDoGetChannelGroup () const
	This is temporary! It defaults to call the above. More...

Private Member Functions
int	FindChannelIndex () const

Acesss to intervals
using	Interval = ChannelInterval
size_t	NIntervals () const
	Report the number of intervals. More...
template<typename IntervalType = Interval>
std::shared_ptr< IntervalType >	GetInterval (size_t iInterval)
	Retrieve an interval, cast to the given type. More...
template<typename IntervalType = const Interval>
auto	GetInterval (size_t iInterval) const -> std::enable_if_t< std::is_const_v< IntervalType >, std::shared_ptr< IntervalType > >
template<typename IntervalType = Interval>
IteratorRange< IntervalIterator< IntervalType > >	Intervals ()
	Get range of intervals with mutative access. More...
template<typename IntervalType = const Interval>
auto	Intervals () const -> std::enable_if_t< std::is_const_v< IntervalType >, IteratorRange< IntervalIterator< IntervalType > > >
	Get range of intervals with read-only access. More...

Detailed Description

Definition at line 177 of file Channel.h.

Member Typedef Documentation

Interval

using Channel::Interval = ChannelInterval

Definition at line 201 of file Channel.h.

Constructor & Destructor Documentation

~Channel()

Channel::~Channel ( )

virtualdefault

Member Function Documentation

DoGetChannelGroup()

virtual ChannelGroup & Channel::DoGetChannelGroup ( ) const

protectedpure virtual

Subclass must override.

Postcondition

result: for some ii less than result.NChannels(), this == result.GetChannel(ii).get()

Implemented in UniqueChannelTrack< Base >, UniqueChannelTrack< NoteTrackBase >, and WaveTrack.

Referenced by FindChannelIndex(), GetChannelGroup(), WaveChannel::GetTrack(), ReallyDoGetChannelGroup(), and NoteTrack::Interval::WideChannelGroupInterval().

Here is the caller graph for this function:

FindChannelIndex()

int Channel::FindChannelIndex ( ) const

private

Definition at line 34 of file Channel.cpp.

{
   auto &group = DoGetChannelGroup();
   int index = -1;
   for (size_t ii = 0, nn = group.NChannels(); ii < nn; ++ii)
      if (group.GetChannel(ii).get() == this) {
         index = ii;
         break;
      }
   // post of DoGetChannelGroup
   assert(index >= 0);
 
   // TODO wide wave tracks -- remove this stronger assertion
   assert(index == 0);
 
   return index;
}

References DoGetChannelGroup().

Referenced by GetChannelGroup(), GetChannelIndex(), and NoteTrack::Interval::WideChannelGroupInterval().

Here is the call graph for this function:

Here is the caller graph for this function:

GetChannelGroup() [1/2]

ChannelGroup & Channel::GetChannelGroup

(

)

Channel object's lifetime is assumed to be nested in its Track's.

Definition at line 71 of file Channel.cpp.

{
   assert(FindChannelIndex() >= 0);
   return DoGetChannelGroup();
}

Referenced by ChannelView::Find(), TrackPanelResizerCell::Get(), ChannelView::Get(), anonymous_namespace{TrackPanel.cpp}::GetTrack(), TrackPanelResizeHandle::GetTrack(), and NIntervals().

Here is the caller graph for this function:

GetChannelGroup() [2/2]

const ChannelGroup & Channel::GetChannelGroup

(

)

const

Channel object's lifetime is assumed to be nested in its Track's.

Definition at line 65 of file Channel.cpp.

{
   assert(FindChannelIndex() >= 0);
   return DoGetChannelGroup();
}

References DoGetChannelGroup(), and FindChannelIndex().

Here is the call graph for this function:

GetChannelIndex()

size_t Channel::GetChannelIndex

(

)

const

Returns

ii such that this == GetChannelGroup().GetChannel(ii).get()

Definition at line 77 of file Channel.cpp.

{
   return FindChannelIndex();
}

References FindChannelIndex().

Referenced by ChannelView::Find(), TrackPanelResizerCell::Get(), and ChannelView::Get().

Here is the call graph for this function:

Here is the caller graph for this function:

GetInterval() [1/2]

template<typename IntervalType >

std::shared_ptr< IntervalType > Channel::GetInterval

(

size_t

iInterval

)

Retrieve an interval, cast to the given type.

Postcondition

if IntervalType is default, then: result: !(iInterval < NIntervals()) || result

Definition at line 614 of file Channel.h.

{
   return ReallyDoGetChannelGroup().GetInterval(iInterval)
      ->template GetChannel<IntervalType>(ReallyGetChannelIndex());
}

References ChannelGroup::GetInterval(), ReallyDoGetChannelGroup(), and ReallyGetChannelIndex().

Here is the call graph for this function:

GetInterval() [2/2]

template<typename IntervalType >

auto Channel::GetInterval

(

size_t

iInterval

)

const -> std::enable_if_t<std::is_const_v<IntervalType>, std::shared_ptr<IntervalType>>

Postcondition

if IntervalType is default, then: result: !(iInterval < NIntervals()) || result

Definition at line 621 of file Channel.h.

{
   return ReallyDoGetChannelGroup().GetInterval(iInterval)
      ->template GetChannel<IntervalType>(ReallyGetChannelIndex());
}

Intervals() [1/2]

template<typename IntervalType = Interval>

IteratorRange< IntervalIterator< IntervalType > > Channel::Intervals ( )

inline

Get range of intervals with mutative access.

Definition at line 269 of file Channel.h.

   {
      return { { this, 0 }, { this, NIntervals() } };
   }

Referenced by EffectRepeat::Process().

Here is the caller graph for this function:

Intervals() [2/2]

template<typename IntervalType = const Interval>

auto Channel::Intervals ( ) const -> std::enable_if_t<std::is_const_v<IntervalType>, IteratorRange<IntervalIterator<IntervalType>> >

inline

Get range of intervals with read-only access.

Definition at line 276 of file Channel.h.

   {
      return { { this, 0 }, { this, NIntervals() } };
   }

NIntervals()

size_t Channel::NIntervals ( ) const

inline

Report the number of intervals.

Definition at line 608 of file Channel.h.

{
   return GetChannelGroup().NIntervals();
}

References GetChannelGroup(), and ChannelGroup::NIntervals().

Here is the call graph for this function:

ReallyDoGetChannelGroup()

ChannelGroup & Channel::ReallyDoGetChannelGroup ( ) const

protectedvirtual

This is temporary! It defaults to call the above.

Reimplemented in WaveTrack.

Definition at line 82 of file Channel.cpp.

{
   return DoGetChannelGroup();
}

References DoGetChannelGroup().

Referenced by GetInterval(), and ReallyGetChannelIndex().

Here is the call graph for this function:

Here is the caller graph for this function:

ReallyGetChannelIndex()

size_t Channel::ReallyGetChannelIndex

(

)

const

Definition at line 52 of file Channel.cpp.

{
   auto &group = ReallyDoGetChannelGroup();
   int index = -1;
   for (size_t ii = 0, nn = group.NChannels(); ii < nn; ++ii)
      if (group.GetChannel(ii).get() == this) {
         index = ii;
         break;
      }
   assert(index >= 0);
   return index;
}

References ReallyDoGetChannelGroup().

Referenced by GetInterval().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Channel.h
• Channel.cpp