portrayal_manager_interface.h

Go to the documentation of this file.

 
#ifndef SDK_VISMAN_PORTRAYAL_MANAGER_INTERFACE_H_
#define SDK_VISMAN_PORTRAYAL_MANAGER_INTERFACE_H_
 
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/interfaces/properties/properties_interface.h>
 
#include <datalayer/inc/geodatabase/gdb_const.h>
 
#include "data_source_view_interface.h"
 
namespace sdk {
namespace vis {
FWD_DECL_INTERFACE(IPortrayalManager);
FWD_DECL_INTERFACE(IPortrayalParameters);
FWD_DECL_INTERFACE(IPortrayalsEnumerator);
FWD_DECL_INTERFACE(IPortrayalLayer);
 
enum PortrayalProperties
{
  kPortrayalProperty_IsDefault,            
  kPortrayalProperty_RootPath,             
  kPortrayalProperty_SymbolSetCatalogPath, 
  kPortrayalProperty_FunctionSetRootPath,  
};
 
static const wchar_t* kMainChartPortrayalLayerName = L"main-chart";
 
class IPortrayalManager : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetPortrayalParameters(
    sdk::vis::IPortrayalParametersSP& portrayal_parameters) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetPortrayalParameters(
    const sdk::vis::IPortrayalParametersSP& portrayal_parameters) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE CreatePortrayalLayer(
    const SDKString& portrayal_layer_name, IPortrayalLayerSP& portrayal_layer) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPortrayalLayer(
    const SDKString& portrayal_layer_name, IPortrayalLayerSP& portrayal_layer) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemovePortrayalLayer(
    const SDKString& portrayal_layer_name) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE EnumPossiblePortrayalNames(const sdk::gdb::PRSP& prsp, 
    EnumSDKStringSP& portrayal_names) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE SetCurrentPortrayal(const sdk::gdb::PRSP& prsp, 
    const SDKString& portrayal_name) throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetCurrentPortrayal(const sdk::gdb::PRSP& prsp, 
    SDKString& portrayal_name) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE EnumAvailablePortrayals(
    IPortrayalsEnumeratorSP& portrayals) const throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE InstallPortrayal(const SDKString& portrayal_path, 
    SDKString* installed_path) throw() = 0;
  virtual SDKResult SDK_CALLTYPE RemovePortrayal(const SDKString& portrayal_name, 
    double version) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE SetCurrentPortrayalVersion(const SDKString& portrayal_name, 
    double version) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE GetPortrayalInfoFromPath(const SDKString& portrayal_path, 
    SDKString& portrayal_name, double& version, ISDKPropertiesSP& portrayal_props) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE RegisterUserSymbolSet(
    const SDKString& portrayal_name, const SDKString& symbolset_path) throw() = 0;
    
  SDK_IMPLEMENT_IID(IPortrayalManager)
  SDK_END_INTERFACE(IPortrayalManager)
};
SDK_DECLARE_IID(IPortrayalManager)
 
enum PortrayalLayerProperties
{
  kPortrayalLayerProperty_ThreadIndex,            
  kPortrayalLayerProperty_IgnoreLUTDisplayScales, 
};
 
class IPortrayalLayer : public ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE AddDataSourceView(
    const DataSourceViewID& id) throw() = 0;
  
  virtual SDKResult SDK_CALLTYPE DeleteDataSourceView(
    const DataSourceViewID& id) throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE Clear() throw() = 0;
 
  // ISDKProperties
  //virtual SDKResult SDK_CALLTYPE SetProperty(const SDKPropertyID& id, 
  //  const SDKAny& value) throw() = 0;
  //virtual SDKResult SDK_CALLTYPE GetProperty(const SDKPropertyID& id, 
  //  SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IPortrayalLayer)
  SDK_END_INTERFACE(IPortrayalLayer)
};
SDK_DECLARE_IID(IPortrayalLayer)
 
class IPortrayalsEnumerator : public ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Next(SDKString& name, double& version, 
    ISDKPropertiesSP& portrayal_props) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
 
  SDK_IMPLEMENT_IID(IPortrayalsEnumerator)
  SDK_END_INTERFACE(IPortrayalsEnumerator)
};
SDK_DECLARE_IID(IPortrayalsEnumerator)
 
} // namespace vis
} // namespace sdk
 
#endif // SDK_VISMAN_PORTRAYAL_MANAGER_INTERFACE_H_