#include <IEnumerationT.h>

Inheritance diagram for GENAPI_NAMESPACE::CEnumerationTRef< EnumT >:

Public Member Functions
	CEnumerationTRef ()

virtual void	FromString (const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true)
	Set content of the node as string. More...

virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node. More...

virtual IEnumEntry *	GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)
	Get the current entry. More...

virtual void	GetEntries (NodeList_t &Entries)
	Get list of entry nodes. More...

virtual IEnumEntry *	GetEntry (const int64_t IntValue)
	Get an entry node by its IntValue. More...

virtual IEnumEntry *	GetEntry (const EnumT Value)
	returns the EnumEntry object belonging to the Value More...

virtual IEnumEntry *	GetEntryByName (const GENICAM_NAMESPACE::gcstring &Symbolic)
	Get an entry node by name. More...

virtual int64_t	GetIntValue (bool Verify=false, bool IgnoreCache=false)
	Get node value. More...

virtual INode *	GetNode ()
	Get the INode interface of the node. More...

virtual void	GetSymbolics (StringList_t &Symbolics)
	Get list of symbolic Values. More...

virtual EnumT	GetValue (bool Verify=false, bool IgnoreCache=false)
	Get node value. More...

bool	IsValueCacheValid () const
	Checks if the value comes from cache or is requested from another node. More...

virtual EnumT	operator() ()
	Get node value. More...

virtual GENICAM_NAMESPACE::gcstring	operator* ()
	Get node value. More...

virtual IEnumeration &	operator= (const GENICAM_NAMESPACE::gcstring &ValueStr)
	Set node value. More...

virtual IEnumeration &	operator= (const char *pValueStr)
	Set node value. More...

virtual IEnumeration &	operator= (EnumT Value)
	Set node value. More...

virtual void	SetEnumReference (int Index, GENICAM_NAMESPACE::gcstring Name)
	sets the Enum value corresponding to a value More...

virtual void	SetIntValue (int64_t Value, bool Verify=true)
	Set node value. More...

virtual void	SetNumEnums (int NumEnums)
	sets the number of enum values More...

virtual void	SetReference (IBase *ptr)
	sets the implementation to the reference More...

virtual void	SetValue (EnumT Value, bool Verify=true)
	Set node value. More...

virtual GENICAM_NAMESPACE::gcstring	ToString (bool Verify=false, bool IgnoreCache=false)
	Get content of the node as string. More...

Protected Attributes
std::vector< bool >	m_EnumExists
	Indicates it an enum with a given index exists. More...

std::vector< int64_t >	m_EnumValues
	The values for enums with a given index. More...

IEnumeration *	m_Ptr
	Pointer to the implementation the reference references to. More...

Detailed Description

template<class EnumT>
class GENAPI_NAMESPACE::CEnumerationTRef< EnumT >

Definition at line 100 of file IEnumerationT.h.

Constructor & Destructor Documentation

template<class EnumT >

GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::CEnumerationTRef ( )

inline

Definition at line 104 of file IEnumerationT.h.

Member Function Documentation

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::FromString	(	const GENICAM_NAMESPACE::gcstring &	ValueStr,
		bool	Verify = `true`
	)

inlinevirtual

Set content of the node as string.

Definition at line 186 of file IEnumerationT.h.

template<class EnumT >

virtual EAccessMode GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetAccessMode ( ) const

inlinevirtual

Get the access mode of the node.

Definition at line 155 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetCurrentEntry	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

inlinevirtual

Get the current entry.

Definition at line 290 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetEntries ( NodeList_t & Entries )

inlinevirtual

Get list of entry nodes.

Definition at line 217 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetEntry ( const int64_t IntValue )

inlinevirtual

Get an entry node by its IntValue.

Definition at line 281 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetEntry ( const EnumT Value )

inlinevirtual

returns the EnumEntry object belonging to the Value

Definition at line 351 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetEntryByName ( const GENICAM_NAMESPACE::gcstring & Symbolic )

inlinevirtual

Get an entry node by name.

Definition at line 271 of file IEnumerationT.h.

template<class EnumT >

virtual int64_t GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetIntValue	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

inlinevirtual

Get node value.

Definition at line 262 of file IEnumerationT.h.

template<class EnumT >

virtual INode* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetNode ( )

inlinevirtual

Get the INode interface of the node.

Definition at line 168 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetSymbolics ( StringList_t & Symbolics )

inlinevirtual

Get list of symbolic Values.

Definition at line 208 of file IEnumerationT.h.

template<class EnumT >

virtual EnumT GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::GetValue	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

inlinevirtual

Get node value.

Definition at line 327 of file IEnumerationT.h.

template<class EnumT >

bool GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::IsValueCacheValid ( ) const

inline

Checks if the value comes from cache or is requested from another node.

Definition at line 195 of file IEnumerationT.h.

template<class EnumT >

virtual EnumT GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::operator() ( )

inlinevirtual

Get node value.

Definition at line 345 of file IEnumerationT.h.

template<class EnumT >

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::operator* ( )

inlinevirtual

Get node value.

Definition at line 253 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumeration& GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::operator= ( const GENICAM_NAMESPACE::gcstring & ValueStr )

inlinevirtual

Set node value.

Definition at line 226 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumeration& GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::operator= ( const char * pValueStr )

inlinevirtual

Set node value.

Definition at line 235 of file IEnumerationT.h.

template<class EnumT >

virtual IEnumeration& GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::operator= ( EnumT Value )

inlinevirtual

Set node value.

Definition at line 320 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::SetEnumReference	(	int	Index,
		GENICAM_NAMESPACE::gcstring	Name
	)

inlinevirtual

sets the Enum value corresponding to a value

Definition at line 135 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::SetIntValue	(	int64_t	Value,
		bool	Verify = `true`
	)

inlinevirtual

Set node value.

Definition at line 244 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::SetNumEnums ( int NumEnums )

inlinevirtual

sets the number of enum values

Definition at line 123 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::SetReference ( IBase * ptr )

inlinevirtual

sets the implementation to the reference

Definition at line 113 of file IEnumerationT.h.

template<class EnumT >

virtual void GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::SetValue	(	EnumT	Value,
		bool	Verify = `true`
	)

inlinevirtual

Set node value.

Definition at line 303 of file IEnumerationT.h.

template<class EnumT >

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::ToString	(	bool	Verify = `false`,
		bool	IgnoreCache = `false`
	)

inlinevirtual

Get content of the node as string.

Definition at line 177 of file IEnumerationT.h.

Member Data Documentation

template<class EnumT >

std::vector<bool > GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::m_EnumExists

protected

Indicates it an enum with a given index exists.

Definition at line 375 of file IEnumerationT.h.

template<class EnumT >

std::vector<int64_t > GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::m_EnumValues

protected

The values for enums with a given index.

Definition at line 372 of file IEnumerationT.h.

template<class EnumT >

IEnumeration* GENAPI_NAMESPACE::CEnumerationTRef< EnumT >::m_Ptr

protected

Pointer to the implementation the reference references to.

Definition at line 369 of file IEnumerationT.h.

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

IEnumerationT.h

Public Member Functions

Protected Attributes

Detailed Description

template<class EnumT> class GENAPI_NAMESPACE::CEnumerationTRef< EnumT >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class EnumT>
class GENAPI_NAMESPACE::CEnumerationTRef< EnumT >