Skip to content

File EnumNodeT.h

File List > include > SpinGenApi > EnumNodeT.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_ENUMNODET_H
#define SPINNAKER_GENAPI_ENUMNODET_H

#include "SpinnakerPlatform.h"
#include "GCString.h"
#include "INode.h"
#include "EnumNode.h"
#include "IEnumeration.h"
#include "IEnumerationT.h"
#include "IEnumEntry.h"
#include "Node.h"

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4250) // C4250 - 'class1' : inherits 'class2::member' via dominance
#pragma warning(disable : 4251) // XXX needs to have dll-interface to be used by clients of class YYY
#pragma warning(disable : 4275) // non dll-interface structXXX used as base
#endif

namespace Spinnaker
{
    namespace GenApi
    {
        template <class EnumT>
        class SPINNAKER_API CEnumerationTRef : virtual public IEnumerationT<EnumT>, public virtual EnumNode
        {
          public:
            struct NodeImpl;
            CEnumerationTRef();

            CEnumerationTRef(std::shared_ptr<Node::NodeImpl> pEnumeration);

            virtual ~CEnumerationTRef();

            virtual void SetValue(EnumT Value, bool Verify = true);

            virtual IEnumeration& operator=(EnumT Value);

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

            virtual EnumT operator()();

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

            virtual IEnumEntry* GetEntry(const EnumT Value);

            virtual IEnumEntry* GetEntry(const int64_t IntValue);

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

            virtual void SetReference(INode* pBase);

            virtual void SetEnumReference(int Index, GenICam::gcstring Name);

            virtual void SetNumEnums(int NumEnums);

          private:
            std::shared_ptr<Node::NodeImpl> m_pEnumerationT;
        };

    } // namespace GenApi
} // namespace Spinnaker

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif // SPINNAKER_GENAPI_ENUMNODET_H