trax::Jack Struct Reference

A jack a plug can get connected with. More...

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

Inheritance diagram for trax::Jack:

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

Detailed Description

A jack a plug can get connected with.

Member Function Documentation

Clear()

virtual void trax::Jack::Clear ( )

pure virtualnoexcept

Clear the Jack from any plug.

Implemented in trax::Jack_Imp.

GetPlug()

virtual Plug * trax::Jack::GetPlug ( ) const

pure virtualnoexcept

Gets a connected plug if any.

Returns

Pointer to connected plug, nullptr if none.

Implemented in trax::Jack_Imp.

Insert()

virtual void trax::Jack::Insert ( Plug * pPlug )

pure virtualnoexcept

Connects together a Plug with a Jack.

To disconnect call with nullptr.

Implemented in trax::Jack_Imp.

InsertAndAppend()

virtual void trax::Jack::InsertAndAppend ( Plug * pPlug )

pure virtualnoexcept

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

Implemented in trax::Jack_Imp.

InsertAtTail()

virtual void trax::Jack::InsertAtTail ( Plug * pPlug )

pure virtual

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

Implemented in trax::Jack_Imp.

Plugged()

virtual bool trax::Jack::Plugged ( ) const

pure virtualnoexcept

Is a Plug already plugged into this jack?

Implemented in trax::Jack_Imp.

Pulse()

virtual void trax::Jack::Pulse ( )

pure virtualnoexcept

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

Implemented in trax::Jack_Imp.

RefPlugID() [1/2]

virtual IDType trax::Jack::RefPlugID ( ) const

pure virtualnoexcept

Returns

The Plugs id if connected or an plug id for reconnecting

Implemented in trax::Jack_Imp.

RefPlugID() [2/2]

virtual void trax::Jack::RefPlugID ( IDType id )

pure virtualnoexcept

Sets the Plug id for reconnecting.

Implemented in trax::Jack_Imp.

TypeName()

virtual const char * trax::Jack::TypeName ( ) const

pure virtualnoexcept

Returns

the name for the object type that implements this interface.

Implemented in trax::Jack_Imp.

---

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

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