GenApi/IInteger.h#
Namespaces#
Name |
---|
GenApi Contains definitions of the types of GenICam GenApi modules. |
Classes#
Name | |
---|---|
struct | GenApi::IInteger Interface for integer properties. |
class | GenApi::CIntegerRefT |
Source code#
//-----------------------------------------------------------------------------
// (c) 2006 by Basler Vision Technologies
// Section: Vision Components
// Project: GenApi
// Author: Fritz Dierks
// $Header$
//
// License: This file is published under the license of the EMVA GenICam Standard Group.
// A text file describing the legal terms is included in your installation as 'GenICam_license.pdf'.
// If for some reason you are missing this file please contact the EMVA or visit the website
// (http://www.genicam.org) for a full copy.
//
// THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
// THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD GROUP
// 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.
//-----------------------------------------------------------------------------
#ifndef GENAPI_IIINTEGER_H
#define GENAPI_IIINTEGER_H
#include <Base/GCUtilities.h>
#include <GenApi/GenApiDll.h>
#include <GenApi/Types.h>
#include <GenApi/IValue.h>
#ifdef _MSC_VER
# pragma warning ( push )
# pragma warning ( disable : 4251 ) // XXX needs to have dll-interface to be used by clients of class YYY
#endif
namespace GENAPI_NAMESPACE
{
//*************************************************************
// IInteger interface
//*************************************************************
interface GENAPI_DECL_ABSTRACT IInteger : virtual public IValue
{
virtual void SetValue(int64_t Value, bool Verify = true) = 0;
virtual IInteger& operator=(int64_t Value) = 0;
virtual int64_t GetValue(bool Verify = false, bool IgnoreCache = false ) = 0;
virtual int64_t operator()() = 0;
virtual int64_t operator*() = 0;
virtual int64_t GetMin() = 0;
virtual int64_t GetMax() = 0;
virtual EIncMode GetIncMode() = 0;
virtual int64_t GetInc() = 0;
virtual int64_autovector_t GetListOfValidValues(bool bounded = true) = 0;
virtual ERepresentation GetRepresentation() = 0;
virtual GENICAM_NAMESPACE::gcstring GetUnit() = 0;
virtual void ImposeMin(int64_t Value) = 0;
virtual void ImposeMax(int64_t Value) = 0;
};
//*************************************************************
// CIntegerRef class
//*************************************************************
#ifndef DOXYGEN_IGNORE
interface IFloat;
template <class T, class I=T>
class CIntegerRefT : public CValueRefT<T, I>
{
typedef CValueRefT<T, I> ref;
public:
/*--------------------------------------------------------*/
// IInteger
/*--------------------------------------------------------*/
virtual void SetValue(int64_t Value, bool Verify = true)
{
if(ref::m_Ptr)
return ref::m_Ptr->SetValue(Value, Verify);
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual IInteger& operator=(int64_t Value)
{
if(ref::m_Ptr)
{
ref::m_Ptr->SetValue(Value);
return *this;
}
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t GetValue( bool Verify = false, bool IgnoreCache = false )
{
if(ref::m_Ptr)
return ref::m_Ptr->GetValue( Verify, IgnoreCache );
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t operator()()
{
if(ref::m_Ptr)
return ref::m_Ptr->operator()();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t operator*()
{
if(ref::m_Ptr)
return ref::m_Ptr->operator*();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t GetMin()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetMin();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t GetMax()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetMax();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual EIncMode GetIncMode()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetIncMode();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_t GetInc()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetInc();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual int64_autovector_t GetListOfValidValues(bool bounded = true)
{
if(ref::m_Ptr)
return ref::m_Ptr->GetListOfValidValues( bounded );
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual ERepresentation GetRepresentation()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetRepresentation();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual GENICAM_NAMESPACE::gcstring GetUnit()
{
if(ref::m_Ptr)
return ref::m_Ptr->GetUnit();
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
IFloat *GetFloatAlias()
{
if(ref::m_Ptr)
return dynamic_cast<IFloat*>(ref::m_Ptr->GetNode()->GetCastAlias());
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual void ImposeMin(int64_t Value)
{
if(ref::m_Ptr)
return ref::m_Ptr->ImposeMin(Value);
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
virtual void ImposeMax(int64_t Value)
{
if(ref::m_Ptr)
return ref::m_Ptr->ImposeMax(Value);
else
throw ACCESS_EXCEPTION("Feature not present (reference not valid)");
}
};
typedef CIntegerRefT<IInteger> CIntegerRef;
#endif
}
#ifdef _MSC_VER
# pragma warning ( pop )
#endif
#endif // ifndef GENAPI_IIINTEGER_H
Updated on 5 July 2022 at 15:30:01