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

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

#include <PolyReference.h>

Public Member Functions

 CBooleanPolyRef ()
 Constructor. More...
 
ECachingMode GetCachingMode () const
 
GENICAM_NAMESPACE::gcstring GetName () const
 
INodePrivateGetPointer () const
 returns the pointer referenced More...
 
bool GetValue (bool Verify=false, bool IgnoreCache=false) const
 see IBoolean interface More...
 
bool IsInitialized () const
 True if the object is initilaized. More...
 
bool IsPointer () const
 True if the object references a pointer. More...
 
 operator INode * (void) const
 cast to INode (may be zero) More...
 
void operator= (bool Value)
 set integer value More...
 
void operator= (IBase *pValue)
 set pointer More...
 
void SetValue (bool Value, bool Verify=true)
 see IBoolean interface More...
 

Protected Types

enum  _EType {
  typeUninitialized, typeValue, typeIInteger, typeIEnumeration,
  typeIBoolean
}
 possible types of the internally held pointer More...
 
typedef enum GENAPI_NAMESPACE::CBooleanPolyRef::_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...
 
   IInteger *   pInteger
 

fixed value

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

Definition at line 446 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 

Definition at line 603 of file PolyReference.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CBooleanPolyRef::CBooleanPolyRef ( )
inline

Constructor.

Definition at line 450 of file PolyReference.h.

Member Function Documentation

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

Definition at line 582 of file PolyReference.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CBooleanPolyRef::GetName ( ) const
inline

Definition at line 457 of file PolyReference.h.

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

returns the pointer referenced

Definition at line 509 of file PolyReference.h.

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

see IBoolean interface

Definition at line 537 of file PolyReference.h.

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

True if the object is initilaized.

Definition at line 503 of file PolyReference.h.

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

True if the object references a pointer.

Definition at line 497 of file PolyReference.h.

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

cast to INode (may be zero)

Definition at line 531 of file PolyReference.h.

void GENAPI_NAMESPACE::CBooleanPolyRef::operator= ( bool  Value)
inline

set integer value

Definition at line 468 of file PolyReference.h.

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

set pointer

Definition at line 475 of file PolyReference.h.

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

see IBoolean interface

Definition at line 558 of file PolyReference.h.

Member Data Documentation

EType GENAPI_NAMESPACE::CBooleanPolyRef::m_Type
protected

the type of the internally held pointer

Definition at line 613 of file PolyReference.h.

union { ... } GENAPI_NAMESPACE::CBooleanPolyRef::m_Value

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

IBoolean* GENAPI_NAMESPACE::CBooleanPolyRef::pBoolean

Enumeration node

Definition at line 621 of file PolyReference.h.

IEnumeration* GENAPI_NAMESPACE::CBooleanPolyRef::pEnumeration

Integer node

Definition at line 620 of file PolyReference.h.

IInteger* GENAPI_NAMESPACE::CBooleanPolyRef::pInteger

fixed value

Definition at line 619 of file PolyReference.h.

bool GENAPI_NAMESPACE::CBooleanPolyRef::Value

Definition at line 618 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