Itasca C++ Interface
Loading...
Searching...
No Matches
Public Member Functions | List of all members
itasca::IGeomImportExport Class Referenceabstract

Public Member Functions

virtual bool importFile (const string &filename, IGeometryImportData *ig)=0
 Import-export geometric set.
 
virtual bool exportStart (const string &filename, uint64 total, string comment="")=0
 
virtual void exportPoint (const DVect3 &p, uint64 pid=0)=0
 
virtual void exportLine (const DVect3 &p1, const DVect3 &p2, uint64 pid1=0, uint64 pid2=0, uint64 eid=0)=0
 
virtual void exportPolygon (const FArray< DVect3 > &ps, const FArray< uint64 > *pids=0, const FArray< uint64 > *eids=0, uint64 polyid=0)=0
 
virtual bool exportNodesNeeded ()
 
virtual bool exportEdgesNeeded ()
 
virtual void setGroups (const FArray< IGroupID > &groups)=0
 
virtual void setExtras (const FArray< std::pair< uint32, string > > &)
 
virtual void setDefaultLayerName (const string &name)=0
 Sets default name for metadata layer.
 
virtual void setExportBinary (bool binary)=0
 Sets export format to be binary (if binary not supported – it has no effect)
 
virtual bool exportEnd (void)=0
 Finish export.
 
virtual StringList getSupportedFileFormatExtensions ()=0
 Returns list of supported file format extensions for export-import.
 
virtual bool fileFormatSupported (const string &filename)=0
 
virtual string getPluginName ()=0
 get plugin name needed for plugin list container
 
virtual string getFormatKeyword () const =0
 
virtual IGeomImportExportclone ()=0
 
virtual void destroy ()=0
 
virtual void setTerminal (bool)
 

Member Function Documentation

◆ exportEdgesNeeded()

virtual bool itasca::IGeomImportExport::exportEdgesNeeded ( )
inlinevirtual

The method tells if edges(lines) are required first for export, before exporting polygons Default is "not required", reimplent to return "true" if edges are needed in output before output of the polygons

◆ exportLine()

virtual void itasca::IGeomImportExport::exportLine ( const DVect3 & p1,
const DVect3 & p2,
uint64 pid1 = 0,
uint64 pid2 = 0,
uint64 eid = 0 )
pure virtual

Export line pid's are unique id's for exporting points, eid is id unique id for exporting line (edge). If exporter Format does not need it it may be ignored, if exporter format will need the exact info on topology of othe objects, it might be refering to those id's The id's might be renumbered by exporter format. Zero value for id means no id.

◆ exportNodesNeeded()

virtual bool itasca::IGeomImportExport::exportNodesNeeded ( )
inlinevirtual

The method tells if nodes(points) are required first for export, before exporting polygons (or edges) Default is "not required", reimplent to return "true" if nodes are needed in output before output of the polygons( or edges)

◆ exportPoint()

virtual void itasca::IGeomImportExport::exportPoint ( const DVect3 & p,
uint64 pid = 0 )
pure virtual

Export point pid is unique id for exporting point, if exporter Format does not need it it may be ignored, if exporter format will need the exact info on topology of othe objects, it might be refering to that id The id's might be renumbered by exporter format.

◆ exportPolygon()

virtual void itasca::IGeomImportExport::exportPolygon ( const FArray< DVect3 > & ps,
const FArray< uint64 > * pids = 0,
const FArray< uint64 > * eids = 0,
uint64 polyid = 0 )
pure virtual

Export polygon defined by points pid's are unique id's for exporting points that a part of polygons, eids are id's for exporting lines (edges) that apart of the polygon. id – unique polygon id. If exporter Format does not need id, it it may be ignored, if exporter format will need the exact info on topology of othe objects, it might be refering to those id's The id's might be renumbered by exporter format. Zero value for id means no id.

◆ exportStart()

virtual bool itasca::IGeomImportExport::exportStart ( const string & filename,
uint64 total,
string comment = "" )
pure virtual

Start export total – number of total export entities (polygons, lines or points) for progress report

◆ fileFormatSupported()

virtual bool itasca::IGeomImportExport::fileFormatSupported ( const string & filename)
pure virtual

Checks if the file format is supported. default implementation compares file format extensions, reimplement it if refine check needed.

◆ importFile()

virtual bool itasca::IGeomImportExport::importFile ( const string & filename,
IGeometryImportData * ig )
pure virtual

Import-export geometric set.

Import geometry

◆ setExtras()

virtual void itasca::IGeomImportExport::setExtras ( const FArray< std::pair< uint32, string > > & )
inlinevirtual

set Extra variable (Extra IFishParam's) to following exported item (reimplement if export format allows to use it, default implementation does nothing)

◆ setGroups()

virtual void itasca::IGeomImportExport::setGroups ( const FArray< IGroupID > & groups)
pure virtual

Add the metadata (layer, group name, etc..) to all following export entities call this method each time you need to reset metadata for export.

◆ setTerminal()

virtual void itasca::IGeomImportExport::setTerminal ( bool )
inlinevirtual

Set terminal text output to global (if true) terminal term, otherwise null terminal. By default implementation does nothing. Reimplement if default implementation uses null terminal, (no terminal)


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