M_ImageComposer::IClient Class Reference

Public Member Functions
virtual	~IClient ()
virtual void	ReportImageComposerSettings (M_ImageComposer::ImageComposerSettingsType const &Settings)
virtual void	ReportImageComposerChannelStatus (std::string const &KeySourceChannel, M_ImageComposer::ImageComposerChannelStatusType const &Status, bool IsRemoved)
virtual void	ReportViewports (M_ImageComposer::ViewportListType const &ViewportList)

Detailed Description

Image Composer Client interface. Contains callback operations from the Service to the Client.

Constructor & Destructor Documentation

~IClient()

M_ImageComposer::IClient::~IClient ( )

virtual

Member Function Documentation

ReportImageComposerChannelStatus()

void M_ImageComposer::IClient::ReportImageComposerChannelStatus ( std::string const &  KeySourceChannel, M_ImageComposer::ImageComposerChannelStatusType const &  Status, bool  IsRemoved  )

virtual

Report with the current status for a specified channel. This will be continually updated every time a value is changed.

Parameters

KeySourceChannel	Name of channel.
Status	Status of the specified channel.
IsRemoved	Indicates if the status is no longer available. Note: This will always be set to true when a service has been shut down. After this has been set to true, the status will no longer be available to late joiners.

ReportImageComposerSettings()

void M_ImageComposer::IClient::ReportImageComposerSettings ( M_ImageComposer::ImageComposerSettingsType const &  Settings )

virtual

Report with static service settings. This should be provided at startup and in the event of degraded functionality, e.g. due to an internal failure.

Parameters

Settings

Service settings data.

ReportViewports()

void M_ImageComposer::IClient::ReportViewports ( M_ImageComposer::ViewportListType const &  ViewportList )

virtual

Report with the currently configured viewports. This will be continually updated every time a viewport is changed.

Parameters

ViewportList

List of the currently configured viewports.