Steve Pham
b4a2edec6a
* Final update copyright headers to reference license files at the repo root Signed-off-by: spham <spham@amazon.com> * Fix copyright validator unit tests to support the stale O3DE header scenario Signed-off-by: spham <spham@amazon.com>
60 lines
1.5 KiB
C++
60 lines
1.5 KiB
C++
/*
|
|
* Copyright (c) Contributors to the Open 3D Engine Project. For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
namespace AzToolsFramework
|
|
{
|
|
namespace Layers
|
|
{
|
|
enum class LayerResultStatus
|
|
{
|
|
Success,
|
|
Warning,
|
|
Error
|
|
};
|
|
|
|
/**
|
|
* Holds the status of a layer operation, and a message detailing that status when not a success.
|
|
*/
|
|
struct LayerResult
|
|
{
|
|
public:
|
|
LayerResult() { }
|
|
|
|
LayerResult(LayerResultStatus resultStatus, QString resultMessage) :
|
|
m_result(resultStatus),
|
|
m_message(resultMessage)
|
|
{
|
|
|
|
}
|
|
|
|
/**
|
|
* A helper function to make it obvious at callsites that a success is intended.
|
|
*/
|
|
static LayerResult CreateSuccess() { return LayerResult(); }
|
|
|
|
/**
|
|
* Returns true if this LayerResult was a success, false if not.
|
|
*/
|
|
bool IsSuccess() const
|
|
{
|
|
return m_result == LayerResultStatus::Success;
|
|
}
|
|
|
|
/**
|
|
* If a failure occured, outputs the current failure to the appropriate system.
|
|
* On success, does nothing.
|
|
*/
|
|
void MessageResult();
|
|
|
|
LayerResultStatus m_result = LayerResultStatus::Success;
|
|
QString m_message;
|
|
};
|
|
|
|
}
|
|
}
|