Aimsun Next Scripting  24.0
Public Types | Public Member Functions | List of all members
Aimsun::GShape::ExporterConfiguration Class Reference

Public Types

enum class  NodesExportMode { eSimple , eComplex }
 
enum class  DriverType {
  eESRI , eGeoJSON , eGML , eGPKG ,
  eMapInfo
}
 
enum class  RegionToExport { eAll , eProblemNet , eExperiment , eSelection }
 

Public Member Functions

 ExporterConfiguration ()
 
void setFolder (const QString &folder)
 
const QString & getFolder () const
 
void setCS (const QString &CS)
 
const QString & getCS () const
 
void setNodesExportMode (NodesExportMode mode)
 
NodesExportMode getNodesExportMode () const
 
void setOutputDriver (DriverType driver)
 
DriverType getOutputDriver () const
 
void setNetworkState (GKObject *experiment)
 
void setRegionToExport (RegionToExport region, GKObject *container=nullptr)
 
RegionToExport getRegionToExport () const
 
void addCustomTypeColumns (GKType *type, const QVector< GKColumn * > &columns)
 
const QVector< GKColumn * > & getCustomTypeColumns (GKType *type) const
 

Member Enumeration Documentation

◆ DriverType

Enumerator
eESRI 
eGeoJSON 
eGML 
eGPKG 
eMapInfo 

◆ NodesExportMode

Enumerator
eSimple 
eComplex 

◆ RegionToExport

Enumerator
eAll 
eProblemNet 
eExperiment 
eSelection 

Constructor & Destructor Documentation

◆ ExporterConfiguration()

Aimsun::GShape::ExporterConfiguration::ExporterConfiguration ( )

Member Function Documentation

◆ addCustomTypeColumns()

void Aimsun::GShape::ExporterConfiguration::addCustomTypeColumns ( GKType type,
const QVector< GKColumn * > &  columns 
)

Add an object type and columns to export. Returns false if 'type' or any of the 'columns' is null.

◆ getCS()

const QString & Aimsun::GShape::ExporterConfiguration::getCS ( ) const

Get the Coordinate System to use during export.

◆ getCustomTypeColumns()

const QVector< GKColumn * > & Aimsun::GShape::ExporterConfiguration::getCustomTypeColumns ( GKType type) const

Get object's type columns listed to export if any.

◆ getFolder()

const QString & Aimsun::GShape::ExporterConfiguration::getFolder ( ) const

Get the folder path where data will be exported.

◆ getNodesExportMode()

NodesExportMode Aimsun::GShape::ExporterConfiguration::getNodesExportMode ( ) const

Get how the nodes will be exported.

◆ getOutputDriver()

DriverType Aimsun::GShape::ExporterConfiguration::getOutputDriver ( ) const

Get the output driver used to export.

◆ getRegionToExport()

RegionToExport Aimsun::GShape::ExporterConfiguration::getRegionToExport ( ) const

Get the region where the objects to export are selected.

◆ setCS()

void Aimsun::GShape::ExporterConfiguration::setCS ( const QString &  CS)

Set the Coordinate System to use during export.

◆ setFolder()

void Aimsun::GShape::ExporterConfiguration::setFolder ( const QString &  folder)

Set the folder path where data will be exported.

◆ setNetworkState()

void Aimsun::GShape::ExporterConfiguration::setNetworkState ( GKObject experiment)

Set the experiment to apply geometry configurations and attribute overrides from.

◆ setNodesExportMode()

void Aimsun::GShape::ExporterConfiguration::setNodesExportMode ( NodesExportMode  mode)

Set how the nodes will be exported. By default, NodesExportMode.eSimple.

◆ setOutputDriver()

void Aimsun::GShape::ExporterConfiguration::setOutputDriver ( DriverType  driver)

Set the output driver used to export. By default, DriverType.eESRI.

◆ setRegionToExport()

void Aimsun::GShape::ExporterConfiguration::setRegionToExport ( RegionToExport  region,
GKObject container = nullptr 
)

Set the region where to extract the objects to export. By default, RegionToExport.eAll. 'container' argument not need when RegionToExport.eAll used. This will override the objects to export set via 'setNetworkState(...)' but not the attribute overrides to apply.

© Aimsun SLU
Aimsun ®