NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
permits_interface.h
Go to the documentation of this file.
1 #ifndef SDK_PERMITS_INTERFACE_H_
11 #define SDK_PERMITS_INTERFACE_H_
12 
13 #include <base/inc/platform.h>
14 #include <base/inc/base_types.h>
17 #include <base/inc/sdk_ref_ptr.h>
19 
20 namespace sdk {
21 
22 // Classes declared in this file.
23 FWD_DECL_INTERFACE(IPermitCollection);
24 FWD_DECL_INTERFACE(IPermit);
25 
28 typedef enum PermitPropertyEnum {
32 
36  public:
43  virtual SDKResult SDK_CALLTYPE FindPermit(const SDKAny& permit_key,
44  IPermit** permit) throw() = 0;
45 
46  SDK_IMPLEMENT_IID(IPermitCollection)
47  SDK_END_INTERFACE(IPermitCollection)
48 };
49 SDK_DECLARE_IID(IPermitCollection)
50 
51 class IPermit : public ISDKProperties {
55 public:
56 
57  SDK_IMPLEMENT_IID(IPermit)
58  SDK_END_INTERFACE(IPermit)
59 };
60 SDK_DECLARE_IID(IPermit)
61 
62 } // namespace sdk
63 
64 #endif // SDK_BASE_PARAMETERS_INTERFACE_H_
base_types.h
SDK base types.
sdk::PermitPropertyEnum
PermitPropertyEnum
The permit property enumeration.
Definition: permits_interface.h:28
sdk_ref_ptr.h
Interfaces wrapper with reference count control.
sdk::IPermitCollection
Provides access to members that can be used to access the permits.
Definition: permits_interface.h:35
sdk::IPermitCollection::FindPermit
virtual SDKResult SDK_CALLTYPE FindPermit(const SDKAny &permit_key, IPermit **permit)=0
Finds a permit specified by the permit key.
properties_interface.h
Object generic properties interface.
SDKResult
SDKInt32 SDKResult
Type of all error or return codes which SDK functions can end with.
Definition: sdk_results.h:17
sdk::ISDKProperties
Provides access to members that control the properties.
Definition: properties_interface.h:32
sdk_component_interface.h
Common base SDK interfaces.
sdk::kPermitProperty_ExpirationDate
@ kPermitProperty_ExpirationDate
Expiration date.
Definition: permits_interface.h:30
sdk::kPermitProperty_ID
@ kPermitProperty_ID
The permit identifier (dataset name).
Definition: permits_interface.h:29
sdk::IPermit
An indicator interface that provides access to the permit properties. See the PermitPropertyEnum for ...
Definition: permits_interface.h:54
platform.h
Describes the platform constants.
ISDKComponent
Base interface for all SDK interfaces.
Definition: sdk_component_interface.h:41
sdk_results_enum.h
SDK return values synonyms in the sdk namespace.
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.