trax::Plug_Imp_ParentPointer< ParentType > Class Template Reference

Implementation for a plug that calls an objects member function on pulse. More...

#include <C:/Trend/Development/Trax3/Code/trax/Plug.h>

Inheritance diagram for trax::Plug_Imp_ParentPointer< ParentType >:

Public Types
using	TargetType = ParentType
Public Types inherited from trax::JackEnumerator
typedef JackEnumerator	collection_type
typedef Jack	value_type

Public Member Functions
	Plug_Imp_ParentPointer (const Plug_Imp_ParentPointer &plug)=delete
	Plug_Imp_ParentPointer (Plug_Imp_ParentPointer &&plug)=default
	Plug_Imp_ParentPointer (ParentType &parent, void(ParentType::*pPulseFunction)() noexcept)
	Plug_Imp_ParentPointer (ParentType &parent, void(ParentType::*pPulseFunction)() noexcept, Plug_Imp_ParentPointer &&plug)
Plug_Imp_ParentPointer &	operator= (const Plug_Imp_ParentPointer &)=delete
Plug_Imp_ParentPointer &	operator= (Plug_Imp_ParentPointer &&)=delete
void	Pulse (bool bForewardToJack) noexcept override
	Triggers a pulse for the plug.
Public Member Functions inherited from trax::Plug_Imp_Parent< ParentType >
	Plug_Imp_Parent (const Plug_Imp_Parent &plug)=delete
	Plug_Imp_Parent (Plug_Imp_Parent &&plug)=default
	Plug_Imp_Parent (ParentType &parent)
	Plug_Imp_Parent (ParentType &parent, Plug_Imp_Parent &&plug)
Public Member Functions inherited from trax::Plug_Imp
	Plug_Imp (const Plug_Imp &plug)=delete
dclspc	Plug_Imp (Plug_Imp &&plug) noexcept
dclspc	Plug_Imp (PlugEnumerator &parent)
dclspc	Plug_Imp (PlugEnumerator &parent, Plug_Imp &&plug)
Plug_Imp &	operator= (Plug_Imp &)=delete
Plug_Imp &	operator= (Plug_Imp &&plug)=delete
const char *	TypeName () const noexcept override
const std::string &	Reference (const std::string &name) const override
	Gets a reference that was set for this object by name.
IDType	ID () const noexcept override
dclspc Jack *	Plugged () const noexcept override
	Is this Plug already plugged into a jack?
dclspc bool	IsCyclic () const noexcept override
dclspc const Plug &	Tail () const override
	receives the tail (last element) of a Plug chain.
dclspc Plug &	Tail () override
	receives the tail (last element) of a Plug chain.
dclspc Jack &	JackOnPulse () noexcept override
	Get a Jack that triggers a pulse if the Plug receives a pulse.
dclspc const Jack &	JackOnPulse () const noexcept override
	Get a Jack that triggers a pulse if the Plug receives a pulse.
dclspc PlugEnumerator &	Parent () const noexcept override
dclspc void	Remove () noexcept
dclspc int	CountJacks () const noexcept override
Public Member Functions inherited from trax::ObjectID_Imp< Plug >
const std::vector< char const * > &	ReferenceNames (const std::string &namePart) const override
Public Member Functions inherited from trax::Identified< Plug >
	Identified (const Identified &)=delete
Identified &	operator= (const Identified &)=delete
Public Member Functions inherited from trax::JackEnumerator
Jack &	GetJack (int idx)
const Jack &	GetJack (int idx) const

Additional Inherited Members
Protected Member Functions inherited from trax::Plug_Imp
dclspc const Jack &	_GetJack (int idx) const override
Protected Member Functions inherited from trax::JackEnumerator
	JackEnumerator (const JackEnumerator &)=default
	JackEnumerator (JackEnumerator &&)=default
JackEnumerator &	operator= (const JackEnumerator &)=default
JackEnumerator &	operator= (JackEnumerator &&)=default
Protected Attributes inherited from trax::Plug_Imp_Parent< ParentType >
ParentType &	m_Parent

Detailed Description

template<class ParentType>
class trax::Plug_Imp_ParentPointer< ParentType >

Implementation for a plug that calls an objects member function on pulse.

Parameters

ParentType

PlugEnumerator derived owner of the plug.

Member Function Documentation

Pulse()

template<class ParentType>

void trax::Plug_Imp_ParentPointer< ParentType >::Pulse ( bool bForewardToJack )

inlineoverridevirtualnoexcept

Triggers a pulse for the plug.

Parameters

bForewardToJack

true if the pulse should be sent to a plug that's plugged in the plug's jack.

Reimplemented from trax::Plug_Imp.

---

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

• C:/Trend/Development/Trax3/Code/trax/Plug.h