Orientation.h

//  trax track library
//  AD 2015
//
//  "the resolution of all the fruitless searches"
//
//                              Peter Gabriel
//
// Copyright (c) 2025 Trend Redaktions- und Verlagsgesellschaft mbH
// Copyright (c) 2019 Marc-Michael Horstmann
//
// Permission is hereby granted to any person obtaining a copy of this software 
// and associated source code (the "Software"), to use, view, and study the 
// Software for personal or internal business purposes, subject to the following 
// conditions:
//
// 1. Redistribution, modification, sublicensing, or commercial use of the 
// Software is NOT permitted without prior written consent from the copyright 
// holder.
//
// 2. The Software is provided "AS IS", without warranty of any kind, express 
// or implied.
//
// 3. All copies of the Software must retain this license notice.
//
// For further information, please contact: horstmann.marc@trendverlag.de
 
#pragma once
 
#include "Configuration.h"
 
#include <ostream>
#include <string>
 
namespace trax{

    struct Orientation{

        enum class Value : char{
            none = -1,  
            anti = 0,   
            para = 1    
        };
 

        //{@
        Orientation() noexcept
            : m_Value{ Value::para }
        {}
 
        Orientation( Value value ) noexcept
            : m_Value{ value }
        {}
 
        explicit Orientation( bool bvalue ) noexcept
            : m_Value{ bvalue ? Value::para : Value::anti } 
        {}
 
        explicit Orientation( int ivalue ) noexcept
            : m_Value{ ivalue == 0 ? Value::anti : Value::para } 
        {}

 
        void Flip() noexcept{
            m_Value = m_Value == Value::para ? Value::anti : Value::para;
        }

        bool operator==( Value value ) const noexcept{
            return m_Value == value;
        }

        bool operator!=( Value value ) const noexcept{
            return m_Value != value;
        }

        Value operator!() const noexcept{
            return m_Value == Value::para ? Value::anti : Value::para;
        }
 
        operator bool() const noexcept{
            return m_Value == Value::para;
        }
 
        operator int() const noexcept{
            return m_Value == Value::para ? +1 : -1;
        }
 
    private:
        Value m_Value;
 
        friend bool operator==( const Orientation& a, const Orientation& b ) noexcept;
        friend bool operator!=( const Orientation& a, const Orientation& b ) noexcept;
        friend bool operator==( const Orientation::Value& a, const Orientation& b ) noexcept;
        friend bool operator!=( const Orientation::Value& a, const Orientation& b ) noexcept;
    };
 

    inline bool operator==( const Orientation& a, const Orientation& b ) noexcept;
 

    inline bool operator!=( const Orientation& a, const Orientation& b ) noexcept;
 

    inline bool operator==( const Orientation::Value& a, const Orientation& b ) noexcept;
 

    inline bool operator!=( const Orientation::Value& a, const Orientation& b ) noexcept;
 

    inline Orientation operator+( const Orientation& a, const Orientation& b ) noexcept;
 

    inline Orientation& operator+=( Orientation& a, const Orientation& b ) noexcept;
 
 
    dclspc std::string ToString( Orientation orient );
 
    dclspc Orientation ToOrientation( const std::string& orient );
 
 
//inlines:
    inline bool operator==( const Orientation& a, const Orientation& b ) noexcept{
        return a.m_Value == b.m_Value;
    }
 
    inline bool operator!=( const Orientation& a, const Orientation& b ) noexcept{
        return a.m_Value != b.m_Value;
    }
 
    inline bool operator==( const Orientation::Value& a, const Orientation& b ) noexcept{
        return a == b.m_Value;
    }
 
    inline bool operator!=( const Orientation::Value& a, const Orientation& b ) noexcept{
        return a != b.m_Value;
    }
 
    Orientation operator+( const Orientation& a, const Orientation& b ) noexcept{
        return a == b ? Orientation::Value::para : Orientation::Value::anti;
    }
 
    Orientation& operator+=( Orientation& a, const Orientation& b ) noexcept{
        a = a + b;
        return a;
    }
}