VisionPlus_V3.0/DependentLibrary/DahuaCamera/SDK/Include/GenICam/UserSetControl.h

#ifndef __DAHUA_GENICAM_USERSETCONTROL_H__
#define __DAHUA_GENICAM_USERSETCONTROL_H__

#include "Defs.h"
#include "ParameterNode.h"

GENICAM_NAMESPACE_BEGIN

class IUserSetControl;

typedef Memory::TSharedPtr<IUserSetControl> IUserSetControlPtr;

/// \ingroup config
/// @{

/// \~chinese
/// \brief Class IUserSetControl UserSetControl下属性操作类
/// \~english
/// \brief IUserSetControl's property operation class
class GENICAM_API IUserSetControl
{
public:
	virtual ~IUserSetControl() {}

public:
	enum EConfigSet
	{
		userSetDefault = 0,		///< \~chinese 相机默认配置集合         ///< \~english camera default set
		userSet1 = 1,			///< \~chinese 【读写】相机配置集合1    ///< \~english camera user set 1 ( Can be read and written )
		userSet2 = 2,			///< \~chinese 【读写】相机配置集合2    ///< \~english camera user set 2 ( Can be read and written )
		userSetInvalid
	};

public:
	/// \~chinese
	/// \brief 恢复相机默认配置
	/// \return 成功返回true，否则返回false
	/// \~english
	/// \brief restore camera's default configuration
	/// \return success:true, fail:false
	virtual bool restoreDefault() = 0;

	/// \~chinese
	/// \brief 设置相机当前配置，并生效且下次以该配置启动
	/// \param [in] configSet 要设置的配置集合
	/// \return 成功返回true，否则返回false
	/// \~english
	/// \brief set current camera configuration, these configurations will take effect immediately and load this userset on next time when start camera
	/// \param [in] configSet configuration sets 
	/// \return success:true, fail:false
	virtual bool setCurrentUserSet(EConfigSet configSet = userSet1) = 0;

	/// \~chinese
	/// \brief 保存相机当前配置到某配置集合，如userSet1
	/// \param [in] configSet 要保存到的配置集合
	/// \return 成功返回true，否则返回false
	/// \~english
	/// \brief save current configuration into certain userset, for example, userSet1
	/// \param [in] configSet save the configuration sets
	/// \return success:true, fail:false
	virtual bool saveUserSet(EConfigSet configSet = userSet1) = 0;

	/// \~chinese
	/// \brief 获取相机当前配置集合
	/// \return 返回配置集合枚举值
	/// \~english
	/// \brief get current user set
	/// \return return enumeration value of configuration set 
	virtual EConfigSet getCurrentUserSet() = 0;

	/// \~chinese
	/// \brief 获取相机当前UserSet相关是否可用
	/// \return 可用返回true，否则返回false
	/// \~english
	/// \brief get status of current user set and check whether it is available or not
	/// \return available:true, not available:false
	virtual bool isAvailable() const = 0;
};

/// @}

GENICAM_NAMESPACE_END

#endif // __DAHUA_GENICAM_USERSETCONTROL_H__