#include <IFloat.h>

Inheritance diagram for GENAPI_NAMESPACE::CFloatRefT< T >:

[legend]

Public Member Functions
virtual EDisplayNotation	GetDisplayNotation () const
	Get the way the float should be converted to a string. More...

virtual int64_t	GetDisplayPrecision () const
	Get the precision to be used when converting the float to a string. More...

IEnumeration *	GetEnumAlias ()
	gets the interface of an alias node. More...

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

virtual EIncMode	GetIncMode ()

IInteger *	GetIntAlias ()
	gets the interface of an alias node. More...

virtual double_autovector_t	GetListOfValidValues (bool bounded=true)
	Get list of valid value. More...

virtual double	GetMax ()
	Get maximum value allowed. More...

virtual double	GetMin ()
	Get minimum value allowed. More...

virtual ERepresentation	GetRepresentation ()
	Get recommended representation. More...

virtual GENICAM_NAMESPACE::gcstring	GetUnit () const
	Get unit. More...

virtual double	GetValue (bool Verify=false, bool IgnoreCache=false)
	Get node value. More...

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

virtual void	ImposeMax (double Value)
	Restrict maximum value. More...

virtual void	ImposeMin (double Value)
	Restrict minimum value. More...

virtual double	operator() ()
	Get node value. More...

virtual double	operator* ()
	Get node value. More...

virtual IFloat &	operator= (double Value)
	Set node value. More...

virtual void	SetValue (double Value, bool Verify=true)
	Set node value. More...

Public Member Functions inherited from GENAPI_NAMESPACE::CValueRefT< T >
virtual void	FromString (const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true)
	Set content of the node as string. More...

virtual INode *	GetNode ()
	Get the INode interface of the node. More...

virtual bool	IsValueCacheValid () const
	Checks if the value comes from cache or is requested from another node. More...

virtual GENICAM_NAMESPACE::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	Get content of the node as string. More...

Public Member Functions inherited from GENAPI_NAMESPACE::CBaseRefT< T, T >
virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node. More...

Public Member Functions inherited from GENAPI_NAMESPACE::CReferenceT< T, T >
	CReferenceT ()

virtual void	SetReference (IBase *ptr)
	sets the implementation to the reference More...

Private Types
typedef CValueRefT< T >	ref

Additional Inherited Members
Protected Attributes inherited from GENAPI_NAMESPACE::CReferenceT< T, T >
T *	m_Ptr
	Pointer to the implementation the reference references to. More...

Detailed Description

template<class T>
class GENAPI_NAMESPACE::CFloatRefT< T >

Definition at line 131 of file IFloat.h.

Member Typedef Documentation

◆ ref

template<class T >

typedef CValueRefT<T> GENAPI_NAMESPACE::CFloatRefT< T >::ref

private

Definition at line 133 of file IFloat.h.

Member Function Documentation

◆ GetDisplayNotation()

template<class T >

virtual EDisplayNotation GENAPI_NAMESPACE::CFloatRefT< T >::GetDisplayNotation ( ) const

inlinevirtual

Get the way the float should be converted to a string.

Definition at line 243 of file IFloat.h.

◆ GetDisplayPrecision()

template<class T >

virtual int64_t GENAPI_NAMESPACE::CFloatRefT< T >::GetDisplayPrecision ( ) const

inlinevirtual

Get the precision to be used when converting the float to a string.

Definition at line 251 of file IFloat.h.

◆ GetEnumAlias()

template<class T >

IEnumeration* GENAPI_NAMESPACE::CFloatRefT< T >::GetEnumAlias ( )

inline

gets the interface of an alias node.

Definition at line 267 of file IFloat.h.

◆ GetInc()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::GetInc ( )

inlinevirtual

Get the constant increment if there is any.

Definition at line 211 of file IFloat.h.

◆ GetIncMode()

template<class T >

virtual EIncMode GENAPI_NAMESPACE::CFloatRefT< T >::GetIncMode ( )

inlinevirtual

Definition at line 203 of file IFloat.h.

◆ GetIntAlias()

template<class T >

IInteger* GENAPI_NAMESPACE::CFloatRefT< T >::GetIntAlias ( )

inline

gets the interface of an alias node.

Definition at line 259 of file IFloat.h.

◆ GetListOfValidValues()

template<class T >

virtual double_autovector_t GENAPI_NAMESPACE::CFloatRefT< T >::GetListOfValidValues ( bool bounded = true )

inlinevirtual

Get list of valid value.

Definition at line 219 of file IFloat.h.

◆ GetMax()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::GetMax ( )

inlinevirtual

Get maximum value allowed.

Definition at line 189 of file IFloat.h.

◆ GetMin()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::GetMin ( )

inlinevirtual

Get minimum value allowed.

Definition at line 181 of file IFloat.h.

◆ GetRepresentation()

template<class T >

virtual ERepresentation GENAPI_NAMESPACE::CFloatRefT< T >::GetRepresentation ( )

inlinevirtual

Get recommended representation.

Definition at line 227 of file IFloat.h.

◆ GetUnit()

template<class T >

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFloatRefT< T >::GetUnit ( ) const

inlinevirtual

Get unit.

Definition at line 235 of file IFloat.h.

◆ GetValue()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::GetValue	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

inlinevirtual

Get node value.

Definition at line 157 of file IFloat.h.

◆ HasInc()

template<class T >

virtual bool GENAPI_NAMESPACE::CFloatRefT< T >::HasInc ( )

inlinevirtual

True if the float has a constant increment.

Definition at line 197 of file IFloat.h.

◆ ImposeMax()

template<class T >

virtual void GENAPI_NAMESPACE::CFloatRefT< T >::ImposeMax ( double Value )

inlinevirtual

Restrict maximum value.

Definition at line 283 of file IFloat.h.

◆ ImposeMin()

template<class T >

virtual void GENAPI_NAMESPACE::CFloatRefT< T >::ImposeMin ( double Value )

inlinevirtual

Restrict minimum value.

Definition at line 275 of file IFloat.h.

◆ operator()()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::operator() ( )

inlinevirtual

Get node value.

Definition at line 165 of file IFloat.h.

◆ operator*()

template<class T >

virtual double GENAPI_NAMESPACE::CFloatRefT< T >::operator* ( )

inlinevirtual

Get node value.

Definition at line 173 of file IFloat.h.

◆ operator=()

template<class T >

virtual IFloat& GENAPI_NAMESPACE::CFloatRefT< T >::operator= ( double Value )

inlinevirtual

Set node value.

Definition at line 149 of file IFloat.h.

◆ SetValue()

template<class T >

virtual void GENAPI_NAMESPACE::CFloatRefT< T >::SetValue	(	double	Value,
		bool	Verify = `true`
	)

inlinevirtual

Set node value.

Definition at line 141 of file IFloat.h.

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

IFloat.h

Public Member Functions

Private Types

Additional Inherited Members

Detailed Description

template<class T> class GENAPI_NAMESPACE::CFloatRefT< T >

Member Typedef Documentation

◆ ref

Member Function Documentation

◆ GetDisplayNotation()

◆ GetDisplayPrecision()

◆ GetEnumAlias()

◆ GetInc()

◆ GetIncMode()

◆ GetIntAlias()

◆ GetListOfValidValues()

◆ GetMax()

◆ GetMin()

◆ GetRepresentation()

◆ GetUnit()

◆ GetValue()

◆ HasInc()

◆ ImposeMax()

◆ ImposeMin()

◆ operator()()

◆ operator*()

◆ operator=()

◆ SetValue()

template<class T>
class GENAPI_NAMESPACE::CFloatRefT< T >