NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
enum_interface.h
Go to the documentation of this file.
1 #ifndef SDK_ENUM_INTERFACE_H_
11 #define SDK_ENUM_INTERFACE_H_
12 
13 #include "base/inc/platform.h"
14 #include "base/inc/base_types.h"
17 
18 namespace sdk {
19 
20 // Classes declared in this file.
21 FWD_DECL_INTERFACE(IEnumSDKString);
22 FWD_DECL_INTERFACE(IEnumSDKAny);
23 FWD_DECL_INTERFACE(IEnumSDKComponent);
24 typedef SDKRefPtr<IEnumSDKString> EnumSDKStringSP;
25 typedef SDKRefPtr<IEnumSDKAny> EnumSDKAnySP;
26 typedef SDKRefPtr<IEnumSDKComponent> EnumSDKComponentSP;
27 
30 class IEnumSDKString : public ISDKComponent {
31 public:
33  virtual SDKResult SDK_CALLTYPE Next(SDKString* string) const throw() = 0;
35  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
36 
37  SDK_IMPLEMENT_IID(IEnumSDKString)
38  SDK_END_INTERFACE(IEnumSDKString)
39 };
40 SDK_DECLARE_IID(IEnumSDKString)
41 
42 class IEnumSDKAny : public ISDKComponent {
45 public:
47  virtual SDKResult SDK_CALLTYPE Next(SDKAny* value) const throw() = 0;
49  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
50 
51  SDK_IMPLEMENT_IID(IEnumSDKAny)
52  SDK_END_INTERFACE(IEnumSDKAny)
53 };
54 SDK_DECLARE_IID(IEnumSDKAny)
55 
59 public:
61  virtual SDKResult SDK_CALLTYPE Next(ISDKComponent** value) const throw() = 0;
63  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
64 
65  SDK_IMPLEMENT_IID(IEnumSDKComponent)
66  SDK_END_INTERFACE(IEnumSDKComponent)
67 };
68 SDK_DECLARE_IID(IEnumSDKComponent)
69 
70 } // namespace sdk
71 
72 #endif // SDK_ENUM_INTERFACE_H_
base_types.h
SDK base types.
sdk::IEnumSDKComponent
Provides access to members that enumerate over a set of Any values.
Definition: enum_interface.h:58
sdk::IEnumSDKString
Provides access to members that enumerate over a set of strings.
Definition: enum_interface.h:30
sdk::IEnumSDKAny::Reset
virtual SDKResult SDK_CALLTYPE Reset()=0
Resets the enumeration sequence to the beginning.
sdk::IEnumSDKString::Reset
virtual SDKResult SDK_CALLTYPE Reset()=0
Resets the enumeration sequence to the beginning.
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::IEnumSDKString::Next
virtual SDKResult SDK_CALLTYPE Next(SDKString *string) const =0
Retrieves the next string in the enumeration sequence.
SDKRefPtr
A smart pointer class for managing SDK components interface pointers.
Definition: sdk_ref_ptr.h:23
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::IEnumSDKAny::Next
virtual SDKResult SDK_CALLTYPE Next(SDKAny *value) const =0
Retrieves the next Any value in the enumeration sequence.
sdk::IEnumSDKAny
Provides access to members that enumerate over a set of Any values.
Definition: enum_interface.h:44
FWD_DECL_INTERFACE
FWD_DECL_INTERFACE(ILWEParserWrapper)
Provides a wrapper around the message parser to get, add or remove the.