Provides access to members that manage the global symbol set catalog. The symbol set catalog contains the symbol collection, palettes and fonts. More...

#include <sdl_interface.h>

Inherits ISDKComponent.

Public Member Functions
virtual SDKResult SDK_CALLTYPE	RegisterSymbolSet (const SDKString &dir_path, const sdk::base::SDKStreamSP &in_xsdl, SDKString &symbol_set_name)=0 throw ()
	Registers a new or modifies/replace existing symbol set. More...

virtual SDKResult SDK_CALLTYPE	Clear ()=0 throw ()
	Clears all symbols and palettes. More...

virtual SDKResult SDK_CALLTYPE	GetVersion (const SDKString &symbol_set_name, SDKUInt16 &ver_major, SDKUInt16 &ver_minor)=0 throw ()
	Returns version of the specified Symbol Set. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolCollection (ISymbolCollectionSP &symbols)=0 throw ()
	Returns the symbol collection. More...

virtual SDKResult SDK_CALLTYPE	GetPaletteManager (IPaletteManagerSP &palette_manager)=0 throw ()
	Returns the palette manager. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolSetId (const SDKString &symbol_set_name, SDLResourceID &id)=0 throw ()
	Returns the symbol set internal identifier specified by its name. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolGeometryType (const SDLResourceID id, SymbolGeometryType &geom_type)=0 throw ()
	Returns the symbol geometry type. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolType (const SDLResourceID id, SymbolType &type)=0 throw ()
	Returns the symbol type. More...

virtual SDKResult SDK_CALLTYPE	GetColorId (const SDLResourceID symbol_set_id, const SDKString &color_name, SDLColorID &id)=0 throw ()
	Returns the color internal identifier by its name. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolId (const SDLResourceID symbol_set_id, const SDKString &symbol_name, SDLResourceID &id)=0 throw ()
	Returns the symbol internal identifier specified by its name. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolName (const SDLResourceID symbol_set_id, const SDLResourceID id, SDKString &symbol_name)=0 throw ()
	Returns the symbol name by its internal identifier. More...

virtual SDKResult SDK_CALLTYPE	GetSymbolParameterId (const SDLResourceID symbol_set_id, const SDLResourceID symbol_id, const SDKString &parameter_name, SDLResourceID &id)=0 throw ()
	Returns the symbol formal parameter internal identifier specified by its name. More...

virtual SDKResult SDK_CALLTYPE	CreateScript (ISDLScriptSP &script)=0 throw ()
	Creates an empty SDL P-code. More...

virtual SDKResult SDK_CALLTYPE	RegisterSymbol (SDLResourceID &id, const SDKString &symbol_set_name, const SDKString &script_name, const sdk::base::SDKStreamSP &p_code)=0 throw ()
	Registers SDL P-code. More...

virtual SDKResult SDK_CALLTYPE	GetSymbol (const SDLResourceID &symbol_id, sdk::base::SDKStreamSP &p_code)=0 throw ()
	Returns registered symbol's SDL P-code. More...

virtual SDKResult SDK_CALLTYPE	ParseCommand (const SDLResourceID symbol_set_id, const SDKString &command, SDLResourceID &id, sdk::base::SDKStreamSP &params_stream)=0 throw ()
	Parses textual SDL command. More...

virtual SDKResult SDK_CALLTYPE	CreateSymbolizer (ISymbolizerSP &symbolizer)=0 throw ()
	Creates Symbolizer for this Symbol Set Catalog.

virtual SDKResult SDK_CALLTYPE	GetID (SDKUInt32 &id)=0 throw ()
	Returns unique ID.

virtual SDKResult SDK_CALLTYPE	GetSymbolInfo (const SDLResourceID symbol_set_id, const SDLResourceID id, SDKString &symbol_info)=0 throw ()
	Returns the symbol info by its internal identifier. More...

virtual SDKResult SDK_CALLTYPE	CreateScriptFromXSDL (SDLResourceID &id, const SDKString &symbol_set_name, const sdk::base::SDKStreamSP &xsdl)=0 throw ()
	Creates, compiles and registers script from XML SDL text (XSDL). More...

Detailed Description

Provides access to members that manage the global symbol set catalog. The symbol set catalog contains the symbol collection, palettes and fonts.

Member Function Documentation

◆ RegisterSymbolSet()

virtual SDKResult SDK_CALLTYPE RegisterSymbolSet	(	const SDKString &	dir_path,
		const sdk::base::SDKStreamSP &	in_xsdl,
		SDKString &	symbol_set_name
	)
throw	(
	)

pure virtual

Registers a new or modifies/replace existing symbol set.

Parameters

[in]	in_xsdl	Pointer to stream object associated with the symbol set encoded in the XSDL (XML Symbol Definition Language) format.
[out]	symbol_set_name	The symbol set name.

Returns: Ok if succeeded.; Err_BadFormat in case of incorrect format.

◆ Clear()

virtual SDKResult SDK_CALLTYPE Clear	(	)
throw	(
	)

pure virtual

Clears all symbols and palettes.

Returns: Ok if succeeded.

◆ GetVersion()

virtual SDKResult SDK_CALLTYPE GetVersion	(	const SDKString &	symbol_set_name,
		SDKUInt16 &	ver_major,
		SDKUInt16 &	ver_minor
	)
throw	(
	)

pure virtual

Returns version of the specified Symbol Set.

Returns: Ok if succeeded.; Err_NotExist if there is no Symbol Set with the specified name.

◆ GetSymbolCollection()

virtual SDKResult SDK_CALLTYPE GetSymbolCollection	(	ISymbolCollectionSP &	symbols	)
throw	(
	)

pure virtual

Returns the symbol collection.

Parameters

[out] symbol Address of a variable that receives the pointer to the ISymbolCollection interface associated with the symbol collection.

Returns: Ok if succeeded.; Err_NotImpl.

◆ GetPaletteManager()

virtual SDKResult SDK_CALLTYPE GetPaletteManager	(	IPaletteManagerSP &	palette_manager	)
throw	(
	)

pure virtual

Returns the palette manager.

Parameters

[out] palette_manager Address of a variable that receives the pointer to the IPaletteManager interface associated with the palette manager.

Returns: Ok if succeeded.; Err_NotImpl.

◆ GetSymbolSetId()

virtual SDKResult SDK_CALLTYPE GetSymbolSetId	(	const SDKString &	symbol_set_name,
		SDLResourceID &	id
	)
throw	(
	)

pure virtual

Returns the symbol set internal identifier specified by its name.

Parameters

[in]	symbol_set_name	The symbol set name.
[out]	id	The symbol set resource identifier.

Returns: Ok if succeeded.; Err_InvalidArg if the symbol set could not be found.

◆ GetSymbolGeometryType()

virtual SDKResult SDK_CALLTYPE GetSymbolGeometryType	(	const SDLResourceID	id,
		SymbolGeometryType &	geom_type
	)
throw	(
	)

pure virtual

Returns the symbol geometry type.

Parameters

[in]	id	The symbol resource identifier.
[out]	geom_type	The symbol geometry type.

Returns: Ok if succeeded.; Err_InvalidArg if the symbol could not be found.

◆ GetSymbolType()

virtual SDKResult SDK_CALLTYPE GetSymbolType	(	const SDLResourceID	id,
		SymbolType &	type
	)
throw	(
	)

pure virtual

Returns the symbol type.

Parameters

[in]	id	The symbol resource identifier.
[out]	type	The symbol type.

Returns: Ok if succeeded.; Err_InvalidArg if the symbol could not be found.

◆ GetColorId()

virtual SDKResult SDK_CALLTYPE GetColorId	(	const SDLResourceID	symbol_set_id,
		const SDKString &	color_name,
		SDLColorID &	id
	)
throw	(
	)

pure virtual

Returns the color internal identifier by its name.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	color_name	The color name.
[out]	id	The color internal identifier.

Returns: Ok if succeeded.; Err_InvalidArg

◆ GetSymbolId()

virtual SDKResult SDK_CALLTYPE GetSymbolId	(	const SDLResourceID	symbol_set_id,
		const SDKString &	symbol_name,
		SDLResourceID &	id
	)
throw	(
	)

pure virtual

Returns the symbol internal identifier specified by its name.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	symbol_name	The symbol name.
[out]	id	The symbol internal identifier.

Returns: Ok if succeeded.; Err_InvalidArg

◆ GetSymbolName()

virtual SDKResult SDK_CALLTYPE GetSymbolName	(	const SDLResourceID	symbol_set_id,
		const SDLResourceID	id,
		SDKString &	symbol_name
	)
throw	(
	)

pure virtual

Returns the symbol name by its internal identifier.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	id	The symbol identifier.
[out]	symbol_name	The symbol name.

Returns: Ok if succeeded.; Err_InvalidArg

◆ GetSymbolParameterId()

virtual SDKResult SDK_CALLTYPE GetSymbolParameterId	(	const SDLResourceID	symbol_set_id,
		const SDLResourceID	symbol_id,
		const SDKString &	parameter_name,
		SDLResourceID &	id
	)
throw	(
	)

pure virtual

Returns the symbol formal parameter internal identifier specified by its name.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	symbol_id	The symbol identifier.
[in]	parameter_name	The symbol parameter name.
[out]	id	The symbol parameter identifier.

Returns: Ok if succeeded.; Err_InvalidArg

◆ CreateScript()

virtual SDKResult SDK_CALLTYPE CreateScript	(	ISDLScriptSP &	script	)
throw	(
	)

pure virtual

Creates an empty SDL P-code.

Parameters

[out] script Address of a variable that receives the pointer to the ISDLScript interface.

Returns: Ok if succeeded.; Err_NotImpl.

◆ RegisterSymbol()

virtual SDKResult SDK_CALLTYPE RegisterSymbol	(	SDLResourceID &	id,
		const SDKString &	symbol_set_name,
		const SDKString &	script_name,
		const sdk::base::SDKStreamSP &	p_code
	)
throw	(
	)

pure virtual

Registers SDL P-code.

Parameters

[out]	id	The symbol identifier.
[in]	symbol_set_id	The symbol set identifier.
[in]	symbol_name	The symbol name.
[in]	p_code	SDL P-code.

Returns: Ok if succeeded.; Err_NotImpl.

◆ GetSymbol()

virtual SDKResult SDK_CALLTYPE GetSymbol	(	const SDLResourceID &	symbol_id,
		sdk::base::SDKStreamSP &	p_code
	)
throw	(
	)

pure virtual

Returns registered symbol's SDL P-code.

Parameters

[in]	id	The symbol identifier.
[out]	p_code	SDL P-code.

Returns: Ok if succeeded.; kSDKResult_InvalidArgument if there is no symbol with specified id.

◆ ParseCommand()

virtual SDKResult SDK_CALLTYPE ParseCommand	(	const SDLResourceID	symbol_set_id,
		const SDKString &	command,
		SDLResourceID &	id,
		sdk::base::SDKStreamSP &	params_stream
	)
throw	(
	)

pure virtual

Parses textual SDL command.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	command	SDL command.
[out]	id	The symbol identifier.
[out]	parameters	Address of a variable that receives the pointer to the parameters stream.

Returns: Ok if succeeded.; Err_NotImpl.

◆ GetSymbolInfo()

virtual SDKResult SDK_CALLTYPE GetSymbolInfo	(	const SDLResourceID	symbol_set_id,
		const SDLResourceID	id,
		SDKString &	symbol_info
	)
throw	(
	)

pure virtual

Returns the symbol info by its internal identifier.

Parameters

[in]	symbol_set_id	The symbol set identifier.
[in]	id	The symbol identifier.
[out]	symbol_info	The symbol info.

Returns: Ok if succeeded.; Err_InvalidArg

◆ CreateScriptFromXSDL()

virtual SDKResult SDK_CALLTYPE CreateScriptFromXSDL	(	SDLResourceID &	id,
		const SDKString &	symbol_set_name,
		const sdk::base::SDKStreamSP &	xsdl
	)
throw	(
	)

pure virtual

Creates, compiles and registers script from XML SDL text (XSDL).

Parameters

[out]	id	The symbol identifier.
[in]	symbol_set_id	The symbol set identifier.
[in]	symbol_name	The symbol name.
[in]	xsdl	XSDL text stream.

Returns: Ok if succeeded.; Err_NotImpl.

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

sdl_interface.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ RegisterSymbolSet()

◆ Clear()

◆ GetVersion()

◆ GetSymbolCollection()

◆ GetPaletteManager()

◆ GetSymbolSetId()

◆ GetSymbolGeometryType()

◆ GetSymbolType()

◆ GetColorId()

◆ GetSymbolId()

◆ GetSymbolName()

◆ GetSymbolParameterId()

◆ CreateScript()

◆ RegisterSymbol()

◆ GetSymbol()

◆ ParseCommand()

◆ GetSymbolInfo()

◆ CreateScriptFromXSDL()