iACsvConfig Struct Reference

Holds the configuration parameters for loading a specific csv file format. More...

#include <iACsvConfig.h>

Public Types
enum	MappedColumn {   NotMapped = -1 , StartX , StartY , StartZ ,   EndX , EndY , EndZ , CenterX ,   CenterY , CenterZ , Length , Diameter ,   Phi , Theta , DimensionX , DimensionY ,   DimensionZ , CurvedLength , MappedCount }

Public Member Functions
	iACsvConfig ()
bool	isValid (QString &errorMsg) const
bool	load (QSettings const &settings, const QString &formatName)
	Load a given configuration name.
void	save (QSettings &settings, const QString &formatName)
	Save this configuration under the given name in the given settings object.

Static Public Member Functions
static iACsvConfig const &	getFCPFiberFormat (QString const &fileName)
	whether to add class ID at the end. This setting is not stored, rather this is a use-case dependent setting
static iACsvConfig const &	getFCVoidFormat (QString const &fileName)
static QString	getFormatKey (QString const &formatName)
	Return base key for a given format.
static QStringList	getListFromRegistry ()
	Return list of all csv configs stored in registry, list is empty if no format definitions exist.

Public Attributes
bool	addAutoID
	whether to add an automatic ID column
bool	addClassID
	value to use as diameter for all objects
iAColMapT	columnMapping
	how to visualize the given objects
QString	columnSeparator
	string separating the columns in the csv
bool	computeAngles
bool	computeCenter
bool	computeLength
bool	computeStartEnd
	flags whether to compute additional columns
bool	computeTensors
bool	containsHeader
	whether the file contains a header
QStringList	currentHeaders
	current headers of the table
QString	curvedFiberFileName
	filename for curved fiber information, also not stored in registry
QString	decimalSeparator
	string separating the integer from the fractional part in the numbers
QString	encoding
	text encoding of the csv file
QString	fileName
	filename, not stored in registrys
double	fixedDiameterValue
	whether to insert a fixed diameter (given by fixedDiameterValue)
bool	isDiameterFixed
	offset to apply to all coordinates (start, end, center)
iAObjectType	objectType
	type of objects to be analyzed
double	offset [3]
	map a specific value (denoted by an ID from MappedColumn) to the number of the column where it's stored
QStringList	selectedHeaders
	names of the selected headers
size_t	skipLinesEnd
	how many lines to skip at start and end of the file
size_t	skipLinesStart
float	spacing
	volume spacing to be used, currently unused
QString	unit
	unit of measurement for the values given in the csv
iAObjectVisType	visType

Static Public Attributes
static const QString	FCPFiberFormat
static const int	FCPFormatStartSkipLines = 5
static const QString	FCVoidFormat

Detailed Description

Holds the configuration parameters for loading a specific csv file format.

Member Enumeration Documentation

MappedColumn

enum iACsvConfig::MappedColumn

Enumerator
NotMapped	"ID" for columns needed either in computation of other columns or later in FeatureScout
StartX
StartY
StartZ
EndX
EndY
EndZ
CenterX
CenterY
CenterZ
Length
Diameter
Phi
Theta
DimensionX
DimensionY
DimensionZ
CurvedLength
MappedCount

Constructor & Destructor Documentation

iACsvConfig()

iACsvConfig::iACsvConfig

(

)

Member Function Documentation

getFCPFiberFormat()

iACsvConfig const & iACsvConfig::getFCPFiberFormat ( QString const & fileName )

static

whether to add class ID at the end. This setting is not stored, rather this is a use-case dependent setting

getFCVoidFormat()

iACsvConfig const & iACsvConfig::getFCVoidFormat ( QString const & fileName )

static

getFormatKey()

QString iACsvConfig::getFormatKey ( QString const & formatName )

static

Return base key for a given format.

getListFromRegistry()

QStringList iACsvConfig::getListFromRegistry ( )

static

Return list of all csv configs stored in registry, list is empty if no format definitions exist.

isValid()

bool iACsvConfig::isValid

(

QString &

errorMsg

)

const

load()

bool iACsvConfig::load	(	QSettings const &	settings,
		const QString &	formatName )

Load a given configuration name.

save()

void iACsvConfig::save	(	QSettings &	settings,
		const QString &	formatName )

Save this configuration under the given name in the given settings object.

Member Data Documentation

addAutoID

bool iACsvConfig::addAutoID

whether to add an automatic ID column

addClassID

bool iACsvConfig::addClassID

value to use as diameter for all objects

columnMapping

iAColMapT iACsvConfig::columnMapping

how to visualize the given objects

columnSeparator

QString iACsvConfig::columnSeparator

string separating the columns in the csv

computeAngles

bool iACsvConfig::computeAngles

computeCenter

bool iACsvConfig::computeCenter

computeLength

bool iACsvConfig::computeLength

computeStartEnd

bool iACsvConfig::computeStartEnd

flags whether to compute additional columns

computeTensors

bool iACsvConfig::computeTensors

containsHeader

bool iACsvConfig::containsHeader

whether the file contains a header

currentHeaders

QStringList iACsvConfig::currentHeaders

current headers of the table

curvedFiberFileName

QString iACsvConfig::curvedFiberFileName

filename for curved fiber information, also not stored in registry

decimalSeparator

QString iACsvConfig::decimalSeparator

string separating the integer from the fractional part in the numbers

encoding

QString iACsvConfig::encoding

text encoding of the csv file

FCPFiberFormat

const QString iACsvConfig::FCPFiberFormat

static

FCPFormatStartSkipLines

const int iACsvConfig::FCPFormatStartSkipLines = 5

static

FCVoidFormat

const QString iACsvConfig::FCVoidFormat

static

fileName

QString iACsvConfig::fileName

filename, not stored in registrys

fixedDiameterValue

double iACsvConfig::fixedDiameterValue

whether to insert a fixed diameter (given by fixedDiameterValue)

isDiameterFixed

bool iACsvConfig::isDiameterFixed

offset to apply to all coordinates (start, end, center)

objectType

iAObjectType iACsvConfig::objectType

type of objects to be analyzed

offset

double iACsvConfig::offset[3]

map a specific value (denoted by an ID from MappedColumn) to the number of the column where it's stored

selectedHeaders

QStringList iACsvConfig::selectedHeaders

names of the selected headers

skipLinesEnd

size_t iACsvConfig::skipLinesEnd

how many lines to skip at start and end of the file

skipLinesStart

size_t iACsvConfig::skipLinesStart

spacing

float iACsvConfig::spacing

volume spacing to be used, currently unused

unit

QString iACsvConfig::unit

unit of measurement for the values given in the csv

visType

iAObjectVisType iACsvConfig::visType

---

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

• libs/objectvis/iACsvConfig.h
• libs/objectvis/iACsvConfig.cpp