SFBSignalBus

Wrapper Class for the ISignalBus interface.

#include <SFBSignalBus.h.hpp>

class SFBSignalBus : public SFBQuery;

SFMTYPEDEFWRAPPER(SFBSignalBus)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
X	X	O	O

Reference

BREW API ISignalBus

Member

Public Functions
`SFCError`	Add( `SFBSignalSmpConstRef` signal ) Associate an SFBSignal instance with the bus.
`SFCError`	Clear( `Void` ) Clear the state of the bus.
static `SFBSignalBusSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSignalBus instance.
static `SFBSignalBusSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSignalBus instance.
`SFCError`	OnEnable( `SFBSignalSmpConstRef` signal ) Associate an signal to be set when the SFBSignalBus has been "enabled"
`SFCError`	Remove( `SFBSignalSmpConstRef` signal ) Dis-associate an instance of SFBSignal with the bus.
`SFCError`	Set( `Void` ) Set the state of the bus, and sets all enabled signals on the bus.
`SFCError`	Strobe( `Void` ) Atomically set and clear the bus' state, signalling all enabled signals on the bus.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBSignalBus::Add

Associate an SFBSignal instance with the bus.

[ public ]
SFCError Add(
    SFBSignalSmpConstRef signal   // signal to be added with the bus
);

Reference

BREW API ISignalBus_Add | SFBSignal

SFBSignalBus::Clear

Clear the state of the bus.

[ public ]
SFCError Clear(Void);

Reference

BREW API ISignalBus_Clear

SFBSignalBus::NewInstance

Create a new SFBSignalBus instance.

[ public, static ]
SFBSignalBusSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBSignalBusSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBSignalBus::OnEnable

Associate an signal to be set when the SFBSignalBus has been "enabled"

[ public ]
SFCError OnEnable(
    SFBSignalSmpConstRef signal   // signal to be added with the bus
);

Reference

BREW API ISignalBus_OnEnable | SFBSignal

SFBSignalBus::Remove

Dis-associate an instance of SFBSignal with the bus.

[ public ]
SFCError Remove(
    SFBSignalSmpConstRef signal   // signal to be removed with the bus
);

Reference

BREW API ISignalBus_Remove | SFBSignal

SFBSignalBus::Set

Set the state of the bus, and sets all enabled signals on the bus.

[ public ]
SFCError Set(Void);

Reference

BREW API ISignalBus_Set

SFBSignalBus::Strobe

Atomically set and clear the bus' state, signalling all enabled signals on the bus.

[ public ]
SFCError Strobe(Void);

Reference

BREW API ISignalBus_Strobe