NDEVR
API Documentation
AsciiOptions
Hardware and IO » IO Factories

Storage class for all IO options related to an Ascii file output used by an IOFactory services that write to Ascii. More...

Collaboration diagram for AsciiOptions:
[legend]

Public Member Functions

 AsciiOptions ()
 Default constructor.
bool operator!= (const AsciiOptions &options) const
 Checks inequality between this AsciiOptions and another.
bool operator== (const AsciiOptions &options) const
 Checks equality between this AsciiOptions and another.

Public Attributes

char delimiter = ' '
 The column delimiter character. Defaults to tab.
uint04 end_line = Constant<uint04>::Max
 The last line to read (inclusive). Defaults to max uint04 (read all).
bool ignore_white_space = true
 Whether to trim leading and trailing whitespace from parsed values.
uint04 max_decimals = 8
 Maximum number of decimal places when writing floating-point values.
uint04 min_decimals = 0
 Minimum number of decimal places when writing floating-point values.
Buffer< TypeInfo > parameter_types
 The type information corresponding to each entry in parameters.
Buffer< DesignParameter > parameters
 The ordered list of design parameters to read or write per line.
bool remove_delimiters_from_data = false
 Whether to strip delimiter characters found within data fields.
uint04 start_line = 0
 The first line to read from (0-based). Defaults to 0.
bool write_headers = false
 Whether to write a header row containing parameter names.

Detailed Description

Storage class for all IO options related to an Ascii file output used by an IOFactory services that write to Ascii.

Definition at line 43 of file AsciiOptions.h.

Constructor & Destructor Documentation

◆ AsciiOptions()

AsciiOptions::AsciiOptions ( )
inline

Default constructor.

Initializes all options to their default values.

Definition at line 47 of file AsciiOptions.h.

Referenced by operator!=(), and operator==().

Member Function Documentation

◆ operator!=()

bool AsciiOptions::operator!= ( const AsciiOptions & options) const
inline

Checks inequality between this AsciiOptions and another.

Note
BUG: This operator is missing the min_decimals comparison, unlike operator==.
Parameters
[in]optionsThe AsciiOptions to compare against.
Returns
True if any option field differs, false otherwise.

Definition at line 79 of file AsciiOptions.h.

References AsciiOptions(), delimiter, end_line, ignore_white_space, max_decimals, min_decimals, parameter_types, parameters, remove_delimiters_from_data, start_line, and write_headers.

◆ operator==()

bool AsciiOptions::operator== ( const AsciiOptions & options) const
inline

Checks equality between this AsciiOptions and another.

Parameters
[in]optionsThe AsciiOptions to compare against.
Returns
True if all option fields are equal, false otherwise.

Definition at line 62 of file AsciiOptions.h.

References AsciiOptions(), delimiter, end_line, ignore_white_space, max_decimals, min_decimals, parameter_types, parameters, remove_delimiters_from_data, start_line, and write_headers.

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