route_calculator_interface.h

Go to the documentation of this file.

 
#ifndef SDK_ROUTE_CALCULATOR_INTERFACE_H_
#define SDK_ROUTE_CALCULATOR_INTERFACE_H_
 
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_uuid.h>
#include <ecdislayer/inc/route_planning/route_storage_interfaces.h>
#include <ecdislayer/inc/route_planning/voyage_properties.h>
#include <ecdislayer/inc/ecdislayer_const.h>
 
SDK_ECDISLAYER_BEGIN_NAMESPACE
 
namespace routes { 
 
FWD_DECL_INTERFACE(IRouteCalculator);
 
enum RouteCalculatorParametersEnum {
  kRouteCalculatorParameter_DefaultSpeed = 0
};
 
class IRouteCalculator : public ISDKComponent {
public:
  virtual SDKResult SDK_CALLTYPE Initialize(
    const sdk::gdb::routes::IRouteSP& route,
    const ISDKParametersSP& parameters) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetRouteData(
    const ISDKParametersSP& input_parameters,
    VoyageProperties voyage_property, 
    SDKAny& data) const throw() = 0;
 
  template<class T>
  SDKResult GetRouteDataT(const ISDKParametersSP& input_parameters,
    VoyageProperties voyage_property, T& out_value) const throw() {
    ScopedAny value;
    SDKResult res = GetRouteData(input_parameters, voyage_property, value);
    if (SDK_FAILED(res))
      return res;
    if (ANY_IS_EMPTY(&value))
      return kSDKResult_NotExist;
    return value.GetAs< T >(out_value) ? kSDKResult_Succeeded : 
      kSDKResult_InvalidArgument;
  }
 
  SDK_IMPLEMENT_IID(IRouteCalculator)
  SDK_END_INTERFACE(IRouteCalculator)
};
SDK_DECLARE_IID(IRouteCalculator)
 
} // namespace routes
 
SDK_ECDISLAYER_END_NAMESPACE
 
#endif // SDK_ROUTE_CALCULATOR_INTERFACE_H_