ramses::DcsmStatusMessage Class Reference

The base class of a message to be sent from DCSM consumer to provider. More...

#include <DcsmStatusMessage.h>

Inheritance diagram for ramses::DcsmStatusMessage:

Public Member Functions
class StreamStatusMessage const *	getAsStreamStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...
class ActiveLayoutMessage const *	getAsActiveLayout () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...
class WidgetFocusStatusMessage const *	getAsWidgetFocusStatus () const
	Convenience function to get the derived class of DcsmStatusMessage easily. More...
virtual	~DcsmStatusMessage ()
	Default destructor of DcsmStatusMessage. More...
	DcsmStatusMessage (DcsmStatusMessage const &)=delete
	Disable copying. More...
	DcsmStatusMessage (DcsmStatusMessage &&)=delete
	Disable moving. More...

Public Attributes
std::unique_ptr< DcsmStatusMessageImpl >	impl

Protected Member Functions
	DcsmStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
	Constructor from impl. More...

Detailed Description

The base class of a message to be sent from DCSM consumer to provider.

Constructor & Destructor Documentation

~DcsmStatusMessage()

virtual ramses::DcsmStatusMessage::~DcsmStatusMessage ( )

virtual

Default destructor of DcsmStatusMessage.

DcsmStatusMessage() [1/3]

ramses::DcsmStatusMessage::DcsmStatusMessage ( DcsmStatusMessage const &  )

delete

Disable copying.

DcsmStatusMessage() [2/3]

ramses::DcsmStatusMessage::DcsmStatusMessage ( DcsmStatusMessage &&  )

delete

Disable moving.

DcsmStatusMessage() [3/3]

ramses::DcsmStatusMessage::DcsmStatusMessage ( std::unique_ptr< DcsmStatusMessageImpl > &&  impl_ )

explicitprotected

Constructor from impl.

Parameters

impl_

impl

Member Function Documentation

getAsActiveLayout()

class ActiveLayoutMessage const* ramses::DcsmStatusMessage::getAsActiveLayout

(

)

const

Convenience function to get the derived class of DcsmStatusMessage easily.

Returns

Pointer to ActiveLayoutMessage class if type of this message is ActiveLayout, nullptr otherwise.

getAsStreamStatus()

class StreamStatusMessage const* ramses::DcsmStatusMessage::getAsStreamStatus

(

)

const

Convenience function to get the derived class of DcsmStatusMessage easily.

Returns

Pointer to StreamStatusMessage class if type of this message is StreamStatus, nullptr otherwise.

getAsWidgetFocusStatus()

class WidgetFocusStatusMessage const* ramses::DcsmStatusMessage::getAsWidgetFocusStatus

(

)

const

Convenience function to get the derived class of DcsmStatusMessage easily.

Returns

Pointer to WidgetFocusStatusMessage class if type of this message is WidgetFocusStatus, nullptr otherwise.

Member Data Documentation

impl

std::unique_ptr<DcsmStatusMessageImpl> ramses::DcsmStatusMessage::impl

Stores internal data for implementation specifics of DcsmStatusMessage

---

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

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/DcsmStatusMessage.h