properties_interface.h

Go to the documentation of this file.

#ifndef SDK_BASE_PROPERTIES_INTERFACE_H_
#define SDK_BASE_PROPERTIES_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 SDKPropertyID; // Property ID
 
// Classes declared in this file.
FWD_DECL_INTERFACE(ISDKProperties);
FWD_DECL_INTERFACE(ISDKPropertiesClone);
FWD_DECL_INTERFACE(IEnumSDKProperty);
typedef ISDKPropertiesSP SDKPropertiesSP;
typedef ISDKPropertiesSCP SDKPropertiesSCP;
 
class ISDKProperties : public ISDKComponent {
 public:
  virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, 
    const SDKAny& value) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, 
    SDKAny& value) const throw() = 0;
 
  template<typename T>
  inline SDKResult GetPropertyT(const SDKPropertyID& id,
    T& out_value) const noexcept {
    sdk::ScopedAny value;
    SDKResult res = GetProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    return value.GetAs< T >(out_value) ? 
      kSDKResult_Succeeded : kSDKResult_InvalidArgument;
  }
 
  template<typename T>
  inline SDKResult SetPropertyT(const SDKPropertyID& id, T new_value) noexcept {
    return SetProperty(id, sdk::ScopedAny(new_value));
  }
 
  SDK_IMPLEMENT_IID(ISDKProperties)
  SDK_END_INTERFACE(ISDKProperties)
};
SDK_DECLARE_IID(ISDKProperties)
 
class ISDKPropertiesClone : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Clone(
    ISDKPropertiesSP& clone) const throw() = 0;
 
  SDK_IMPLEMENT_IID(ISDKPropertiesClone)
  SDK_END_INTERFACE(ISDKPropertiesClone)
};
SDK_DECLARE_IID(ISDKPropertiesClone)
 
class IEnumSDKProperty : public ISDKComponent {
 public:
   virtual SDKResult SDK_CALLTYPE Next(SDKPropertyID& id, 
     SDKAny& value) const throw() = 0;
 
   virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IEnumSDKProperty)
  SDK_END_INTERFACE(IEnumSDKProperty)
};
SDK_DECLARE_IID(IEnumSDKProperty)
 
} // namespace sdk
 
#endif // SDK_BASE_PROPERTIES_INTERFACE_H_