Skip to content

File IEnumerationT.h

File List > include > SpinGenApi > IEnumerationT.h

Go to the documentation of this file

//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef SPINNAKER_GENAPI_IENUMERATIONT_H
#define SPINNAKER_GENAPI_IENUMERATIONT_H

#include "SpinnakerPlatform.h"
#include "Types.h"
#include "Pointer.h"
#include "IEnumeration.h"
#include <vector>
//#include "GenApi/Compatibility.h"

namespace Spinnaker
{
    namespace GenApi
    {
        //*************************************************************
        // Enumeration template interface
        //*************************************************************

        template <typename EnumT>
        interface SPINNAKER_API_ABSTRACT IEnumerationT : virtual public IEnumeration, virtual public IEnumReference
        {
            virtual void SetValue(EnumT Value, bool Verify = true) = 0;

            virtual IEnumeration& operator=(EnumT Value) = 0;

            virtual EnumT GetValue(bool Verify = false, bool IgnoreCache = false) = 0;

            virtual EnumT operator()() = 0;

            virtual IEnumeration& operator=(const GenICam::gcstring& ValueStr) = 0;

            virtual IEnumEntry* GetEntry(const int64_t IntValue) = 0;

            virtual IEnumEntry* GetEntry(const EnumT Value) = 0;

            virtual IEnumEntry* GetCurrentEntry(bool Verify = false, bool IgnoreCache = false) = 0;
        };

    } // namespace GenApi
} // namespace Spinnaker

#endif // ifndef SPINNAKER_GENAPI_IENUMERATIONT_H