RAMSES Documentation  27.0.130
Information for RAMSES users and developers
Public Types | Public Member Functions | List of all members
ramses::ActiveLayoutMessage Class Reference

A status message containing the instrument cluster's active layout. More...

#include <DcsmStatusMessage.h>

Inheritance diagram for ramses::ActiveLayoutMessage:
[legend]
Collaboration diagram for ramses::ActiveLayoutMessage:
[legend]

Public Types

enum class  Layout : uint32_t {
  Drive = 0 , Focus , Gallery , Autonomous ,
  Sport_Road , Sport_Track
}
 The possible layout values in the instrument cluster. More...
 

Public Member Functions

 ActiveLayoutMessage (Layout layout)
 Create an ActiveLayoutMessage object containing the provided layout. More...
 
Layout getLayout () const
 Returns the active layout. More...
 
 ActiveLayoutMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
 Constructor from impl, only for internal usage. More...
 
- Public Member Functions inherited from ramses::DcsmStatusMessage
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...
 

Additional Inherited Members

- Public Attributes inherited from ramses::DcsmStatusMessage
std::unique_ptr< DcsmStatusMessageImpl > impl
 
- Protected Member Functions inherited from ramses::DcsmStatusMessage
 DcsmStatusMessage (std::unique_ptr< DcsmStatusMessageImpl > &&impl_)
 Constructor from impl. More...
 

Detailed Description

A status message containing the instrument cluster's active layout.

Member Enumeration Documentation

◆ Layout

enum ramses::ActiveLayoutMessage::Layout : uint32_t
strong

The possible layout values in the instrument cluster.

Enumerator
Drive 
Focus 
Gallery 
Autonomous 
Sport_Road 
Sport_Track 

Constructor & Destructor Documentation

◆ ActiveLayoutMessage() [1/2]

ramses::ActiveLayoutMessage::ActiveLayoutMessage ( Layout  layout)
explicit

Create an ActiveLayoutMessage object containing the provided layout.

Parameters
layoutThe layout to transmit.

◆ ActiveLayoutMessage() [2/2]

ramses::ActiveLayoutMessage::ActiveLayoutMessage ( std::unique_ptr< DcsmStatusMessageImpl > &&  impl_)
explicit

Constructor from impl, only for internal usage.

Parameters
impl_impl

Member Function Documentation

◆ getLayout()

Layout ramses::ActiveLayoutMessage::getLayout ( ) const

Returns the active layout.

Returns
active layout

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