Struct ASCIIParam

Namespace

VirtualLabAPI.Core.FieldRepresentations

Assembly

VirtualLabAPI.dll

Structure that contains parameters for ASCII Export.

public struct ASCIIParam

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ASCIIParam(string, FieldQuantity, bool)

Simplified constructor. The following default settings are used.

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

public ASCIIParam(string fileName, FieldQuantity fieldConversion, bool transposeField)

Parameters

fileName string

The file name including the complete path.

fieldConversion FieldQuantity

Adjusts which FieldQuantityto export to ASCII text. (Text is interpreted as stream of real numbers.)

transposeField bool

Transpose ComplexAmplitude before export.

ASCIIParam(string, FieldQuantity, bool, char, char, bool, bool, VectorialComponent)

Constructor initializing all parameters.

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

Parameters

fileName string

The file name including the complete path.

fieldConversion FieldQuantity

Adjusts which FieldQuantityto export to ASCII text. (Text is interpreted as stream of real numbers.)

transposeField bool

Transpose ComplexAmplitude before export.

decimalSeparator char

Decimal separator.

columnSeparator char

Separator for columns.

createHeader bool

Prepend header.

removeSphericalPhaseFactor bool

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 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.

Fields

ColumnSeparator

Separator for columns.

public char ColumnSeparator

Field Value

char

DecimalSeparator

Decimal separator.

public char DecimalSeparator

Field Value

char

FieldConversion

Adjusts which FieldQuantity to export to ASCII text. (Text is interpreted as stream of real numbers.)

public FieldQuantity FieldConversion

Field Value

FieldQuantity

FileName

The file name including the complete path.

public string FileName

Field Value

string

NumLinesHeader

Number of header lines (for import only).

public int NumLinesHeader

Field Value

int

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.

public bool RemoveSphericalPhaseFactor

Field Value

bool

SkipLinesStartingWith

If not null, this value passes a string that indicates a comment line that is to skip.

public string SkipLinesStartingWith

Field Value

string

TransposeField

Transpose ComplexAmplitude before export.

public bool TransposeField

Field Value

bool

UseHeader

Prepend header.

public bool UseHeader

Field Value

bool

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.

public VectorialComponent VectorialComponent

Field Value

VectorialComponent