System.h

[詳解]

/// @file
/// @brief システムの不変情報を提供するMonostateクラス System のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_SYSTEM_H
#define AMDAEMON_SYSTEM_H

#include "amdaemon/env.h"
#include "amdaemon/SerialId.h"
#include "amdaemon/Resolution.h"
#include "amdaemon/RegionCode.h"

#include <cstdint>
#include <cstddef>

namespace amdaemon
{
/// @addtogroup g_system
/// @{

    /// @brief システムの不変情報を提供するMonostateクラス。
    ///
    /// @ingroup g_common
    class System
    {
    public:
        // 下記は暗黙の定義を用いる。
        //System() = default;
        //‾System() = default;
        //System(const System&) = default;
        //System& operator=(const System&) = default;

        /// @brief ボードのシリアルIDを取得する。
        /// @return ボードのシリアルID。
        const SerialId& getBoardId() const;

        /// @brief 仕向地コードを取得する。
        /// @return 仕向地コード。
        ///
        /// @par プラットフォーム情報
        /// - Nuシリーズの場合はボードの仕向地コードを返す。
        /// - ALLSシリーズの場合はキーチップの仕向地コードを返す。
        ///   複数の仕向地が設定されている場合は Unknown を返す。
        RegionCode getRegionCode() const;

        /// @brief キーチップIDを取得する。
        /// @return キーチップID。
        const SerialId& getKeychipId() const;

        /// @brief キーチップの機能区分値を取得する。
        /// @return 機能区分値。 1 以上 98 以下。
        std::uint32_t getModelType() const;

        /// @brief ゲームIDを取得する。
        /// @return ゲームID。 4 文字。
        const wchar_t* getGameId() const;

        /// @brief 開発シーケンスで動作しているか否かを取得する。
        /// @retval true  開発シーケンスで動作している場合。
        /// @retval false 量産シーケンスで動作している場合。
        bool isDevelop() const;

        /// @brief 画面解像度を取得する。
        /// @param[in] monitorIndex
        ///     プライマリモニタの解像度を取得するならば 0 。
        ///     セカンダリモニタの解像度を取得するならば 1 。
        /// @return 画面解像度。
        ///
        /// @exception Exception
        /// 引数 monitorIndex に 0 または 1 以外の値を指定した場合。
        ///
        /// 画面出力モードがデュアル設定の場合のみセカンダリモニタの解像度を取得できる。
        /// それ以外の場合、セカンダリモニタの解像度を取得しようとするとゼロ値を返す。
        const Resolution& getResolution(std::size_t monitorIndex = 0) const;

        /// @brief アプリルートディレクトリパスを取得する。
        /// @return アプリルートディレクトリパス。
        ///
        /// - 通常はゲームIDが "SXXX" なら "Y:¥¥SXXX¥¥" を返す。
        /// - エミュレータ環境では任意の設定値を返す。
        ///   ただし設定値が空文字列の場合は ".¥¥" を返す。
        const wchar_t* getAppRootPath() const;
    };

/// @}
} // namespace amdaemon

#endif // AMDAEMON_SYSTEM_H