trax::Lockable Struct Reference

Interface for locking and unlocking an object. More...

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

Public Member Functions
virtual void	Lock ()=0
	Locks the object for further input.
virtual void	Unlock ()=0
	Unlocks the object to execute input again.
virtual void	ToggleLock ()=0
	Toggles the lock state.
virtual bool	IsLocked () const =0
virtual MultiPlug &	PlugToLock ()=0
virtual Jack &	JackOnLock ()=0
virtual MultiPlug &	PlugToUnlock ()=0
virtual Jack &	JackOnUnlock ()=0
	Jack that pulses on unlock.
virtual MultiPlug &	PlugToLockToggle ()=0
	Plug to toggle the lock state by pulse.
virtual Jack &	JackOnLockChange ()=0
	Jack that pulses if the lock state changes.

Detailed Description

Interface for locking and unlocking an object.

Signals and Switches provide this type of interface. Together with a PulseCounter a lock counting mechanism can be built and from that mutual exclusive Fahrstrassen are possible.

Member Function Documentation

IsLocked()

virtual bool trax::Lockable::IsLocked ( ) const

pure virtual

Returns

true if the object is locked, false elsewise

JackOnLock()

virtual Jack & trax::Lockable::JackOnLock ( )

pure virtual

Returns

Jack that pulses on lock.

PlugToLock()

virtual MultiPlug & trax::Lockable::PlugToLock ( )

pure virtual

Returns

Plug to lock the object by pulse.

PlugToUnlock()

virtual MultiPlug & trax::Lockable::PlugToUnlock ( )

pure virtual

Returns

Plug to unlock the object by pulse.

---

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

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