Public Types | Public Member Functions | Protected Attributes
GENAPI_NAMESPACE::CFloatPolyRef Class Reference

#include <PolyReference.h>

List of all members.

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

Public Member Functions

 CFloatPolyRef ()
 Constructor.
ECachingMode GetCachingMode () const
EDisplayNotation GetDisplayNotation () const
 see IFloat
int64_t GetDisplayPrecision () const
 see IFloat
virtual double GetInc ()
 Get the constant increment if there is any.
double GetInc () const
 extension required for swiss knifes
double GetMax () const
 see IFloat interface
double GetMin () const
 see IFloat interface
INodePrivateGetPointer () const
 returns the pointer referenced
ERepresentation GetRepresentation () const
 see IFloat interface
GENICAM_NAMESPACE::gcstring GetUnit () const
 see IFloat interface
double GetValue (bool Verify=false, bool IgnoreCache=false) const
 see IFloat interface
bool HasInc ()
 True if the float has a constant increment.
bool IsInitialized () const
 True if the object is initialized.
bool IsPointer () const
 True if the object references a pointer.
bool IsValue () const
 True if the object references a pointer.
 operator INode * (void) const
 cast to INode (may be zero)
void operator= (double Value)
 set integer value
void operator= (INode *pValue)
 set pointer
void operator= (IBase *pValue)
 set pointer
void SetValue (double Value, bool Verify=true)
 see IFloat interface

Protected Attributes

EType m_Type
 the type of the internally held pointer
union {
   IEnumeration *   pEnumeration
 > Integer node
   IFloat *   pFloat
 > fixed value
   IInteger *   pInteger
 > Float node
   double   Value
m_Value
 the place to store the value or the pointers to the nodes to get the value from

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

Constructor.

Definition at line 632 of file PolyReference.h.


Member Function Documentation

Definition at line 1019 of file PolyReference.h.

see IFloat

Definition at line 972 of file PolyReference.h.

see IFloat

Definition at line 991 of file PolyReference.h.

virtual double GENAPI_NAMESPACE::CFloatPolyRef::GetInc ( ) [inline, virtual]

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.

returns the pointer referenced

Definition at line 692 of file PolyReference.h.

see IFloat interface

Definition at line 908 of file PolyReference.h.

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.

True if the float has a constant increment.

Definition at line 849 of file PolyReference.h.

True if the object is initialized.

Definition at line 686 of file PolyReference.h.

True if the object references a pointer.

Definition at line 680 of file PolyReference.h.

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

the type of the internally held pointer

Definition at line 1040 of file PolyReference.h.

union { ... } GENAPI_NAMESPACE::CFloatPolyRef::m_Value [protected]

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

> Integer node

Definition at line 1048 of file PolyReference.h.

> fixed value

Definition at line 1046 of file PolyReference.h.

> Float node

Definition at line 1047 of file PolyReference.h.

Definition at line 1045 of file PolyReference.h.


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


rc_visard_driver
Author(s): Heiko Hirschmueller , Christian Emmerich , Felix Ruess
autogenerated on Thu Jun 6 2019 20:43:10