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

SDL script. More...

#include <sdl_script_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType (SymbolGeometryType &geom_type)=0 throw ()
 Returns the symbol geometry type. More...
 
virtual SDKResult SDK_CALLTYPE GetSymbolType (SymbolType &type)=0 throw ()
 Returns the symbol type. More...
 
virtual SDKResult SDK_CALLTYPE GetRootElement (ISDLElementSP &root_element)=0 throw ()
 Returns the root element. More...
 
virtual SDKResult SDK_CALLTYPE Compile (sdk::base::SDKStreamSP &p_code)=0 throw ()
 Compiles XSDL source to byte-code. More...
 
virtual SDKResult SDK_CALLTYPE CreateRootElement (NodeType type, ISDLElementSP &element)=0 throw ()
 Creates SDL root element. More...
 
virtual SDKResult SDK_CALLTYPE CreateElement (NodeType type, ISDLElementSP &element)=0 throw ()
 Creates SDL element. More...
 
virtual SDKResult SDK_CALLTYPE CreateParameters (ISDLParametersCollectionSP &parameters)=0 throw ()
 Creates an empty parameters collection. More...
 
virtual SDKResult SDK_CALLTYPE Write (sdk::base::SDKStreamSP &stream)=0 throw ()
 Writes...
 
virtual SDKResult SDK_CALLTYPE Read (const sdk::base::SDKStreamSP &stream)=0 throw ()
 Reads...
 

Detailed Description

SDL script.

Member Function Documentation

◆ GetSymbolGeometryType()

virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType ( SymbolGeometryType &  geom_type)
throw (
)
pure virtual

Returns the symbol geometry type.

Parameters
[out]geom_typeThe symbol geometry type.
Returns
Ok if succeeded.
Err_InvalidArg if the symbol could not be found.

◆ GetSymbolType()

virtual SDKResult SDK_CALLTYPE GetSymbolType ( SymbolType &  type)
throw (
)
pure virtual

Returns the symbol type.

Parameters
[out]typeThe symbol type.
Returns
Ok if succeeded.
Err_InvalidArg if the symbol could not be found.

◆ GetRootElement()

virtual SDKResult SDK_CALLTYPE GetRootElement ( ISDLElementSP &  root_element)
throw (
)
pure virtual

Returns the root element.

Parameters
[out]root_elementAddress of a variable that receives the pointer to the root element.
Returns
Ok if succeeded.
Err_NotExist if root element is empty.
Err_NotImpl.

◆ Compile()

virtual SDKResult SDK_CALLTYPE Compile ( sdk::base::SDKStreamSP &  p_code)
throw (
)
pure virtual

Compiles XSDL source to byte-code.

Parameters
[out]byte_codeAddress of a variable that receives the pointer to the compiled byte-code stream.
Returns
Ok if succeeded.
Err_InvalidArg if failed.
Err_NotImpl.

◆ CreateRootElement()

virtual SDKResult SDK_CALLTYPE CreateRootElement ( NodeType  type,
ISDLElementSP &  element 
)
throw (
)
pure virtual

Creates SDL root element.

Parameters
[out]parametersAddress of a variable that receives the pointer to the parameters collection.
Returns
Ok if succeeded.
Err_NotImpl.

◆ CreateElement()

virtual SDKResult SDK_CALLTYPE CreateElement ( NodeType  type,
ISDLElementSP &  element 
)
throw (
)
pure virtual

Creates SDL element.

Parameters
[out]parametersAddress of a variable that receives the pointer to the parameters collection.
Returns
Ok if succeeded.
Err_NotImpl.

◆ CreateParameters()

virtual SDKResult SDK_CALLTYPE CreateParameters ( ISDLParametersCollectionSP &  parameters)
throw (
)
pure virtual

Creates an empty parameters collection.

Parameters
[out]parametersAddress of a variable that receives the pointer to the parameters collection.
Returns
Ok if succeeded.
Err_NotImpl.
The documentation for this class was generated from the following file: