All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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...
 
CBooleanPolyRefoperator= (bool Value)
 set integer value More...
 
CBooleanPolyRefoperator= (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 449 of file PolyReference.h.

Member Typedef Documentation

◆ EType

possible types of the internally held pointer

Member Enumeration Documentation

◆ _EType

possible types of the internally held pointer

Enumerator
typeUninitialized 
typeValue 
typeIInteger 
typeIEnumeration 
typeIBoolean 

Definition at line 608 of file PolyReference.h.

Constructor & Destructor Documentation

◆ CBooleanPolyRef()

GENAPI_NAMESPACE::CBooleanPolyRef::CBooleanPolyRef ( )
inline

Constructor.

Definition at line 453 of file PolyReference.h.

Member Function Documentation

◆ GetCachingMode()

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

Definition at line 587 of file PolyReference.h.

◆ GetName()

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

Definition at line 460 of file PolyReference.h.

◆ GetPointer()

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

returns the pointer referenced

Definition at line 514 of file PolyReference.h.

◆ GetValue()

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

see IBoolean interface

Definition at line 542 of file PolyReference.h.

◆ IsInitialized()

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

True if the object is initilaized.

Definition at line 508 of file PolyReference.h.

◆ IsPointer()

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

True if the object references a pointer.

Definition at line 502 of file PolyReference.h.

◆ operator INode *()

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

cast to INode (may be zero)

Definition at line 536 of file PolyReference.h.

◆ operator=() [1/2]

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

set integer value

Definition at line 471 of file PolyReference.h.

◆ operator=() [2/2]

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

set pointer

Definition at line 479 of file PolyReference.h.

◆ SetValue()

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

see IBoolean interface

Definition at line 563 of file PolyReference.h.

Member Data Documentation

◆ m_Type

EType GENAPI_NAMESPACE::CBooleanPolyRef::m_Type
protected

the type of the internally held pointer

Definition at line 618 of file PolyReference.h.

◆ m_Value

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

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

◆ pBoolean

IBoolean* GENAPI_NAMESPACE::CBooleanPolyRef::pBoolean

Enumeration node

Definition at line 626 of file PolyReference.h.

◆ pEnumeration

IEnumeration* GENAPI_NAMESPACE::CBooleanPolyRef::pEnumeration

Integer node

Definition at line 625 of file PolyReference.h.

◆ pInteger

IInteger* GENAPI_NAMESPACE::CBooleanPolyRef::pInteger

fixed value

Definition at line 624 of file PolyReference.h.

◆ Value

bool GENAPI_NAMESPACE::CBooleanPolyRef::Value

Definition at line 623 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 Dec 4 2024 03:10:12