parameters_interface.h

Go to the documentation of this file.

#ifndef SDK_BASE_PARAMETERS_INTERFACE_H_
#define SDK_BASE_PARAMETERS_INTERFACE_H_
 
#include <base/inc/sdk_results_enum.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
#include <base/inc/sdk_any_handler.h>
 
namespace sdk {
 
typedef SDKUInt32 SDKParameterID; // Parameter ID
 
// Classes declared in this file.
FWD_DECL_INTERFACE(ISDKParameters);
FWD_DECL_INTERFACE(ISDKParametersClone);
FWD_DECL_INTERFACE(ISDKParametersCollection);
FWD_DECL_INTERFACE(IEnumSDKParameter);
typedef ISDKParametersSP SDKParametersSP;
typedef ISDKParametersSCP SDKParametersSCP;
 
class ISDKParameters : public ISDKComponent {
 public:
   virtual SDKResult SDK_CALLTYPE GetParameter(
     SDKParameterID id,
     SDKAny& value) const throw() = 0;
 
   virtual SDKResult SDK_CALLTYPE SetParameter(
     SDKParameterID id,
     const SDKAny& value) throw() = 0;
 
   template<typename T>
   SDKResult GetParameterT(SDKParameterID id, T& out_value) const noexcept {
     sdk::ScopedAny value;
     SDKResult res = GetParameter(id, value);
     if (SDK_FAILED(res))
       return res;
     return value.GetAs< T >(out_value) ? 
        kSDKResult_Succeeded : kSDKResult_InvalidArgument;
   }
     
   template<typename T>
   inline SDKResult SetParameterT(SDKParameterID id, T new_value) noexcept {
     return SetParameter(id, sdk::ScopedAny(new_value));
   }
 
   SDK_IMPLEMENT_IID(ISDKParameters)
   SDK_END_INTERFACE(ISDKParameters)
};
SDK_DECLARE_IID(ISDKParameters)
 
class ISDKParametersClone : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Clone(
    ISDKParametersSP& clone) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKParametersClone)
  SDK_END_INTERFACE(ISDKParametersClone)
};
SDK_DECLARE_IID(ISDKParametersClone)
 
class ISDKParametersCollection : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Count(SDKUInt32& count) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetByIndex(SDKUInt32 idx,
    SDKParameterID& id, SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKParametersCollection)
  SDK_END_INTERFACE(ISDKParametersCollection)
};
SDK_DECLARE_IID(ISDKParametersCollection)
 
class IEnumSDKParameter : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Next(SDKParameterID& id, 
    SDKAny& value) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IEnumSDKParameter)
  SDK_END_INTERFACE(IEnumSDKParameter)
};
SDK_DECLARE_IID(IEnumSDKParameter)
 
} // namespace sdk
 
#endif // SDK_BASE_PARAMETERS_INTERFACE_H_