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>

List of all members.

Public Member Functions
	CStringPolyRef ()
	Contructor.
int64_t	GetMaxLength ()
	see IString interface
GENICAM_NAMESPACE::gcstring	GetName () const
INodePrivate *	GetPointer () const
	returns the pointer referenced
GENICAM_NAMESPACE::gcstring	GetValue (bool Verify=false, bool IgnoreCache=false) const
	see IString interface
bool	IsInitialized () const
	True if the object is initilaized.
bool	IsPointer () const
	True if the object references a pointer.
bool	IsValue () const
	True if the object references a pointer.
bool	IsValueCacheValid () const
	see IValue interface
	operator INode * (void) const
	cast to INode (may be zero)
void	operator= (const GENICAM_NAMESPACE::gcstring &Value)
	set string value
void	operator= (IBase *pValue)
	set pointer
void	SetValue (const GENICAM_NAMESPACE::gcstring &Value, bool Verify=true)
	see IString interface
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
Protected Attributes
EType	m_Type
	the type of the internally held pointer
struct {
IString *   pString
	> fixed value
GENICAM_NAMESPACE::gcstring   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 gcstring which can be either a gcstring variable, or a pointer to an IString.

Definition at line 1056 of file PolyReference.h.

---

Member Typedef Documentation

typedef enum GENAPI_NAMESPACE::CStringPolyRef::_EType GENAPI_NAMESPACE::CStringPolyRef::EType [protected]

possible types of the internally held pointer

---

Member Enumeration Documentation

enum GENAPI_NAMESPACE::CStringPolyRef::_EType [protected]

possible types of the internally held pointer

Enumerator:

typeUninitialized
typeValue
typeIString

Definition at line 1213 of file PolyReference.h.

---

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CStringPolyRef::CStringPolyRef

(

)

[inline]

Contructor.

Definition at line 1060 of file PolyReference.h.

---

Member Function Documentation

int64_t GENAPI_NAMESPACE::CStringPolyRef::GetMaxLength

(

)

[inline]

see IString interface

Definition at line 1174 of file PolyReference.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CStringPolyRef::GetName

(

)

const [inline]

Definition at line 1067 of file PolyReference.h.

INodePrivate* GENAPI_NAMESPACE::CStringPolyRef::GetPointer

(

)

const [inline]

returns the pointer referenced

Definition at line 1114 of file PolyReference.h.

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

see IString interface

Definition at line 1138 of file PolyReference.h.

bool GENAPI_NAMESPACE::CStringPolyRef::IsInitialized

(

)

const [inline]

True if the object is initilaized.

Definition at line 1108 of file PolyReference.h.

bool GENAPI_NAMESPACE::CStringPolyRef::IsPointer

(

)

const [inline]

True if the object references a pointer.

Definition at line 1102 of file PolyReference.h.

bool GENAPI_NAMESPACE::CStringPolyRef::IsValue

(

)

const [inline]

True if the object references a pointer.

Definition at line 1095 of file PolyReference.h.

bool GENAPI_NAMESPACE::CStringPolyRef::IsValueCacheValid

(

)

const [inline]

see IValue interface

Definition at line 1194 of file PolyReference.h.

GENAPI_NAMESPACE::CStringPolyRef::operator INode *

(

void

)

const [inline]

cast to INode (may be zero)

Definition at line 1132 of file PolyReference.h.

void GENAPI_NAMESPACE::CStringPolyRef::operator=

(

const GENICAM_NAMESPACE::gcstring &

Value

)

[inline]

set string value

Definition at line 1078 of file PolyReference.h.

void GENAPI_NAMESPACE::CStringPolyRef::operator=

(

IBase *

pValue

)

[inline]

set pointer

Definition at line 1085 of file PolyReference.h.

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

see IString interface

Definition at line 1155 of file PolyReference.h.

---

Member Data Documentation

EType GENAPI_NAMESPACE::CStringPolyRef::m_Type [protected]

the type of the internally held pointer

Definition at line 1221 of file PolyReference.h.

struct { ... } GENAPI_NAMESPACE::CStringPolyRef::m_Value [protected]

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

IString* GENAPI_NAMESPACE::CStringPolyRef::pString

> fixed value

Definition at line 1227 of file PolyReference.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CStringPolyRef::Value

Definition at line 1226 of file PolyReference.h.

---

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

• PolyReference.h