FileFormat.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: Base
File: FileFormat
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/File.h>
#include <NDEVR/UUID.h>
namespace NDEVR
{
    /**----------------------------------------------------------------------------
    \brief Data that describes a particular file format and how to use the format
        with the program. Used especially with IOFactory
 
    ----------------------------------------------------------------------------*/
    class FileFormat
    {
    public:
        FileFormat(const UUID& id)
            : file_format_id(id)
        {}
        
        TranslatedString name;
        TranslatedString description;
        UUID file_format_id;
        String extension;
        String icon;
        bool read_supported = false;
        bool write_supported = false;
        bool is_ascii = false;
        bool operator==(const FileFormat& format) const
        {
            return file_format_id == format.file_format_id;
        }
        bool operator!=(const FileFormat& format) const
        {
            return file_format_id != format.file_format_id;
        }
        static FileFormat InvalidFormat()
        {
            return FileFormat(Constant<UUID>::Invalid);
        }
    };
    /**----------------------------------------------------------------------------
    \brief A FileRequest bundles format data as well as a particular file.
 
    ----------------------------------------------------------------------------*/
    struct FileRequest
    {
        FileRequest()
            : format(FileFormat::InvalidFormat())
        {}
        FileRequest(const File& file, const FileFormat& format)
            : file(file)
            , format(format)
        {}
        bool operator==(const FileRequest& request) const
        {
            return file == request.file && format == request.format;
        }
        bool operator!=(const FileRequest& request) const
        {
            return file != request.file || format != request.format;
        }
        File file;
        FileFormat format;
    };
    
}