File IEnumeration.h¶

File List > include > SpinGenApi > IEnumeration.h
//=============================================================================
// 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_IENUMERATION_H
#define SPINNAKER_GENAPI_IENUMERATION_H

//#include "GCStringVector.h"
#include "SpinnakerPlatform.h"
#include "IEnumEntry.h"
#include "Types.h"
#include "IValue.h"

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4251) // XXX needs to have dll-interface to be used by clients of class YYY
#endif

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

        interface SPINNAKER_API_ABSTRACT IEnumeration : virtual public IValue
        {
            virtual void GetSymbolics(StringList_t & Symbolics) = 0;

            virtual void GetEntries(NodeList_t & Entries) = 0;

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

            virtual void SetIntValue(int64_t Value, bool Verify = true) = 0;

            virtual GenICam::gcstring operator*() = 0;

            virtual int64_t GetIntValue(bool Verify = false, bool IgnoreCache = false) = 0;

            virtual IEnumEntry* GetEntryByName(const GenICam::gcstring& Symbolic) = 0;

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

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

    } // namespace GenApi
} // namespace Spinnaker

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif // ifndef SPINNAKER_GENAPI_IENUMERATION_H