This is the base class against which all Messages sent to Katana should inherit from. More...

#include <Message.h>

Inheritance diagram for Foundry::Katana::Message:

Public Member Functions
bool	isValid () const
	Check if the message has a valid handle to the host suite.
Static Public Member Functions
static FnPlugStatus	setHost (FnPluginHost *host)
	Set the Display Driver Host to delegate message initialization and protocol details to the suite.
static const FnDisplayDriverHostSuite_v1 *	getSuite ()
	Get the Display Driver host suite for messages. If invalid, an error message is output to the standard error stream.

Detailed Description

This is the base class against which all Messages sent to Katana should inherit from.

Member Function Documentation

static const FnDisplayDriverHostSuite_v1* Foundry::Katana::Message::getSuite ( ) [static]

Get the Display Driver host suite for messages. If invalid, an error message is output to the standard error stream.

bool Foundry::Katana::Message::isValid ( ) const [inline]

Check if the message has a valid handle to the host suite.

Returns:: true if the message handle can be used to get/set data and send through the communication pipe.

static FnPlugStatus Foundry::Katana::Message::setHost ( FnPluginHost * host ) [static]

Set the Display Driver Host to delegate message initialization and protocol details to the suite.

The KatanaPipeSingleton bootstraps and sets the host suite, and is recommended to initialize the message suite.

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