AsciiOptions.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: IOFactory
File: AsciiOptions
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/DesignParameter.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/TypeInfo.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Storage class for all IO options related to an Ascii file output used by an IOFactory services
        that write to Ascii.
    **/
    class AsciiOptions
    {
    public:
        AsciiOptions()
        {}
        Buffer<DesignParameter, uint04, ObjectAllocator<false>> parameters;
        Buffer<TypeInfo> parameter_types;
        uint04 start_line = 0;
        uint04 end_line = Constant<uint04>::Max;
        uint04 max_decimals = 8;
        uint04 min_decimals = 0;
        char delimiter = '  ';
        bool write_headers = false;
        bool ignore_white_space = true;
        bool remove_delimiters_from_data = false;
        bool operator==(const AsciiOptions& options) const
        {
            return ignore_white_space == options.ignore_white_space
                && delimiter == options.delimiter
                && start_line == options.start_line
                && end_line == options.end_line
                && parameter_types == options.parameter_types
                && parameters == options.parameters
                && max_decimals == options.max_decimals
                && write_headers == options.write_headers
                && min_decimals == options.min_decimals
                && remove_delimiters_from_data == options.remove_delimiters_from_data;
        }
        bool operator!=(const AsciiOptions& options) const
        {
            return ignore_white_space != options.ignore_white_space
                || delimiter != options.delimiter
                || start_line != options.start_line
                || end_line != options.end_line
                || parameter_types != options.parameter_types
                || parameters != options.parameters
                || max_decimals != options.max_decimals
                || write_headers != options.write_headers
                || remove_delimiters_from_data != options.remove_delimiters_from_data;
        }
    };
}