ASCIIParam Struct Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Structure that contains parameters for ASCII Export. More...

Public Member Functions
	ASCIIParam (string fileName, FieldQuantity fieldConversion, bool transposeField)
	Simplified constructor. The following default settings are used.
	ASCIIParam (string fileName, FieldQuantity fieldConversion, bool transposeField, char decimalSeparator, char columnSeparator, bool createHeader, bool removeSphericalPhaseFactor, VectorialComponent vectorialComponent)
	Constructor initializing all parameters.

Public Attributes
char	ColumnSeparator
	Separator for columns.
char	DecimalSeparator
	Decimal separator.
FieldQuantity	FieldConversion
	Adjust which FieldQuantity to consider in ASCII text. (Text is interpreted as stream of real numbers.)
string	FileName
	Filename.
int	NumLinesHeader
	Number of header lines (for import only).
bool	RemoveSphericalPhaseFactor
	If true the spherical phase factor is removed from the sampling points before export but the spherical phase radius will be still present in the header. This setting is just used for export.
string	SkipLinesStartingWith
	If not null, this value passes a string that indicates a comment line that is to skip.
bool	TransposeField
	Transpose ComplexAmplitude before export.
bool	UseHeader
	Prepend header.
VectorialComponent	VectorialComponent
	For locally polarized Complex Amplitudes this member allows the selection of the vectorial component to export. The member has only effect for locally polarized fields. For export only.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Structure that contains parameters for ASCII Export.

Constructor & Destructor Documentation

ASCIIParam() [1/2]

ASCIIParam	(	string	fileName,
		FieldQuantity	fieldConversion,
		bool	transposeField,
		char	decimalSeparator,
		char	columnSeparator,
		bool	createHeader,
		bool	removeSphericalPhaseFactor,
		VectorialComponent	vectorialComponent
	)

Constructor initializing all parameters.

Parameters

fileName	Filename.
fieldConversion	Adjust which FieldQuantity to consider in ASCII text. (Text is interpreted as stream of real numbers.)
transposeField	Transpose ComplexAmplitude before export.
columnSeparator	Separator for columns.
createHeader	Prepend header.
decimalSeparator	Decimal separartor.
removeSphericalPhaseFactor	If true the spherical phase factor is removed from the sampling points before export but the spherical phase radius will be still present in the header. This setting is just used for export.
vectorialComponent	For locally polarized Complex Amplitudes this member allows the selection of the vectorial component to export. The member has only effect for locally polarized fields. For export only.

ASCIIParam() [2/2]

ASCIIParam	(	string	fileName,
		FieldQuantity	fieldConversion,
		bool	transposeField
	)

Simplified constructor. The following default settings are used.

• DecimalSeparator: '.'
• ColumnSeparator: Tabulator
• NumLinesHeader: 0
• SkipLinesStartingWith: null
• RemoveSphericalPhaseFactor: false
• VectorialComponent: VectorialComponent.Ex

Parameters

fileName	The file name. true
fieldConversion	Adjust which FieldQuantity to consider in ASCII text. (Text is interpreted as stream of real numbers.)
transposeField	Transpose ComplexAmplitude before export.