NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
ISDKConfiguration Class Referenceabstract

Provides access to members that return information and manage the configuration. More...

#include <generic_configuration_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetSubConfig (const SDKString &path, SDKConfigurationSP &config)=0 throw ()
 Returns a sub-config, specified by path. More...
 
virtual SDKResult SDK_CALLTYPE AddSubConfig (const SDKString &path, SDKConfigurationSP &config)=0 throw ()
 Adds a sub-config, specified by path.
 
virtual SDKResult SDK_CALLTYPE DeleteSubConfig (const SDKString &path)=0 throw ()
 Deletes a sub-config, specified by path.
 
virtual SDKResult SDK_CALLTYPE EnumSubConfigs (SDKConfigurationEnumeratorSP &configs)=0 throw ()
 Enumerates sub-configs.
 
virtual SDKResult SDK_CALLTYPE GetConfigEntry (const SDKString &name, SDKAny &value)=0 throw ()
 Returns a config entry.
 
virtual SDKResult SDK_CALLTYPE SetConfigEntry (const SDKString &name, const SDKAny &value)=0 throw ()
 Sets a config entry.
 
virtual SDKResult SDK_CALLTYPE AddConfigEntry (const SDKString &name, const SDKAny &value)=0 throw ()
 Adds a config entry.
 
virtual SDKResult SDK_CALLTYPE DeleteConfigEntry (const SDKString &name)=0 throw ()
 Deletes a config entry.
 
virtual SDKResult SDK_CALLTYPE EnumConfigEntries (SDKConfigEntriesEnumeratorSP &entries)=0 throw ()
 Enumerates config entries.
 
virtual SDKResult SDK_CALLTYPE Flush ()=0 throw ()
 Writes any buffered data to the underlying device.
 

Detailed Description

Provides access to members that return information and manage the configuration.

Member Function Documentation

◆ GetSubConfig()

virtual SDKResult SDK_CALLTYPE GetSubConfig ( const SDKString &  path,
SDKConfigurationSP &  config 
)
throw (
)
pure virtual

Returns a sub-config, specified by path.

Parameters
[in]pathPath parameter format: "/config1/config2"
[out]configAddress of a variable that receives the pointer to the ISDKConfiguration interface.

The documentation for this class was generated from the following file: