ChannelAttachmentsBase Class Reference

Holds multiple objects as a single attachment to Track. More...

#include <Track.h>

Inheritance diagram for ChannelAttachmentsBase:

Collaboration diagram for ChannelAttachmentsBase:

Public Types
using	Factory = std::function< std::shared_ptr< TrackAttachment >(Track &, size_t)>

Public Member Functions
	ChannelAttachmentsBase (Track &track, Factory factory)
	~ChannelAttachmentsBase () override
void	CopyTo (Track &track) const override
	Copy state, for undo/redo purposes. More...
void	Reparent (const std::shared_ptr< Track > &parent) override
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
void	WriteXMLAttributes (XMLWriter &writer) const override
	Serialize persistent attributes. More...
bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView) override
	Deserialize an attribute, returning true if recognized. More...
Public Member Functions inherited from TrackAttachment
virtual	~TrackAttachment ()
virtual void	CopyTo (Track &track) const
	Copy state, for undo/redo purposes. More...
virtual void	Reparent (const std::shared_ptr< Track > &parent)
	Object may be shared among tracks but hold a special back-pointer to one of them; reassign it. More...
virtual void	WriteXMLAttributes (XMLWriter &) const
	Serialize persistent attributes. More...
virtual bool	HandleXMLAttribute (const std::string_view &attr, const XMLAttributeValueView &valueView)
	Deserialize an attribute, returning true if recognized. More...
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Protected Member Functions
static TrackAttachment &	Get (const AttachedTrackObjects::RegisteredFactory &key, Track &track, size_t iChannel)
static TrackAttachment *	Find (const AttachedTrackObjects::RegisteredFactory &key, Track *pTrack, size_t iChannel)

Private Attributes
const Factory	mFactory
std::vector< std::shared_ptr< TrackAttachment > >	mAttachments

Detailed Description

Holds multiple objects as a single attachment to Track.

Definition at line 511 of file Track.h.

Member Typedef Documentation

Factory

using ChannelAttachmentsBase::Factory = std::function<std::shared_ptr<TrackAttachment>(Track &, size_t)>

Definition at line 514 of file Track.h.

Constructor & Destructor Documentation

ChannelAttachmentsBase()

ChannelAttachmentsBase::ChannelAttachmentsBase	(	Track &	track,
		Factory	factory
	)

Definition at line 1320 of file Track.cpp.

   : mFactory{ move(factory) }
{
   // Always construct one channel view
   // TODO wide wave tracks -- number of channels will be known earlier, and
   // they will all be constructed
   mAttachments.push_back(mFactory(track, 0));
}

References mAttachments, and mFactory.

~ChannelAttachmentsBase()

ChannelAttachmentsBase::~ChannelAttachmentsBase ( )

overridedefault

Member Function Documentation

CopyTo()

void ChannelAttachmentsBase::CopyTo ( Track &  track ) const

overridevirtual

Copy state, for undo/redo purposes.

Reimplemented from TrackAttachment.

Definition at line 1331 of file Track.cpp.

{
   for (auto &pAttachment : mAttachments)
      if (pAttachment)
         pAttachment->CopyTo(track);
}

References mAttachments.

Find()

TrackAttachment * ChannelAttachmentsBase::Find ( const AttachedTrackObjects::RegisteredFactory &  key, Track *  pTrack, size_t  iChannel  )

staticprotected

Precondition

!pTrack || iChannel < pTrack->NChannels()

Definition at line 1305 of file Track.cpp.

{
   assert(!pTrack || iChannel < pTrack->NChannels());
   if (!pTrack)
      return nullptr;
   const auto pAttachments =
      pTrack->AttachedObjects::Find<ChannelAttachmentsBase>(key);
   // do not create on demand
   if (!pAttachments || iChannel >= pAttachments->mAttachments.size())
      return nullptr;
   return pAttachments->mAttachments[iChannel].get();
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, key, and mAttachments.

Referenced by ChannelAttachments< Attachment >::Find().

Here is the caller graph for this function:

Get()

TrackAttachment & ChannelAttachmentsBase::Get ( const AttachedTrackObjects::RegisteredFactory &  key, Track &  track, size_t  iChannel  )

staticprotected

Precondition

iChannel < track.NChannels()

Definition at line 1286 of file Track.cpp.

{
   // Precondition of this function; satisfies precondition of factory below
   assert(iChannel < track.NChannels());
   auto &attachments = track.AttachedObjects::Get<ChannelAttachmentsBase>(key);
   auto &objects = attachments.mAttachments;
   if (iChannel >= objects.size())
      objects.resize(iChannel + 1);
   auto &pObject = objects[iChannel];
   if (!pObject) {
      // Create on demand
      pObject = attachments.mFactory(track, iChannel);
      assert(pObject); // Precondition of constructor
   }
   return *pObject;
}

References anonymous_namespace{StretchingSequenceIntegrationTest.cpp}::iChannel, key, mAttachments, mFactory, and ChannelGroup::NChannels().

Referenced by ChannelAttachments< Attachment >::Get().

Here is the call graph for this function:

Here is the caller graph for this function:

HandleXMLAttribute()

bool ChannelAttachmentsBase::HandleXMLAttribute ( const std::string_view &  attr, const XMLAttributeValueView &  valueView  )

overridevirtual

Deserialize an attribute, returning true if recognized.

default recognizes no attributes, and returns false

Reimplemented from TrackAttachment.

Definition at line 1352 of file Track.cpp.

{
   return std::any_of(mAttachments.begin(), mAttachments.end(),
   [&](auto &pAttachment) {
      return pAttachment && pAttachment->HandleXMLAttribute(attr, valueView);
   });
}

References mAttachments.

Reparent()

void ChannelAttachmentsBase::Reparent ( const std::shared_ptr< Track > &  parent )

overridevirtual

Object may be shared among tracks but hold a special back-pointer to one of them; reassign it.

default does nothing

Reimplemented from TrackAttachment.

Definition at line 1338 of file Track.cpp.

{
   for (auto &pAttachment : mAttachments)
      if (pAttachment)
         pAttachment->Reparent(parent);
}

References mAttachments.

WriteXMLAttributes()

void ChannelAttachmentsBase::WriteXMLAttributes ( XMLWriter &  ) const

overridevirtual

Serialize persistent attributes.

default does nothing

Reimplemented from TrackAttachment.

Definition at line 1345 of file Track.cpp.

{
   for (auto &pAttachment : mAttachments)
      if (pAttachment)
         pAttachment->WriteXMLAttributes(writer);
}

References mAttachments.

Member Data Documentation

mAttachments

std::vector<std::shared_ptr<TrackAttachment> > ChannelAttachmentsBase::mAttachments

private

Definition at line 544 of file Track.h.

Referenced by ChannelAttachmentsBase(), CopyTo(), Find(), Get(), HandleXMLAttribute(), Reparent(), and WriteXMLAttributes().

mFactory

const Factory ChannelAttachmentsBase::mFactory

private

Definition at line 543 of file Track.h.

Referenced by ChannelAttachmentsBase(), and Get().

---

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

• Track.h
• Track.cpp