OpenIndy-Core  0.2.0.43
oi::ExchangeSimpleAscii Class Reference

The ExchangeSimpleAscii class Interface that shall be used for simple not standardized ascii files. The user of OpenIndy can select the meaning of each column of the file on his own. More...

#include <exchangesimpleascii.h>

Inheritance diagram for oi::ExchangeSimpleAscii:
oi::ExchangeInterface

Public Types

enum  ColumnType {
  eColumnIgnore, eColumnFeatureName, eColumnGroupName, eColumnComment,
  eColumnX, eColumnY, eColumnZ, eColumnPrimaryI,
  eColumnPrimaryJ, eColumnPrimaryK, eColumnSecondaryI, eColumnSecondaryJ,
  eColumnSecondaryK, eColumnRadiusA, eColumnRadiusB, eColumnAperture,
  eColumnA, eColumnB, eColumnC, eColumnAngle,
  eColumnDistance, eColumnMeasurementSeries, eColumnTemperature, eColumnLength
}
 

Public Member Functions

 ExchangeSimpleAscii (QObject *parent=0)
 ExchangeSimpleAscii::ExchangeSimpleAscii. More...
 
virtual ~ExchangeSimpleAscii ()
 ExchangeSimpleAscii::~ExchangeSimpleAscii. More...
 
virtual QList< ExchangeSimpleAscii::ColumnTypegetDefaultColumnOrder (const GeometryTypes &typeOfGeometry) const
 ExchangeSimpleAscii::getDefaultColumnOrder Returns an ordered list of columns that a file possibly contains (for a given geometry type) More...
 
virtual QMap< ExchangeSimpleAscii::ColumnType, QVariantList > getFilePreview (const GeometryTypes &typeOfGeometry) const
 ExchangeSimpleAscii::getFilePreview Returns a list of sample file entries for each column specified in getDefaultColumnOrder() More...
 
virtual QList< ExchangeSimpleAscii::ColumnTypegetPossibleColumns (const GeometryTypes &typeOfGeometry) const
 ExchangeSimpleAscii::getPossibleColumns Returns a list of possible columns for a given geometry type. More...
 
const QStringList & getSupportedDelimiters () const
 ExchangeSimpleAscii::getSupportedDelimiters. More...
 
const QList< ExchangeSimpleAscii::ColumnType > & getUserDefinedColumns () const
 ExchangeSimpleAscii::getUserDefinedColumns Get the meaning of each column. More...
 
void setUserDefinedColumns (const QList< ExchangeSimpleAscii::ColumnType > &userDefinedColumns)
 ExchangeSimpleAscii::setUserDefinedColumns Specify the meaning of each column. More...
 
const GeometryTypesgetTypeOfGeometry () const
 ExchangeSimpleAscii::getTypeOfGeometry Returns the type of geometry that shall be im- or exported. More...
 
void setGeometryType (const GeometryTypes &typeOfGeometry)
 ExchangeSimpleAscii::setGeometryType Specify which type of geometry shall be im- or exported. More...
 
const bool & getSkipFirstLine () const
 ExchangeSimpleAscii::getSkipFirstLine. More...
 
void setSkipFirstLine (const bool &skipFirstLine)
 ExchangeSimpleAscii::setSkipFirstLine Skip the first line in a file during import / do not write headers to file during export. More...
 
const QString & getUsedDelimiter () const
 ExchangeSimpleAscii::getUsedDelimiter. More...
 
void setDelimiter (const QString &usedDelimiter)
 ExchangeSimpleAscii::setDelimiter Set the delimiter that shall be used when parsing the file. More...
 
- Public Member Functions inherited from oi::ExchangeInterface
 ExchangeInterface (QObject *parent=0)
 ExchangeInterface::ExchangeInterface. More...
 
virtual ~ExchangeInterface ()
 ExchangeInterface::~ExchangeInterface. More...
 
virtual void init ()
 ExchangeInterface::init. More...
 
const PluginMetaDatagetMetaData () const
 ExchangeInterface::getMetaData. More...
 
const QList< GeometryTypes > & getSupportedGeometries ()
 ExchangeInterface::getSupportedGeometries. More...
 
const QPointer< QIODevice > & getDevice () const
 ExchangeInterface::getDevice. More...
 
void setDevice (const QPointer< QIODevice > &device)
 ExchangeInterface::setDevice. More...
 
const QList< QPointer< FeatureWrapper > > & getFeatures () const
 ExchangeInterface::getFeatures. More...
 
void setFeatures (const QList< QPointer< FeatureWrapper > > &features)
 ExchangeInterface::setFeatures. More...
 
const bool & getExportObservations () const
 ExchangeInterface::getExportObservations. More...
 
void setExportObservations (const bool &exportObservations)
 ExchangeInterface::setExportObservations. More...
 
const QString & getGroupName () const
 ExchangeInterface::getGroupName. More...
 
void setGroupName (const QString &groupName)
 ExchangeInterface::setGroupName. More...
 
const QPointer< CoordinateSystem > & getNominalSystem () const
 ExchangeInterface::getNominalSystem. More...
 
void setNominalSystem (const QPointer< CoordinateSystem > &nominalSystem)
 ExchangeInterface::setNominalSystem. More...
 
const QMap< DimensionType, UnitType > & getUnits () const
 ExchangeInterface::getUnits. More...
 
void setUnit (const DimensionType &dimension, const UnitType &unit)
 ExchangeInterface::setUnit. More...
 

Protected Attributes

QList< ExchangeSimpleAscii::ColumnTypeuserDefinedColumns
 
GeometryTypes typeOfGeometry
 
bool skipFirstLine
 
QString usedDelimiter
 
QStringList supportedDelimiters
 
- Protected Attributes inherited from oi::ExchangeInterface
QMap< DimensionType, UnitTypeunits
 
bool exportObservations
 
QString groupName
 
QPointer< CoordinateSystemnominalSystem
 
QPointer< QIODevice > device
 
QList< QPointer< FeatureWrapper > > features
 
PluginMetaData metaData
 
QList< GeometryTypessupportedGeometries
 

Additional Inherited Members

- Public Slots inherited from oi::ExchangeInterface
virtual void importOiData ()
 ExchangeInterface::importOiData. More...
 
virtual void exportOiData ()
 ExchangeInterface::exportOiData. More...
 
- Signals inherited from oi::ExchangeInterface
void sendMessage (const QString &msg, const MessageTypes &msgType, const MessageDestinations &msgDest=eConsoleMessage)
 
void updateProgress (const int &progress, const QString &msg)
 
void importFinished (const bool &success)
 
void exportFinished (const bool &success)
 

Detailed Description

The ExchangeSimpleAscii class Interface that shall be used for simple not standardized ascii files. The user of OpenIndy can select the meaning of each column of the file on his own.

Member Enumeration Documentation

Enumerator
eColumnIgnore 
eColumnFeatureName 
eColumnGroupName 
eColumnComment 
eColumnX 
eColumnY 
eColumnZ 
eColumnPrimaryI 
eColumnPrimaryJ 
eColumnPrimaryK 
eColumnSecondaryI 
eColumnSecondaryJ 
eColumnSecondaryK 
eColumnRadiusA 
eColumnRadiusB 
eColumnAperture 
eColumnA 
eColumnB 
eColumnC 
eColumnAngle 
eColumnDistance 
eColumnMeasurementSeries 
eColumnTemperature 
eColumnLength 

Constructor & Destructor Documentation

ExchangeSimpleAscii::ExchangeSimpleAscii ( QObject *  parent = 0)
explicit
ExchangeSimpleAscii::~ExchangeSimpleAscii ( )
virtual

Member Function Documentation

QList< ExchangeSimpleAscii::ColumnType > ExchangeSimpleAscii::getDefaultColumnOrder ( const GeometryTypes typeOfGeometry) const
virtual

ExchangeSimpleAscii::getDefaultColumnOrder Returns an ordered list of columns that a file possibly contains (for a given geometry type)

Parameters
typeOfGeometry
Returns
QMap< ExchangeSimpleAscii::ColumnType, QVariantList > ExchangeSimpleAscii::getFilePreview ( const GeometryTypes typeOfGeometry) const
virtual

ExchangeSimpleAscii::getFilePreview Returns a list of sample file entries for each column specified in getDefaultColumnOrder()

Parameters
typeOfGeometry
Returns
QList< ExchangeSimpleAscii::ColumnType > ExchangeSimpleAscii::getPossibleColumns ( const GeometryTypes typeOfGeometry) const
virtual

ExchangeSimpleAscii::getPossibleColumns Returns a list of possible columns for a given geometry type.

Parameters
typeOfGeometry
Returns
const bool & ExchangeSimpleAscii::getSkipFirstLine ( ) const
const QStringList & ExchangeSimpleAscii::getSupportedDelimiters ( ) const
const GeometryTypes & ExchangeSimpleAscii::getTypeOfGeometry ( ) const

ExchangeSimpleAscii::getTypeOfGeometry Returns the type of geometry that shall be im- or exported.

Returns
const QString & ExchangeSimpleAscii::getUsedDelimiter ( ) const
const QList< ExchangeSimpleAscii::ColumnType > & ExchangeSimpleAscii::getUserDefinedColumns ( ) const

ExchangeSimpleAscii::getUserDefinedColumns Get the meaning of each column.

Returns
void ExchangeSimpleAscii::setDelimiter ( const QString &  usedDelimiter)

ExchangeSimpleAscii::setDelimiter Set the delimiter that shall be used when parsing the file.

Parameters
usedDelimiter
void ExchangeSimpleAscii::setGeometryType ( const GeometryTypes typeOfGeometry)

ExchangeSimpleAscii::setGeometryType Specify which type of geometry shall be im- or exported.

Parameters
typeOfGeometry
void ExchangeSimpleAscii::setSkipFirstLine ( const bool &  skipFirstLine)

ExchangeSimpleAscii::setSkipFirstLine Skip the first line in a file during import / do not write headers to file during export.

Parameters
skipFirstLine
void ExchangeSimpleAscii::setUserDefinedColumns ( const QList< ExchangeSimpleAscii::ColumnType > &  userDefinedColumns)

ExchangeSimpleAscii::setUserDefinedColumns Specify the meaning of each column.

Parameters
userDefinedColumns

Member Data Documentation

bool oi::ExchangeSimpleAscii::skipFirstLine
protected
QStringList oi::ExchangeSimpleAscii::supportedDelimiters
protected
GeometryTypes oi::ExchangeSimpleAscii::typeOfGeometry
protected
QString oi::ExchangeSimpleAscii::usedDelimiter
protected
QList<ExchangeSimpleAscii::ColumnType> oi::ExchangeSimpleAscii::userDefinedColumns
protected

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