DcsmStatusMessage.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2021 BMW AG
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_DCSMSTATUSMESSAGE_H
#define RAMSES_DCSMSTATUSMESSAGE_H
 
#include "ramses-framework-api/APIExport.h"
#include <stdint.h>
#include <memory>
 
#if defined(_MSC_VER)
__pragma(warning(push))
__pragma(warning(disable: 4251))
#endif
 
namespace ramses
{
    class DcsmStatusMessageImpl;
    class RAMSES_API DcsmStatusMessage
    {
    public:
        class StreamStatusMessage const* getAsStreamStatus() const;
 
        class ActiveLayoutMessage const* getAsActiveLayout() const;
 
        class WidgetFocusStatusMessage const* getAsWidgetFocusStatus() const;
 
        virtual ~DcsmStatusMessage();
 
        DcsmStatusMessage(DcsmStatusMessage const&) = delete;
 
        DcsmStatusMessage(DcsmStatusMessage&&) = delete;
 
        std::unique_ptr<DcsmStatusMessageImpl> impl;
 
    protected:
        explicit DcsmStatusMessage(std::unique_ptr<DcsmStatusMessageImpl>&& impl_);
    };
 
 
    class RAMSES_API StreamStatusMessage : public DcsmStatusMessage
    {
    public:
        enum class Status
        {
            Ready = 0,              
            Enabled,                
            Valid,                  
            Invalid,                
            Halted,                 
            ChannelError,           
            InvalidCommand,         
            VideoResolutionChanged  
        };
 
        explicit StreamStatusMessage(Status status);
 
        Status getStreamStatus() const;
 
        explicit StreamStatusMessage(std::unique_ptr<DcsmStatusMessageImpl>&& impl_);
    };
 
 
    class RAMSES_API ActiveLayoutMessage : public DcsmStatusMessage
    {
    public:
        enum class Layout : uint32_t
        {
            Drive = 0,
            Focus,
            Gallery,
            Autonomous,
            Sport_Road,
            Sport_Track,
        };
 
        explicit ActiveLayoutMessage(Layout layout);
 
        Layout getLayout() const;
 
        explicit ActiveLayoutMessage(std::unique_ptr<DcsmStatusMessageImpl>&& impl_);
    };
 
    class RAMSES_API WidgetFocusStatusMessage : public DcsmStatusMessage
    {
    public:
        enum class Status : uint32_t
        {
            Unknown = 0,
            Focused,               
            NotFocused,            
        };
 
        explicit WidgetFocusStatusMessage(Status status);
 
        Status getWidgetFocusStatus() const;
 
        explicit WidgetFocusStatusMessage(std::unique_ptr<DcsmStatusMessageImpl>&& impl_);
    };
}
 
#if defined(_MSC_VER)
__pragma(warning(pop))
#endif
#endif