NAVTOR SDK  v.3.0
Software Development Kit for fast and efficient development of ECDIS, ECS and generic marine applications
Public Member Functions
ISDKParameters Class Referenceabstract
Base Layer » Base Interfaces » Parameters and Properties

Provides access to members that manage parameters of an object. More...

#include <parameters_interface.h>

Inheritance diagram for ISDKParameters:
ISceneManagerInitialParameters IPortrayalParameters ISceneLayersManagerUpdateParameters IBackendInitialParameters IGraphicContextInitialParameters IRenderContext BackendInitParametersHelper GraphicContextInitParametersHelper

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetParameter (SDKParameterID id, SDKAny &value) const =0 throw ()
 Returns the value of the specified parameter. More...
 
virtual SDKResult SDK_CALLTYPE SetParameter (SDKParameterID id, const SDKAny &value)=0 throw ()
 Sets the value of the specified parameter. More...
 
template<typename T >
SDKResult GetParameterT (SDKParameterID id, T &out_value) const noexcept
 Returns the value of the specified parameter. More...
 
template<typename T >
SDKResult SetParameterT (SDKParameterID id, T new_value) noexcept
 Sets the value of the specified parameter. More...
 

Detailed Description

Provides access to members that manage parameters of an object.

Member Function Documentation

◆ GetParameter()

virtual SDKResult SDK_CALLTYPE GetParameter ( SDKParameterID  id,
SDKAny &  value 
) const
throw (
)
pure virtual

Returns the value of the specified parameter.

Parameters
id[in] A parameter identifier.
value[out] The value of the specified parameter.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound

◆ SetParameter()

virtual SDKResult SDK_CALLTYPE SetParameter ( SDKParameterID  id,
const SDKAny &  value 
)
throw (
)
pure virtual

Sets the value of the specified parameter.

Parameters
id[in] A parameter identifier.
value[in] The value of the specified parameter.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound

◆ GetParameterT()

SDKResult GetParameterT ( SDKParameterID  id,
T &  out_value 
) const
inlinenoexcept

Returns the value of the specified parameter.

Parameters
id[in] A parameter identifier.
value[out] The value of the specified parameter.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound
kSDKResult_InvalidArgument

◆ SetParameterT()

SDKResult SetParameterT ( SDKParameterID  id,
T  new_value 
)
inlinenoexcept

Sets the value of the specified parameter.

Parameters
id[in] A parameter identifier.
value[in] The value of the specified parameter.
Returns
kSDKResult_Succeeded
kSDKResult_NotImplemented
kSDKResult_NotFound
The documentation for this class was generated from the following file: