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

Manages portrayal process and resources. More...

#include <portrayal_manager_interface.h>

Inherits ISDKComponent.

Public Member Functions

virtual SDKResult SDK_CALLTYPE GetPortrayalParameters (sdk::vis::IPortrayalParametersSP &portrayal_parameters) const =0 throw ()
 Returns the interface that manages the portrayal parameters.
 
virtual SDKResult SDK_CALLTYPE SetPortrayalParameters (const sdk::vis::IPortrayalParametersSP &portrayal_parameters)=0 throw ()
 Sets a new portrayal parameters.
 
virtual SDKResult SDK_CALLTYPE CreatePortrayalLayer (const SDKString &portrayal_layer_name, IPortrayalLayerSP &portrayal_layer)=0 throw ()
 Creates a new portrayal process pipeline.
 
virtual SDKResult SDK_CALLTYPE GetPortrayalLayer (const SDKString &portrayal_layer_name, IPortrayalLayerSP &portrayal_layer) const =0 throw ()
 Returns existing portrayal process pipeline.
 
virtual SDKResult SDK_CALLTYPE RemovePortrayalLayer (const SDKString &portrayal_layer_name)=0 throw ()
 Deletes specified portrayal process pipeline.
 
virtual SDKResult SDK_CALLTYPE EnumPossiblePortrayalNames (const sdk::gdb::PRSP &prsp, EnumSDKStringSP &portrayal_names) const =0 throw ()
 Returns all available portrayals for the data with specified PRSP.
 
virtual SDKResult SDK_CALLTYPE SetCurrentPortrayal (const sdk::gdb::PRSP &prsp, const SDKString &portrayal_name)=0 throw ()
 Sets current portrayal for the data with specified PRSP.
 
virtual SDKResult SDK_CALLTYPE GetCurrentPortrayal (const sdk::gdb::PRSP &prsp, SDKString &portrayal_name) const =0 throw ()
 Returns current portrayal for the data with specified PRSP.
 
virtual SDKResult SDK_CALLTYPE EnumAvailablePortrayals (IPortrayalsEnumeratorSP &portrayals) const =0 throw ()
 Returns enumerator of all known to the sdk portrayals.
 
virtual SDKResult SDK_CALLTYPE InstallPortrayal (const SDKString &portrayal_path, SDKString *installed_path)=0 throw ()
 Install new portrayal from the specified location.
 
virtual SDKResult SDK_CALLTYPE RemovePortrayal (const SDKString &portrayal_name, double version)=0 throw ()
 Removes installed portrayal.
 
virtual SDKResult SDK_CALLTYPE SetCurrentPortrayalVersion (const SDKString &portrayal_name, double version)=0 throw ()
 Sets current portrayal.
 
virtual SDKResult SDK_CALLTYPE GetPortrayalInfoFromPath (const SDKString &portrayal_path, SDKString &portrayal_name, double &version, ISDKPropertiesSP &portrayal_props) const =0 throw ()
 Reads and returned description of portrayal by path.
 
virtual SDKResult SDK_CALLTYPE RegisterUserSymbolSet (const SDKString &portrayal_name, const SDKString &symbolset_path)=0 throw ()
 Sets additional symbols set which is registered after main one.
 

Detailed Description

Manages portrayal process and resources.


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