trax::Jack_Imp Class Reference

Inheritance diagram for trax::Jack_Imp:

Public Member Functions
	Jack_Imp (const Jack_Imp &jack)=delete
dclspc	Jack_Imp (Jack_Imp &&jack) noexcept
dclspc	Jack_Imp (const std::string &name)
Jack_Imp &	operator= (const Jack_Imp &)=delete
Jack_Imp &	operator= (Jack_Imp &&jack)=delete
dclspc const char *	TypeName () const noexcept override
IDType dclspc	RefPlugID () const noexcept override
void dclspc	RefPlugID (IDType id) noexcept override
	Sets the Plug id for reconnecting.
void dclspc	Pulse () noexcept override
	This function gets called from the owner of a Jack on a certain event.
void dclspc	Insert (Plug *pPlug) noexcept override
	Connects together a Plug with a Jack.
void dclspc	InsertAtTail (Plug *pPlug) override
	Inserts the plug at this Jack if no plug is already inserted. Inserts it at the tail of this plug chain otherwise.
void dclspc	InsertAndAppend (Plug *pPlug) noexcept override
	Inserts the plug at this Jack. If a plug is already inserted this will be appended into pPlug's Jack.
dclspc Plug *	GetPlug () const noexcept override
	Gets a connected plug if any.
bool dclspc	Plugged () const noexcept override
	Is a Plug already plugged into this jack?
void dclspc	Clear () noexcept override
	Clear the Jack from any plug.
Public Member Functions inherited from trax::ObjectID_Imp< Jack >
const std::string &	Reference (const std::string &name) const override
const std::vector< char const * > &	ReferenceNames (const std::string &namePart) const override
IDType	ID () const noexcept override
Public Member Functions inherited from trax::Identified< Jack >
	Identified (const Identified &)=delete
Identified &	operator= (const Identified &)=delete

Member Function Documentation

Clear()

void dclspc trax::Jack_Imp::Clear ( )

overridevirtualnoexcept

Clear the Jack from any plug.

Implements trax::Jack.

GetPlug()

dclspc Plug * trax::Jack_Imp::GetPlug ( ) const

overridevirtualnoexcept

Gets a connected plug if any.

Returns

Pointer to connected plug, nullptr if none.

Implements trax::Jack.

Insert()

void dclspc trax::Jack_Imp::Insert ( Plug * pPlug )

overridevirtualnoexcept

Connects together a Plug with a Jack.

To disconnect call with nullptr.

Implements trax::Jack.

InsertAndAppend()

void dclspc trax::Jack_Imp::InsertAndAppend ( Plug * pPlug )

overridevirtualnoexcept

Inserts the plug at this Jack. If a plug is already inserted this will be appended into pPlug's Jack.

Implements trax::Jack.

InsertAtTail()

void dclspc trax::Jack_Imp::InsertAtTail ( Plug * pPlug )

overridevirtual

Inserts the plug at this Jack if no plug is already inserted. Inserts it at the tail of this plug chain otherwise.

Implements trax::Jack.

Plugged()

bool dclspc trax::Jack_Imp::Plugged ( ) const

overridevirtualnoexcept

Is a Plug already plugged into this jack?

Implements trax::Jack.

Pulse()

void dclspc trax::Jack_Imp::Pulse ( )

overridevirtualnoexcept

This function gets called from the owner of a Jack on a certain event.

Implements trax::Jack.

RefPlugID() [1/2]

IDType dclspc trax::Jack_Imp::RefPlugID ( ) const

overridevirtualnoexcept

Returns

The Plugs id if connected or an plug id for reconnecting

Implements trax::Jack.

RefPlugID() [2/2]

void dclspc trax::Jack_Imp::RefPlugID ( IDType id )

overridevirtualnoexcept

Sets the Plug id for reconnecting.

Implements trax::Jack.

TypeName()

dclspc const char * trax::Jack_Imp::TypeName ( ) const

overridevirtualnoexcept

Returns

the name for the object type that implements this interface.

Implements trax::Jack.

---

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

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