Route storage interface. More...

#include <route_storage_interfaces.h>

Inheritance diagram for IRouteStorage:

Public Member Functions
virtual SDKResult SDK_CALLTYPE	CreateParametersContainer (ISDKParametersSP &parameters)=0 throw ()
	Create empty container for parameters.

virtual SDKResult SDK_CALLTYPE	Initialize (RouteStorageTypes storage_type, const ISDKParametersSP &parameters)=0 throw ()
	Initializes storage.

virtual SDKResult SDK_CALLTYPE	GetRouteCount (SDKUInt32 &routes_count) const =0 throw ()
	Returns number of routes in the storage.

virtual SDKResult SDK_CALLTYPE	GetRoute (SDKUInt32 route_index, IRouteSP &route) const =0 throw ()
	Returns specified route.

virtual SDKResult SDK_CALLTYPE	Find (const SDKString &route_name, IRouteSP &route) const =0 throw ()
	Finds route by name.

virtual SDKResult SDK_CALLTYPE	CreateRoute (const SDKString &route_name, const SDKString &workspace_name, IRouteEditorSP &route_editor)=0 throw ()
	Creates new route.

virtual SDKResult SDK_CALLTYPE	EditRoute (const SDKString &route_name, const SDKString &workspace_name, IRouteEditorSP &route_editor)=0 throw ()
	Starts route editing.

virtual SDKResult SDK_CALLTYPE	DeleteRoute (const SDKString &route_name)=0 throw ()
	Removes route from the storage.

virtual SDKResult SDK_CALLTYPE	GetRouteStatus (const SDKAny &route_id, SDKUInt64 &status)=0 throw ()
	Returns route status.

virtual SDKResult SDK_CALLTYPE	SetRouteStatus (const SDKAny &route_id, const SDKUInt64 &status)=0 throw ()
	Sets route status.

virtual SDKResult SDK_CALLTYPE	SaveRoute (const SDKAny &route_id)=0 throw ()
	Saves route to the persistent storage.

virtual SDKResult SDK_CALLTYPE	GetFileNameFromRouteName (SDKUInt32 route_format, const SDKString &route_name, SDKString &route_file_name) const =0 throw ()
	Returns route file name from route name.

virtual SDKResult SDK_CALLTYPE	GetNamesOfRoutesFromFile (SDKUInt32 &route_format, const SDKString &route_file_pathname, IEnumSDKStringSP &enum_route_name)=0 throw ()
	Returns the names of routes the route file. More...

virtual SDKResult SDK_CALLTYPE	ImportRoute (SDKUInt32 route_format, const SDKString &input_route_path, const SDKString &output_route_filename, const SDKString &route_name_to_import, const SDKString &route_name_to_set, IRouteEditorSP &route_editor)=0 throw ()
	Imports route in requested format. More...

virtual SDKResult SDK_CALLTYPE	ImportRoute (SDKUInt32 route_format, const SDKString &input_route_path, const ISDKParametersSP &parameters, IRouteEditorSP &route_editor)=0 throw ()
	Imports route in requested format. More...

virtual SDKResult SDK_CALLTYPE	ExportRoute (SDKUInt32 route_format, const SDKString &route_name, const SDKString &route_dirname, const SDKString &route_filename) const =0 throw ()
	Exports route in requested format. More...

virtual SDKResult SDK_CALLTYPE	ExportRoute (SDKUInt32 route_format, const SDKString &route_name, const SDKString &route_dirname, const ISDKParametersSP &parameters) const =0 throw ()
	Exports route in requested format. More...

virtual SDKResult SDK_CALLTYPE	ReloadRoute (const SDKString &route_file_pathname)=0 throw ()
	Reloads route from persistent storage.

virtual SDKResult SDK_CALLTYPE	GetSupportedRouteFormats (ICollectionSDKPropertiesSP &route_formats) const =0 throw ()
	Returns supported route formats. More...

virtual SDKResult SDK_CALLTYPE	GetRouteFileContent (const SDKString &route_name, SDKArray &route_content) const =0 throw ()
	Returns raw content of the route. More...

virtual SDKResult SDK_CALLTYPE	EditRouteFromRouteFileContent (const SDKArray &route_file_content, const SDKString &workspace_name, IRouteEditorSP &route_editor)=0 throw ()
	Starts route editing.

virtual SDKResult SDK_CALLTYPE	RestoreRoute (const SDKString &route_name)=0 throw ()
	Restore route from the bin storage.

virtual SDKResult SDK_CALLTYPE	DeleteRoutePermanently (const SDKString &route_name)=0 throw ()
	Restore route from the bin storage.

virtual SDKResult SDK_CALLTYPE	ExportRouteToStream (SDKUInt32 route_format, const SDKString &route_name, const ISDKParametersSP &params, base::ISDKStreamSP &stream) const =0 throw ()
	Exports route in requested format to the stream. More...

Public Member Functions inherited from ISDKComponent
virtual SDKAtomicRefCount SDK_CALLTYPE	AddRef () const =0 throw ()
	Increments the reference count for an interface on a component.

virtual SDKAtomicRefCount SDK_CALLTYPE	Release () const =0 throw ()
	Decrements the reference count for an interface on a component.

virtual SDKResult SDK_CALLTYPE	GetInterface (const InterfaceId &id, void **obj_ptr)=0 throw ()
	Returns pointers to the supported interfaces on a component.

template<typename _Itf >
SDKResult	GetInterface (_Itf **obj_ptr) throw ()
	Returns pointers to the supported interfaces on a component.

Detailed Description

Route storage interface.

Member Function Documentation

◆ GetNamesOfRoutesFromFile()

virtual SDKResult SDK_CALLTYPE GetNamesOfRoutesFromFile	(	SDKUInt32 &	route_format,
		const SDKString &	route_file_pathname,
		IEnumSDKStringSP &	enum_route_name
	)
throw	(
	)

pure virtual

Returns the names of routes the route file.

Parameters

route_format [in/out] Route format.

◆ ImportRoute() [1/2]

virtual SDKResult SDK_CALLTYPE ImportRoute	(	SDKUInt32	route_format,
		const SDKString &	input_route_path,
		const SDKString &	output_route_filename,
		const SDKString &	route_name_to_import,
		const SDKString &	route_name_to_set,
		IRouteEditorSP &	route_editor
	)
throw	(
	)

pure virtual

Imports route in requested format.

Parameters

[in]	route_format	Route format.
[in]	input_route_path	Path to the source route file.
[in]	[optional]	output_route_filename Output file name.
[in]	route_name_to_import	The route name to import. Empty string is accepted, first route is imported in this case.
[in]	[optional]	route_name_to_set The route name of imported route. Empty string is accepted, original route name is used.
[out]	route_editor

◆ ImportRoute() [2/2]

virtual SDKResult SDK_CALLTYPE ImportRoute	(	SDKUInt32	route_format,
		const SDKString &	input_route_path,
		const ISDKParametersSP &	parameters,
		IRouteEditorSP &	route_editor
	)
throw	(
	)

pure virtual

Imports route in requested format.

Parameters

[in]	route_format	Route format.
[in]	input_route_path	Path to the source route file.
[in]	[optional]	parameters Additional parameters (see enum RouteImportParameters).
[out]	route_editor

◆ ExportRoute() [1/2]

virtual SDKResult SDK_CALLTYPE ExportRoute	(	SDKUInt32	route_format,
		const SDKString &	route_name,
		const SDKString &	route_dirname,
		const SDKString &	route_filename
	)		const
throw	(
	)

pure virtual

Exports route in requested format.

Parameters

[in]	route_format	Route format
[in]	route_name	The route name
[in]	route_dirname	Name of the directory where to save the route
[in]	route_filename	The filename of the exported route

◆ ExportRoute() [2/2]

virtual SDKResult SDK_CALLTYPE ExportRoute	(	SDKUInt32	route_format,
		const SDKString &	route_name,
		const SDKString &	route_dirname,
		const ISDKParametersSP &	parameters
	)		const
throw	(
	)

pure virtual

Exports route in requested format.

Parameters

[in]	route_format	Route format
[in]	route_name	The route name
[in]	route_dirname	Name of the directory where to save the route
[in]	[optional]	parameters Additional parameters (see enum RouteExportParameters).

◆ GetSupportedRouteFormats()

virtual SDKResult SDK_CALLTYPE GetSupportedRouteFormats	(	ICollectionSDKPropertiesSP &	route_formats	)	const
throw	(
	)

pure virtual

Returns supported route formats.

Parameters

route_formats [out] Address of variable that receives the ICollectionSDKProperties interface (see enum RouteFormatProperties).

◆ GetRouteFileContent()

virtual SDKResult SDK_CALLTYPE GetRouteFileContent	(	const SDKString &	route_name,
		SDKArray &	route_content
	)		const
throw	(
	)

pure virtual

Returns raw content of the route.

Parameters

route_name	[in] The route name.
route_content	[out] Address of a variable that receives the route content.

◆ ExportRouteToStream()

virtual SDKResult SDK_CALLTYPE ExportRouteToStream	(	SDKUInt32	route_format,
		const SDKString &	route_name,
		const ISDKParametersSP &	params,
		base::ISDKStreamSP &	stream
	)		const
throw	(
	)

pure virtual

Exports route in requested format to the stream.

Parameters

[in]	route_format	Route format
[in]	route_name	The route name
[in]	params	Route export parameters
[out]	stream	Stream for exported route

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

route_storage_interfaces.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ GetNamesOfRoutesFromFile()

◆ ImportRoute() [1/2]

◆ ImportRoute() [2/2]

◆ ExportRoute() [1/2]

◆ ExportRoute() [2/2]

◆ GetSupportedRouteFormats()

◆ GetRouteFileContent()

◆ ExportRouteToStream()