77 lines
3.6 KiB
C++
77 lines
3.6 KiB
C++
/**
|
|
* @file KglGenCommand.h
|
|
*
|
|
* Copyright (c) 2017 Keyence Corporation.
|
|
* All rights reserved.
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <KglGenParameter.h>
|
|
|
|
namespace Keyence
|
|
{
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Feature parameter class (Command).
|
|
* \~Japanese @brief Feature(Command)パラメータクラスです。
|
|
*/
|
|
class KGLLIB_API KglGenCommand : public KglGenParameter
|
|
{
|
|
public:
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Default constructor.
|
|
* \~Japanese @brief デフォルトコンストラクタ。
|
|
*/
|
|
KglGenCommand() : KglGenParameter(){}
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Destructor.
|
|
* \~Japanese @brief デストラクタ。
|
|
*/
|
|
virtual ~KglGenCommand(){}
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Executes a feature (Command). To query whether the execution was successful, use isDoneCommand.
|
|
* \~Japanese @brief Feature(Command)を実行します。実行が完了したか否かはisDoneを利用して問い合わせてください。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenParameter.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenParameterです。
|
|
* \~English @retval KGL_ERR_INVALID_FEATURE_ACCESS The requested operation resulted in an error regarding the Available attribute, access type, or range check of the feature.
|
|
* \~Japanese @retval KGL_ERR_INVALID_FEATURE_ACCESS 要求された操作はFeatureのAvailable属性、アクセスタイプ、範囲チェックのいずれかでエラーが発生しました。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected error has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しないエラーが発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult execute() = 0;
|
|
|
|
//------------------------------------------------------------
|
|
/**
|
|
* \~English @brief Retrieves whether the synchronous feature command execution is completed. Check "VJ Series System Integration Manual" for the asynchronous feature command execution.
|
|
* \~Japanese @brief Feature(Command)の実行が完了したか否かを取得します。同期のCommandに対しては本APIで確認できますが、非同期のCommandの確認は"VJ シリーズ システムインテグレーションマニュアル"を参照してください。
|
|
* \~English @param [out] isDone True is set when the execution is complete.
|
|
* \~Japanese @param [out] isDone 実行完了している場合はtrueが設定されます。
|
|
* \~English @retval KGL_ERR_NOT_INITIALIZED An invalid KglGenParameter.
|
|
* \~Japanese @retval KGL_ERR_NOT_INITIALIZED 無効なKglGenParameterです。
|
|
* \~English @retval KGL_ERR_INVALID_FEATURE_ACCESS The requested operation resulted in an error regarding the Available attribute, access type, or range check of the feature.
|
|
* \~Japanese @retval KGL_ERR_INVALID_FEATURE_ACCESS 要求された操作はFeatureのAvailable属性、アクセスタイプ、範囲チェックのいずれかでエラーが発生しました。
|
|
* \~English @retval KGL_GENERIC_ERROR An unexpected error has occurred.
|
|
* \~Japanese @retval KGL_GENERIC_ERROR 予期しないエラーが発生しました。
|
|
* \~English @retval KGL_SUCCESS Success.
|
|
* \~Japanese @retval KGL_SUCCESS 成功。
|
|
*/
|
|
virtual KglResult isDone(bool& isDone) = 0;
|
|
|
|
private:
|
|
|
|
KglGenCommand(const KglGenCommand&);
|
|
const KglGenCommand &operator=(const KglGenCommand&);
|
|
};
|
|
|
|
}; //end of namespace Keyence
|