GENAPI_NAMESPACE::CStringPolyRef Class Reference

A reference to a gcstring which can be either a gcstring variable, or a pointer to an IString. More...

#include <PolyReference.h>

Public Member Functions
	CStringPolyRef ()
	Constructor. More...
int64_t	GetMaxLength (bool Verify=false)
	see IString interface More...
GENICAM_NAMESPACE::gcstring	GetName () const
INodePrivate *	GetPointer () const
	returns the pointer referenced More...
GENICAM_NAMESPACE::gcstring	GetValue (bool Verify=false, bool IgnoreCache=false) const
	see IString interface More...
bool	IsInitialized () const
	True if the object is initilaized. 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...
CStringPolyRef &	operator= (const GENICAM_NAMESPACE::gcstring &Value)
	set string value More...
CStringPolyRef &	operator= (IBase *pValue)
	set pointer More...
void	SetValue (const GENICAM_NAMESPACE::gcstring &Value, bool Verify=true)
	see IString interface More...

Protected Types
enum	_EType { typeUninitialized, typeValue, typeIString }
	possible types of the internally held pointer More...
typedef enum GENAPI_NAMESPACE::CStringPolyRef::_EType	EType
	possible types of the internally held pointer More...

Protected Attributes
EType	m_Type
	the type of the internally held pointer More...
struct {
IString *   pString
	fixed value More...
GENICAM_NAMESPACE::gcstring   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 gcstring which can be either a gcstring variable, or a pointer to an IString.

Definition at line 1064 of file PolyReference.h.

Member Typedef Documentation

EType

typedef enum GENAPI_NAMESPACE::CStringPolyRef::_EType GENAPI_NAMESPACE::CStringPolyRef::EType

protected

possible types of the internally held pointer

Member Enumeration Documentation

_EType

enum GENAPI_NAMESPACE::CStringPolyRef::_EType

protected

possible types of the internally held pointer

Enumerator
typeUninitialized
typeValue
typeIString

Definition at line 1222 of file PolyReference.h.

Constructor & Destructor Documentation

CStringPolyRef()

GENAPI_NAMESPACE::CStringPolyRef::CStringPolyRef ( )

inline

Constructor.

Definition at line 1068 of file PolyReference.h.

Member Function Documentation

GetMaxLength()

int64_t GENAPI_NAMESPACE::CStringPolyRef::GetMaxLength ( bool  Verify = false )

inline

see IString interface

Definition at line 1183 of file PolyReference.h.

GetName()

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CStringPolyRef::GetName ( ) const

inline

Definition at line 1075 of file PolyReference.h.

GetPointer()

INodePrivate* GENAPI_NAMESPACE::CStringPolyRef::GetPointer ( ) const

inline

returns the pointer referenced

Definition at line 1123 of file PolyReference.h.

GetValue()

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CStringPolyRef::GetValue ( bool  Verify = false, bool  IgnoreCache = false  ) const

inline

see IString interface

Definition at line 1147 of file PolyReference.h.

IsInitialized()

bool GENAPI_NAMESPACE::CStringPolyRef::IsInitialized ( ) const

inline

True if the object is initilaized.

Definition at line 1117 of file PolyReference.h.

IsPointer()

bool GENAPI_NAMESPACE::CStringPolyRef::IsPointer ( ) const

inline

True if the object references a pointer.

Definition at line 1111 of file PolyReference.h.

IsValue()

bool GENAPI_NAMESPACE::CStringPolyRef::IsValue ( ) const

inline

True if the object references a pointer.

Definition at line 1104 of file PolyReference.h.

IsValueCacheValid()

bool GENAPI_NAMESPACE::CStringPolyRef::IsValueCacheValid ( ) const

inline

see IValue interface

Definition at line 1203 of file PolyReference.h.

operator INode *()

GENAPI_NAMESPACE::CStringPolyRef::operator INode * ( void  ) const

inline

cast to INode (may be zero)

Definition at line 1141 of file PolyReference.h.

operator=() [1/2]

CStringPolyRef& GENAPI_NAMESPACE::CStringPolyRef::operator= ( const GENICAM_NAMESPACE::gcstring &  Value )

inline

set string value

Definition at line 1086 of file PolyReference.h.

operator=() [2/2]

CStringPolyRef& GENAPI_NAMESPACE::CStringPolyRef::operator= ( IBase *  pValue )

inline

set pointer

Definition at line 1094 of file PolyReference.h.

SetValue()

void GENAPI_NAMESPACE::CStringPolyRef::SetValue ( const GENICAM_NAMESPACE::gcstring &  Value, bool  Verify = true  )

inline

see IString interface

Definition at line 1164 of file PolyReference.h.

Member Data Documentation

m_Type

EType GENAPI_NAMESPACE::CStringPolyRef::m_Type

protected

the type of the internally held pointer

Definition at line 1230 of file PolyReference.h.

m_Value

struct { ... } GENAPI_NAMESPACE::CStringPolyRef::m_Value

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

pString

IString* GENAPI_NAMESPACE::CStringPolyRef::pString

fixed value

Definition at line 1236 of file PolyReference.h.

Value

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CStringPolyRef::Value

Definition at line 1235 of file PolyReference.h.

---

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

• PolyReference.h