A reference to a float which can be either a double variable, or a pointer to an IFloat, IInteger, or an IEnumeration interface. More...

#include <PolyReference.h>

Public Types
enum	_EType { typeUninitialized, typeValue, typeIFloat, typeIInteger, typeIEnumeration }
	possible types of the internally held pointer More...

typedef enum GENAPI_NAMESPACE::CFloatPolyRef::_EType	EType
	possible types of the internally held pointer More...

Public Member Functions
	CFloatPolyRef ()
	Constructor. More...

ECachingMode	GetCachingMode () const

EDisplayNotation	GetDisplayNotation () const
	see IFloat More...

int64_t	GetDisplayPrecision () const
	see IFloat More...

virtual double	GetInc ()
	Get the constant increment if there is any. More...

double	GetInc () const
	extension required for swiss knifes More...

double	GetMax () const
	see IFloat interface More...

double	GetMin () const
	see IFloat interface More...

INodePrivate *	GetPointer () const
	returns the pointer referenced More...

ERepresentation	GetRepresentation () const
	see IFloat interface More...

GENICAM_NAMESPACE::gcstring	GetUnit () const
	see IFloat interface More...

double	GetValue (bool Verify=false, bool IgnoreCache=false) const
	see IFloat interface More...

bool	HasInc ()
	True if the float has a constant increment. More...

bool	IsInitialized () const
	True if the object is initialized. More...

bool	IsPointer () const
	True if the object references a pointer. More...

bool	IsValue () const
	True if the object references a pointer. More...

	operator INode * (void) const
	cast to INode (may be zero) More...

CFloatPolyRef &	operator= (double Value)
	set integer value More...

CFloatPolyRef &	operator= (IBase *pValue)
	set pointer More...

CFloatPolyRef &	operator= (INode *pValue)
	set pointer More...

void	SetValue (double Value, bool Verify=true)
	see IFloat interface More...

Protected Attributes
EType	m_Type
	the type of the internally held pointer More...

union {
IEnumeration * pEnumeration
	Integer node More...

IFloat * pFloat
	fixed value More...

IInteger * pInteger
	Float node More...

double Value

}	m_Value
	the place to store the value or the pointers to the nodes to get the value from More...

Detailed Description

A reference to a float which can be either a double variable, or a pointer to an IFloat, IInteger, or an IEnumeration interface.

Definition at line 633 of file PolyReference.h.

Member Typedef Documentation

◆ EType

typedef enum GENAPI_NAMESPACE::CFloatPolyRef::_EType GENAPI_NAMESPACE::CFloatPolyRef::EType

possible types of the internally held pointer

Member Enumeration Documentation

◆ _EType

enum GENAPI_NAMESPACE::CFloatPolyRef::_EType

possible types of the internally held pointer

Enumerator
typeUninitialized
typeValue
typeIFloat
typeIInteger
typeIEnumeration

Definition at line 1018 of file PolyReference.h.

Constructor & Destructor Documentation

◆ CFloatPolyRef()

GENAPI_NAMESPACE::CFloatPolyRef::CFloatPolyRef ( )

inline

Constructor.

Definition at line 637 of file PolyReference.h.

Member Function Documentation

◆ GetCachingMode()

ECachingMode GENAPI_NAMESPACE::CFloatPolyRef::GetCachingMode ( ) const

inline

Definition at line 1027 of file PolyReference.h.

◆ GetDisplayNotation()

EDisplayNotation GENAPI_NAMESPACE::CFloatPolyRef::GetDisplayNotation ( ) const

inline

see IFloat

Definition at line 980 of file PolyReference.h.

◆ GetDisplayPrecision()

int64_t GENAPI_NAMESPACE::CFloatPolyRef::GetDisplayPrecision ( ) const

inline

see IFloat

Definition at line 999 of file PolyReference.h.

◆ GetInc() [1/2]

virtual double GENAPI_NAMESPACE::CFloatPolyRef::GetInc ( )

inlinevirtual

Get the constant increment if there is any.

Definition at line 876 of file PolyReference.h.

◆ GetInc() [2/2]

double GENAPI_NAMESPACE::CFloatPolyRef::GetInc ( ) const

inline

extension required for swiss knifes

Definition at line 896 of file PolyReference.h.

◆ GetMax()

double GENAPI_NAMESPACE::CFloatPolyRef::GetMax ( ) const

inline

see IFloat interface

Definition at line 837 of file PolyReference.h.

◆ GetMin()

double GENAPI_NAMESPACE::CFloatPolyRef::GetMin ( ) const

inline

see IFloat interface

Definition at line 817 of file PolyReference.h.

◆ GetPointer()

INodePrivate* GENAPI_NAMESPACE::CFloatPolyRef::GetPointer ( ) const

inline

returns the pointer referenced

Definition at line 700 of file PolyReference.h.

◆ GetRepresentation()

ERepresentation GENAPI_NAMESPACE::CFloatPolyRef::GetRepresentation ( ) const

inline

see IFloat interface

Definition at line 916 of file PolyReference.h.

◆ GetUnit()

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFloatPolyRef::GetUnit ( ) const

inline

see IFloat interface

Definition at line 936 of file PolyReference.h.

◆ GetValue()

double GENAPI_NAMESPACE::CFloatPolyRef::GetValue	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)		const

inline

see IFloat interface

Definition at line 728 of file PolyReference.h.

◆ HasInc()

bool GENAPI_NAMESPACE::CFloatPolyRef::HasInc ( )

inline

True if the float has a constant increment.

Definition at line 857 of file PolyReference.h.

◆ IsInitialized()

bool GENAPI_NAMESPACE::CFloatPolyRef::IsInitialized ( ) const

inline

True if the object is initialized.

Definition at line 694 of file PolyReference.h.

◆ IsPointer()

bool GENAPI_NAMESPACE::CFloatPolyRef::IsPointer ( ) const

inline

True if the object references a pointer.

Definition at line 688 of file PolyReference.h.

◆ IsValue()

bool GENAPI_NAMESPACE::CFloatPolyRef::IsValue ( ) const

inline

True if the object references a pointer.

Definition at line 682 of file PolyReference.h.

◆ operator INode *()

GENAPI_NAMESPACE::CFloatPolyRef::operator INode * ( void ) const

inline

cast to INode (may be zero)

Definition at line 722 of file PolyReference.h.

◆ operator=() [1/3]

CFloatPolyRef& GENAPI_NAMESPACE::CFloatPolyRef::operator= ( double Value )

inline

set integer value

Definition at line 644 of file PolyReference.h.

◆ operator=() [2/3]

CFloatPolyRef& GENAPI_NAMESPACE::CFloatPolyRef::operator= ( IBase * pValue )

inline

set pointer

Definition at line 659 of file PolyReference.h.

◆ operator=() [3/3]

CFloatPolyRef& GENAPI_NAMESPACE::CFloatPolyRef::operator= ( INode * pValue )

inline

set pointer

Definition at line 652 of file PolyReference.h.

◆ SetValue()

void GENAPI_NAMESPACE::CFloatPolyRef::SetValue	(	double	Value,
		bool	Verify = `true`
	)

inline

see IFloat interface

Definition at line 752 of file PolyReference.h.

Member Data Documentation

◆ m_Type

EType GENAPI_NAMESPACE::CFloatPolyRef::m_Type

protected

the type of the internally held pointer

Definition at line 1048 of file PolyReference.h.

◆ m_Value

union { ... } GENAPI_NAMESPACE::CFloatPolyRef::m_Value

the place to store the value or the pointers to the nodes to get the value from

◆ pEnumeration

IEnumeration* GENAPI_NAMESPACE::CFloatPolyRef::pEnumeration

Integer node

Definition at line 1056 of file PolyReference.h.

◆ pFloat

IFloat* GENAPI_NAMESPACE::CFloatPolyRef::pFloat

fixed value

Definition at line 1054 of file PolyReference.h.

◆ pInteger

IInteger* GENAPI_NAMESPACE::CFloatPolyRef::pInteger

Float node

Definition at line 1055 of file PolyReference.h.

◆ Value

double GENAPI_NAMESPACE::CFloatPolyRef::Value

Definition at line 1053 of file PolyReference.h.

The documentation for this class was generated from the following file:

PolyReference.h

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ EType

Member Enumeration Documentation

◆ _EType

Constructor & Destructor Documentation

◆ CFloatPolyRef()

Member Function Documentation

◆ GetCachingMode()

◆ GetDisplayNotation()

◆ GetDisplayPrecision()

◆ GetInc() [1/2]

◆ GetInc() [2/2]

◆ GetMax()

◆ GetMin()

◆ GetPointer()

◆ GetRepresentation()

◆ GetUnit()

◆ GetValue()

◆ HasInc()

◆ IsInitialized()

◆ IsPointer()

◆ IsValue()

◆ operator INode *()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ SetValue()

Member Data Documentation

◆ m_Type

◆ m_Value

◆ pEnumeration

◆ pFloat

◆ pInteger

◆ Value