OutputId.h

[詳解]

/// @file
/// @brief 抽象出力の識別ID型 OutputId のヘッダ。
///
/// Copyright(C)SEGA

#ifndef AMDAEMON_OUTPUTID_H
#define AMDAEMON_OUTPUTID_H

#include "amdaemon/InputOutputId.h"

namespace amdaemon
{
/// @addtogroup g_io
/// @{

    /// 抽象出力識別IDタグ構造体。直接使うことはない。
    struct OutputIdTag { };

    /// @brief 抽象出力の識別ID型。
    /// @note memcpy 可能。
    ///
    /// 静的メンバ関数 make により文字列から構築する。
    /// コピー、等価比較、大小比較が可能である。
    ///
    /// @code
    /// // 文字列から構築
    /// amdaemon::OutputId idX = amdaemon::OutputId::make(L"my_switch");
    /// 
    /// // コピー可能
    /// amdaemon::OutputId idY = idX;
    /// 
    /// // 比較可能
    /// if (idX == idY)
    /// {
    ///     // 内容表示
    ///     std::wcout << idX.value << std::endl;
    /// }
    /// @endcode
    ///
    /// std::hash クラステンプレートの特殊化も定義されているため、
    /// std::unordered_map クラステンプレート等のキー型として利用可能である。
    ///
    /// @internal ライブラリ実装メモ: この型を直接共有メモリに配置する。
    typedef InputOutputId<OutputIdTag> OutputId;

/// @}
} // namespace amdaemon

#endif // AMDAEMON_OUTPUTID_H