NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
crs_coordinate_system.h
Go to the documentation of this file.
1 #ifndef SDK_CRS_COORDINATE_SYSTEM_INTERFACE_H_
12 #define SDK_CRS_COORDINATE_SYSTEM_INTERFACE_H_
13 #pragma once
14 
15 #include <base/inc/platform.h>
16 #include <base/inc/base_types.h>
19 #include <base/inc/sdk_ref_ptr.h>
20 #include <base/inc/sdk_results.h>
21 
22 namespace sdk {
23 namespace crs { // coordinate systems
24 
25 // Classes declared in this file.
26 FWD_DECL_INTERFACE(ICoordinateSystem);
27 
31 public:
33  virtual SDKResult SDK_CALLTYPE GetName(SDKString& name) const throw() = 0;
35  virtual SDKResult SDK_CALLTYPE SetName(const SDKString& name) throw() = 0;
36 
38  virtual SDKUInt8 SDK_CALLTYPE GetDimension() const throw() = 0;
40  virtual SDKResult SDK_CALLTYPE SetDimension(SDKUInt8 dimension) throw() = 0;
41 
43  virtual SDKResult SDK_CALLTYPE GetParameter(
44  SDKUInt32 parameter,
45  SDKAny& value) const throw() = 0;
47  virtual SDKResult SDK_CALLTYPE SetParameter(
48  SDKUInt32 parameter,
49  const SDKAny& value) throw() = 0;
50 
51  SDK_IMPLEMENT_IID(ICoordinateSystem)
52  SDK_END_INTERFACE(ICoordinateSystem)
53 };
54 SDK_DECLARE_IID(ICoordinateSystem)
55 
56 } // namespace crs
57 } // namespace sdk
58 
59 #endif // SDK_CRS_COORDINATE_SYSTEM_INTERFACE_H_
sdk::crs::ICoordinateSystem::SetParameter
virtual SDKResult SDK_CALLTYPE SetParameter(SDKUInt32 parameter, const SDKAny &value)=0
Sets a parameter value for the coordinate system.
sdk_results.h
A list of SDK error/return results.
base_types.h
SDK base types.
sdk::crs::ICoordinateSystem::SetDimension
virtual SDKResult SDK_CALLTYPE SetDimension(SDKUInt8 dimension)=0
Sets the dimension of the coordinate system.
sdk_ref_ptr.h
Interfaces wrapper with reference count control.
sdk::crs::ICoordinateSystem::SetName
virtual SDKResult SDK_CALLTYPE SetName(const SDKString &name)=0
Sets the name of the coordinate system.
sdk_string_handler.h
Wrappers and helper functions for SDKString.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk::crs::ICoordinateSystem::GetName
virtual SDKResult SDK_CALLTYPE GetName(SDKString &name) const =0
Gets the name of the coordinate system.
sdk::crs::ICoordinateSystem::GetDimension
virtual SDKUInt8 SDK_CALLTYPE GetDimension() const =0
Gets the dimension of the coordinate system.
sdk_component_interface.h
Common base SDK interfaces.
platform.h
Describes the platform constants.
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
sdk::crs::ICoordinateSystem
Base interface for coordinate systems.
Definition: crs_coordinate_system.h:30
sdk::crs::ICoordinateSystem::GetParameter
virtual SDKResult SDK_CALLTYPE GetParameter(SDKUInt32 parameter, SDKAny &value) const =0
Gets a parameter value for the coordinate system.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.