TdNetCavKey

class TdNetCavKey

Class used to encapsulate a CAVERNsoft key.

Public Methods
TdNetCavKey(const TcUtString &kName, const TcUtString &worldName): Constructor
TdNetCavKey(const TcUtString &name, void (*callBack)(CAVERN_irbKey_c::CAVERN_irbKeyEvent_t event, CAVERN_irbKey_c *thisKey, void* userData)): Constructor
TdNetCavKey(const TcUtString &name, void (*callBack)(CAVERN_irbKey_c::CAVERN_irbKeyEvent_t event, CAVERN_irbKey_c *thisKey, void* userData), TdNetReceivingDock<TcNetEvent *> *rDock): Constructor
virtual ~TdNetCavKey(): Destructor.
const TcUtString& getKeyName() const: Returns the key name.
virtual int sendNetCavEvent(TcNetCavEvent &event): Send a network event on the key.
void setCB(void (*callBack)(CAVERN_irbKey_c::CAVERN_irbKeyEvent_t event, CAVERN_irbKey_c *thisKey, void* userData)): Set the callback for the key.
void setDock(TdNetReceivingDock<TcNetEvent *> *): Set the receiving dock for the key.
static void setIRB(CAVERN_irb_c* irb): Set the IRB for all TdNetCavKey class instances.

Class used to encapsulate a CAVERNsoft key.

Constructor

TdNetCavKey(const TcUtString &name, void (*callBack)(CAVERN_irbKey_c::CAVERN_irbKeyEvent_t event, CAVERN_irbKey_c *thisKey, void* userData))

Constructor

Parameters:: name - Name of the key
callBack - callback to be triggered when data arrives on the key.

TdNetCavKey(const TcUtString &name, void (*callBack)(CAVERN_irbKey_c::CAVERN_irbKeyEvent_t event, CAVERN_irbKey_c *thisKey, void* userData), TdNetReceivingDock<TcNetEvent *> *rDock)

Constructor

Parameters:: name - Name of the key
callBack - callback to be triggered when data arrives on the key.
rDock - Receiving dock associated with the key.