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

SDL element. More...

#include <sdl_script_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE Type (NodeType &type) const =0 throw ()
 Type...
 
virtual SDKResult SDK_CALLTYPE GetAncestor (ISDLElementSP &ancestor)=0 throw ()
 Returns the nearest ancestor element. More...
 
virtual SDKResult SDK_CALLTYPE GetDescendants (ISDLElementCollectionSP &descendants)=0 throw ()
 Returns descendants of the element. More...
 
virtual SDKResult SDK_CALLTYPE AddAttribute (AttributeType type, const SDKAny &value)=0 throw ()
 Adds attribute...
 
virtual SDKResult SDK_CALLTYPE AddPointAttribute (AttributeType type, const SDKPointF2D &value)=0 throw ()
 Adds point attribute.
 
virtual SDKResult SDK_CALLTYPE AddSizeAttribute (AttributeType type, const SDKSizeF &value)=0 throw ()
 Adds size attribute.
 
virtual SDKResult SDK_CALLTYPE AddParameter (SDLResourceID id, const SDKAny &value)=0 throw ()
 Adds parameter.
 
virtual SDKResult SDK_CALLTYPE GetAttribute (AttributeType type, SDKAny &value) const =0 throw ()
 Returns attribute.
 
virtual SDKResult SDK_CALLTYPE SetAttribute (AttributeType type, const SDKAny &value)=0 throw ()
 Sets attribute.
 
virtual SDKResult SDK_CALLTYPE AddElement (ISDLElementSP &child, NodeType type)=0 throw ()
 Adds element.
 
virtual SDKResult SDK_CALLTYPE AttachElement (ISDLElementSP &child, NodeType type, AnchorType anchor, float x_offset, float y_offset)=0 throw ()
 Attaches element.
 
virtual SDKResult SDK_CALLTYPE AddSymbol (ISDLElementSP &child, SDLResourceID symbol_id, const sdk::base::SDKStreamSP &params)=0 throw ()
 Adds symbol.
 
virtual SDKResult SDK_CALLTYPE AttachSymbol (ISDLElementSP &child, SDLResourceID symbol_id, const sdk::base::SDKStreamSP &params, AnchorType anchor, float x_offset, float y_offset)=0 throw ()
 Attaches symbol.
 
virtual SDKResult SDK_CALLTYPE AddSymbolByName (ISDLElementSP &child, const SDKString &symbol_name, const sdk::base::SDKStreamSP &params)=0 throw ()
 Adds symbol by name.
 
virtual SDKResult SDK_CALLTYPE AttachSymbolByName (ISDLElementSP &child, const SDKString &symbol_name, const sdk::base::SDKStreamSP &params, AnchorType anchor, float x_offset, float y_offset)=0 throw ()
 Attaches symbol by name.
 
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 element.

Member Function Documentation

◆ GetAncestor()

virtual SDKResult SDK_CALLTYPE GetAncestor ( ISDLElementSP &  ancestor)
throw (
)
pure virtual

Returns the nearest ancestor element.

Parameters
[out]ancestorAddress of a variable that receives the pointer to the ancestor element.
Returns
Ok if succeeded.
Err_NotExist if there is no ancestor.
Err_NotImpl.

◆ GetDescendants()

virtual SDKResult SDK_CALLTYPE GetDescendants ( ISDLElementCollectionSP &  descendants)
throw (
)
pure virtual

Returns descendants of the element.

Parameters
[out]descendantsAddress of a variable that receives the pointer to the collection of descendants.
Returns
Ok if succeeded.
Err_NotExist if there is no descendants.
Err_NotImpl.
The documentation for this class was generated from the following file: