BarcodeFormats.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <cstdint>
#include <type_traits>
 
namespace Zivid
{
    namespace Experimental
    {
        namespace Toolbox
        {
            enum class LinearBarcodeFormat : uint32_t
            {
                code128 = (1 << 0),
                code93 = (1 << 1),
                code39 = (1 << 2),
                ean13 = (1 << 3),
                ean8 = (1 << 4),
                upcA = (1 << 5),
                upcE = (1 << 6),
            };

            enum class MatrixBarcodeFormat : uint32_t
            {
                qrcode = (1 << 0),
                dataMatrix = (1 << 1),
            };

            template<typename FormatEnum>
            class BarcodeFormatFilter
            {
            public:
                using Enum = FormatEnum;
                using UnderlyingInt = std::underlying_type_t<FormatEnum>;

                static constexpr BarcodeFormatFilter all()
                {
                    return BarcodeFormatFilter{ ~UnderlyingInt{ 0 } };
                }

                constexpr bool has(FormatEnum enumVal) const
                {
                    return (m_value & static_cast<UnderlyingInt>(enumVal)) != 0;
                }
 
                constexpr BarcodeFormatFilter(FormatEnum enumVal)
                    : m_value{ static_cast<UnderlyingInt>(enumVal) }
                {}
 
                constexpr BarcodeFormatFilter operator|(FormatEnum other) const
                {
                    return BarcodeFormatFilter{ m_value | static_cast<UnderlyingInt>(other) };
                }
 
                constexpr BarcodeFormatFilter operator|(BarcodeFormatFilter other) const
                {
                    return BarcodeFormatFilter{ m_value | other.m_value };
                }
 
            private:
                constexpr BarcodeFormatFilter() = default;
 
                constexpr explicit BarcodeFormatFilter(UnderlyingInt value)
                    : m_value{ value }
                {}
 
                UnderlyingInt m_value{ 0 };
            };
 
            template<typename FormatEnum>
            constexpr BarcodeFormatFilter<FormatEnum> operator|(FormatEnum lhs, FormatEnum rhs)
            {
                return BarcodeFormatFilter<FormatEnum>{ lhs } | rhs;
            }
 
            template<typename FormatEnum>
            constexpr BarcodeFormatFilter<FormatEnum> operator|(FormatEnum lhs, BarcodeFormatFilter<FormatEnum> rhs)
            {
                return rhs | lhs;
            }

            using LinearBarcodeFormatFilter = BarcodeFormatFilter<LinearBarcodeFormat>;

            using MatrixBarcodeFormatFilter = BarcodeFormatFilter<MatrixBarcodeFormat>;
 
        } // namespace Toolbox
    } // namespace Experimental
} // namespace Zivid