151 lines
6.1 KiB
C++
151 lines
6.1 KiB
C++
/**
|
|
* @file KglGenCategory.h
|
|
*
|
|
* Copyright (c) 2020 Keyence Corporation.
|
|
* All rights reserved.
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <KglResult.h>
|
|
#include <KglDefine.h>
|
|
|
|
#include <cstdint>
|
|
|
|
namespace Keyence
|
|
{
|
|
|
|
class KglString;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Feature category class.
|
|
* \~Japanese @brief Featureカテゴリクラスです。
|
|
*/
|
|
class KGLLIB_API KglGenCategory
|
|
{
|
|
public:
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Default constructor.
|
|
* \~Japanese @brief デフォルトコンストラクタ。
|
|
*/
|
|
KglGenCategory(){}
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Destructor.
|
|
* \~Japanese @brief デストラクタ。
|
|
*/
|
|
virtual ~KglGenCategory(){}
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the category name.
|
|
* \~Japanese @brief カテゴリ名称を取得します。
|
|
* \~English @param [out] name category name.
|
|
* \~Japanese @param [out] name Category名称。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getName(KglString& name) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the tooltip for a category.
|
|
* \~Japanese @brief Categoryのツールチップを取得します。
|
|
* \~English @param [out] toolTip Tooltip for the category.
|
|
* \~Japanese @param [out] toolTip Categoryに対するツールチップ。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getToolTip(KglString& toolTip) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the description of a category.
|
|
* \~Japanese @brief Categoryの説明を取得します。
|
|
* \~English @param [out] description Description of the category.
|
|
* \~Japanese @param [out] description Categoryの説明。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getDescription(KglString& description) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the display name of a category.
|
|
* \~Japanese @brief Categoryの表示用名称を取得します。
|
|
* \~English @param [out] displayName Display name of the category.
|
|
* \~Japanese @param [out] displayName Categoryの表示用名称。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getDisplayName(KglString& displayName) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the namespace of a category.
|
|
* \~Japanese @brief Categoryのネームスペースを取得します。
|
|
* \~English @param [out] nameSpace Namespace of the category.
|
|
* \~Japanese @param [out] nameSpace Categoryのネームスペース。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getNameSpace(KglNameSpace& nameSpace) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves the visibility level of a category.
|
|
* \~Japanese @brief Categoryの可視レベルを取得します。
|
|
* \~English @param [out] visibility Visibility level of the category.
|
|
* \~Japanese @param [out] visibility Categoryの可視レベル。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenCategory.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenCategoryです。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected exception has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しない例外が発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult getVisibility(KglVisibility& visibility) const = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves whether the specified visibility level is allowed.
|
|
* \~Japanese @brief 指定した可視レベルで見ることができるか否かを取得します。
|
|
* \~English @param [in] visibility Visibility level.
|
|
* \~Japanese @param [in] visibility 可視レベル。
|
|
* \~English @retval true Allowed.
|
|
* \~Japanese @retval true 見ることができます。
|
|
* \~English @retval false Not allowed.
|
|
* \~Japanese @retval false 見ることができません。
|
|
*/
|
|
virtual bool isVisible(const KglVisibility visibility) const = 0;
|
|
|
|
protected:
|
|
|
|
};
|
|
|
|
}; //end of namespace Keyence
|