Public Types | Public Member Functions | Protected Attributes | List of all members
GENAPI_NAMESPACE::CFloatPolyRef Class Reference

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...
 
INodePrivateGetPointer () 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...
 
void operator= (double Value)
 set integer value More...
 
void operator= (INode *pValue)
 set pointer More...
 
void operator= (IBase *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 628 of file PolyReference.h.

Member Typedef Documentation

possible types of the internally held pointer

Member Enumeration Documentation

possible types of the internally held pointer

Enumerator
typeUninitialized 
typeValue 
typeIFloat 
typeIInteger 
typeIEnumeration 

Definition at line 1010 of file PolyReference.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CFloatPolyRef::CFloatPolyRef ( )
inline

Constructor.

Definition at line 632 of file PolyReference.h.

Member Function Documentation

ECachingMode GENAPI_NAMESPACE::CFloatPolyRef::GetCachingMode ( ) const
inline

Definition at line 1019 of file PolyReference.h.

EDisplayNotation GENAPI_NAMESPACE::CFloatPolyRef::GetDisplayNotation ( ) const
inline

see IFloat

Definition at line 972 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CFloatPolyRef::GetDisplayPrecision ( ) const
inline

see IFloat

Definition at line 991 of file PolyReference.h.

virtual double GENAPI_NAMESPACE::CFloatPolyRef::GetInc ( )
inlinevirtual

Get the constant increment if there is any.

Definition at line 868 of file PolyReference.h.

double GENAPI_NAMESPACE::CFloatPolyRef::GetInc ( ) const
inline

extension required for swiss knifes

Definition at line 888 of file PolyReference.h.

double GENAPI_NAMESPACE::CFloatPolyRef::GetMax ( ) const
inline

see IFloat interface

Definition at line 829 of file PolyReference.h.

double GENAPI_NAMESPACE::CFloatPolyRef::GetMin ( ) const
inline

see IFloat interface

Definition at line 809 of file PolyReference.h.

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

returns the pointer referenced

Definition at line 692 of file PolyReference.h.

ERepresentation GENAPI_NAMESPACE::CFloatPolyRef::GetRepresentation ( ) const
inline

see IFloat interface

Definition at line 908 of file PolyReference.h.

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

see IFloat interface

Definition at line 928 of file PolyReference.h.

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

see IFloat interface

Definition at line 720 of file PolyReference.h.

bool GENAPI_NAMESPACE::CFloatPolyRef::HasInc ( )
inline

True if the float has a constant increment.

Definition at line 849 of file PolyReference.h.

bool GENAPI_NAMESPACE::CFloatPolyRef::IsInitialized ( ) const
inline

True if the object is initialized.

Definition at line 686 of file PolyReference.h.

bool GENAPI_NAMESPACE::CFloatPolyRef::IsPointer ( ) const
inline

True if the object references a pointer.

Definition at line 680 of file PolyReference.h.

bool GENAPI_NAMESPACE::CFloatPolyRef::IsValue ( ) const
inline

True if the object references a pointer.

Definition at line 674 of file PolyReference.h.

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

cast to INode (may be zero)

Definition at line 714 of file PolyReference.h.

void GENAPI_NAMESPACE::CFloatPolyRef::operator= ( double  Value)
inline

set integer value

Definition at line 639 of file PolyReference.h.

void GENAPI_NAMESPACE::CFloatPolyRef::operator= ( INode pValue)
inline

set pointer

Definition at line 646 of file PolyReference.h.

void GENAPI_NAMESPACE::CFloatPolyRef::operator= ( IBase pValue)
inline

set pointer

Definition at line 652 of file PolyReference.h.

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

see IFloat interface

Definition at line 744 of file PolyReference.h.

Member Data Documentation

EType GENAPI_NAMESPACE::CFloatPolyRef::m_Type
protected

the type of the internally held pointer

Definition at line 1040 of file PolyReference.h.

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

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

IEnumeration* GENAPI_NAMESPACE::CFloatPolyRef::pEnumeration

Integer node

Definition at line 1048 of file PolyReference.h.

IFloat* GENAPI_NAMESPACE::CFloatPolyRef::pFloat

fixed value

Definition at line 1046 of file PolyReference.h.

IInteger* GENAPI_NAMESPACE::CFloatPolyRef::pInteger

Float node

Definition at line 1047 of file PolyReference.h.

double GENAPI_NAMESPACE::CFloatPolyRef::Value

Definition at line 1045 of file PolyReference.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:41