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

A reference to an int64 which can bei either an int64 variable, or a pointer to an IInteger, an IEnumeration, an IBoolean, or a IFloat. More...

#include <PolyReference.h>

Public Member Functions

 CIntegerPolyRef ()
 Constructor. More...
 
ECachingMode GetCachingMode () const
 
int64_t GetInc () const
 see IInteger interface More...
 
int64_t GetMax () const
 see IInteger interface More...
 
int64_t GetMin () const
 see IInteger interface More...
 
INodePrivateGetPointer () const
 returns the pointer referenced More...
 
ERepresentation GetRepresentation () const
 see IInteger interface More...
 
GENICAM_NAMESPACE::gcstring GetUnit () const
 see IInteger interface More...
 
int64_t GetValue (bool Verify=false, bool IgnoreCache=false) const
 see IInteger interface 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...
 
bool IsValueCacheValid () const
 see IValue interface More...
 
 operator INode * (void) const
 cast to INode (may be zero) More...
 
void operator= (int64_t Value)
 set integer value More...
 
void operator= (INode *pValue)
 set pointer More...
 
void operator= (IBase *pValue)
 set pointer More...
 
void SetValue (int64_t Value, bool Verify=true)
 see IInteger interface More...
 

Protected Types

enum  _EType {
  typeUninitialized, typeValue, typeIInteger, typeIEnumeration,
  typeIBoolean, typeIFloat
}
 possible types of the internally held pointer More...
 
typedef enum GENAPI_NAMESPACE::CIntegerPolyRef::_EType EType
 possible types of the internally held pointer More...
 

Protected Attributes

EType m_Type
 the type of the internally held pointer More...
 
union {
   IBoolean *   pBoolean
 

Enumeration node

More...
 
   IEnumeration *   pEnumeration
 

Integer node

More...
 
   IFloat *   pFloat
 

Boolean node

More...
 
   IInteger *   pInteger
 

fixed value

More...
 
   int64_t   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 an int64 which can bei either an int64 variable, or a pointer to an IInteger, an IEnumeration, an IBoolean, or a IFloat.

Definition at line 68 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 
typeIInteger 
typeIEnumeration 
typeIBoolean 
typeIFloat 

Definition at line 419 of file PolyReference.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CIntegerPolyRef::CIntegerPolyRef ( )
inline

Constructor.

Definition at line 72 of file PolyReference.h.

Member Function Documentation

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

Definition at line 395 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CIntegerPolyRef::GetInc ( ) const
inline

see IInteger interface

Definition at line 308 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CIntegerPolyRef::GetMax ( ) const
inline

see IInteger interface

Definition at line 282 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CIntegerPolyRef::GetMin ( ) const
inline

see IInteger interface

Definition at line 256 of file PolyReference.h.

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

returns the pointer referenced

Definition at line 138 of file PolyReference.h.

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

see IInteger interface

Definition at line 332 of file PolyReference.h.

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

see IInteger interface

Definition at line 352 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CIntegerPolyRef::GetValue ( bool  Verify = false,
bool  IgnoreCache = false 
) const
inline

see IInteger interface

Definition at line 167 of file PolyReference.h.

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

True if the object is initialized.

Definition at line 132 of file PolyReference.h.

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

True if the object references a pointer.

Definition at line 120 of file PolyReference.h.

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

True if the object references a pointer.

Definition at line 126 of file PolyReference.h.

bool GENAPI_NAMESPACE::CIntegerPolyRef::IsValueCacheValid ( ) const
inline

see IValue interface

Definition at line 373 of file PolyReference.h.

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

cast to INode (may be zero)

Definition at line 161 of file PolyReference.h.

void GENAPI_NAMESPACE::CIntegerPolyRef::operator= ( int64_t  Value)
inline

set integer value

Definition at line 79 of file PolyReference.h.

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

set pointer

Definition at line 86 of file PolyReference.h.

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

set pointer

Definition at line 92 of file PolyReference.h.

void GENAPI_NAMESPACE::CIntegerPolyRef::SetValue ( int64_t  Value,
bool  Verify = true 
)
inline

see IInteger interface

Definition at line 198 of file PolyReference.h.

Member Data Documentation

EType GENAPI_NAMESPACE::CIntegerPolyRef::m_Type
protected

the type of the internally held pointer

Definition at line 430 of file PolyReference.h.

union { ... } GENAPI_NAMESPACE::CIntegerPolyRef::m_Value

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

IBoolean* GENAPI_NAMESPACE::CIntegerPolyRef::pBoolean

Enumeration node

Definition at line 438 of file PolyReference.h.

IEnumeration* GENAPI_NAMESPACE::CIntegerPolyRef::pEnumeration

Integer node

Definition at line 437 of file PolyReference.h.

IFloat* GENAPI_NAMESPACE::CIntegerPolyRef::pFloat

Boolean node

Definition at line 439 of file PolyReference.h.

IInteger* GENAPI_NAMESPACE::CIntegerPolyRef::pInteger

fixed value

Definition at line 436 of file PolyReference.h.

int64_t GENAPI_NAMESPACE::CIntegerPolyRef::Value

Definition at line 435 of file PolyReference.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:55