GENAPI_NAMESPACE::CIntRegImpl Class Reference

IInteger implementation for a register. More...

#include <IntReg.h>

Inheritance diagram for GENAPI_NAMESPACE::CIntRegImpl:

List of all members.

Public Member Functions
	CIntRegImpl ()
	Constructor.
virtual bool	GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const
virtual EInterfaceType	InternalGetPrincipalInterfaceType () const
	Implementation of IBase::GetPrincipalInterfaceType()
virtual void	SetProperty (CProperty &Property)
Protected Member Functions
virtual int64_t	InternalGetInc () const
	Get increment.
virtual int64_t	InternalGetLength ()
	Retrieves the Length of the register [Bytes].
virtual const int64_autovector_t	InternalGetListOfValidValues ()
	Get list of valid value.
virtual int64_t	InternalGetMax () const
	Get maximum value allowed.
virtual int64_t	InternalGetMin () const
	Get minimum value allowed.
virtual ERepresentation	InternalGetRepresentation () const
	Get recommended representation.
virtual GENICAM_NAMESPACE::gcstring	InternalGetUnit ()
	Get the unit.
virtual int64_t	InternalGetValue (bool Verify=false, bool IgnoreCache=false)
	Get feature value.
virtual void	InternalSetValue (int64_t Value, bool Verify=true)
	Set feature value.
void	ReadReg (uint8_t *ValueBytes, bool Verify=false, bool IgnoreCache=false)
	helpers to handle the register access incl. swapping
virtual void	SetInvalid (ESetInvalidMode simMode)
void	UpdateMasks () const
	pre-computes some masks
void	WriteReg (uint8_t *ValueBytes, bool Verify=true)
	helpers to handle the register access incl. swapping
Protected Attributes
EEndianess	m_Endianess
	endianess of the register
bool	m_MasksAreValid
	if true the masks are valid
int64_t	m_Max
	maximum value to be stored in the Register
int64_t	m_Min
	minimum value to be stored in the Register
ERepresentation	m_Representation
	representation of the integer
ESign	m_Sign
	sign of the integer
uint64_t	m_SignBit
	The bit indicating the sign of the number to be retrievend.
uint64_t	m_SignMask
	The bit to be set to -1 if the number is negative.
GENICAM_NAMESPACE::gcstring	m_Unit
	the physical unit name

---

Detailed Description

IInteger implementation for a register.

Maps an integer (signed or unsigned) to a register

Definition at line 54 of file IntReg.h.

---

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CIntRegImpl::CIntRegImpl

(

)

Constructor.

---

Member Function Documentation

virtual bool GENAPI_NAMESPACE::CIntRegImpl::GetProperty	(	CNodeDataMap *	pNodeDataMap,
		CPropertyID::EProperty_ID_t	PropertyID,
		CNodeData::PropertyVector_t &	PropertyList
	)		const [virtual]

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

virtual int64_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetInc

(

)

const [protected, virtual]

Get increment.

virtual int64_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetLength

(

)

[protected, virtual]

Retrieves the Length of the register [Bytes].

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

virtual const int64_autovector_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetListOfValidValues

(

)

[inline, protected, virtual]

Get list of valid value.

Definition at line 100 of file IntReg.h.

virtual int64_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetMax

(

)

const [protected, virtual]

Get maximum value allowed.

virtual int64_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetMin

(

)

const [protected, virtual]

Get minimum value allowed.

virtual EInterfaceType GENAPI_NAMESPACE::CIntRegImpl::InternalGetPrincipalInterfaceType

(

)

const [inline, virtual]

Implementation of IBase::GetPrincipalInterfaceType()

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

Definition at line 63 of file IntReg.h.

virtual ERepresentation GENAPI_NAMESPACE::CIntRegImpl::InternalGetRepresentation

(

)

const [protected, virtual]

Get recommended representation.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CIntRegImpl::InternalGetUnit

(

)

[protected, virtual]

Get the unit.

virtual int64_t GENAPI_NAMESPACE::CIntRegImpl::InternalGetValue	(	bool	Verify = false,
		bool	IgnoreCache = false
	)		[protected, virtual]

Get feature value.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

virtual void GENAPI_NAMESPACE::CIntRegImpl::InternalSetValue	(	int64_t	Value,
		bool	Verify = true
	)		[protected, virtual]

Set feature value.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

void GENAPI_NAMESPACE::CIntRegImpl::ReadReg	(	uint8_t *	ValueBytes,
		bool	Verify = false,
		bool	IgnoreCache = false
	)		[protected]

helpers to handle the register access incl. swapping

virtual void GENAPI_NAMESPACE::CIntRegImpl::SetInvalid

(

ESetInvalidMode

simMode

)

[protected, virtual]

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CIntRegImpl::SetProperty

(

CProperty &

Property

)

[virtual]

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Reimplemented in GENAPI_NAMESPACE::CMaskedIntRegImpl.

void GENAPI_NAMESPACE::CIntRegImpl::UpdateMasks

(

)

const [protected]

pre-computes some masks

void GENAPI_NAMESPACE::CIntRegImpl::WriteReg	(	uint8_t *	ValueBytes,
		bool	Verify = true
	)		[protected]

helpers to handle the register access incl. swapping

---

Member Data Documentation

EEndianess GENAPI_NAMESPACE::CIntRegImpl::m_Endianess [protected]

endianess of the register

Definition at line 157 of file IntReg.h.

bool GENAPI_NAMESPACE::CIntRegImpl::m_MasksAreValid [mutable, protected]

if true the masks are valid

Definition at line 81 of file IntReg.h.

int64_t GENAPI_NAMESPACE::CIntRegImpl::m_Max [mutable, protected]

maximum value to be stored in the Register

Definition at line 145 of file IntReg.h.

int64_t GENAPI_NAMESPACE::CIntRegImpl::m_Min [mutable, protected]

minimum value to be stored in the Register

Definition at line 142 of file IntReg.h.

ERepresentation GENAPI_NAMESPACE::CIntRegImpl::m_Representation [protected]

representation of the integer

Definition at line 151 of file IntReg.h.

ESign GENAPI_NAMESPACE::CIntRegImpl::m_Sign [protected]

sign of the integer

Definition at line 148 of file IntReg.h.

uint64_t GENAPI_NAMESPACE::CIntRegImpl::m_SignBit [mutable, protected]

The bit indicating the sign of the number to be retrievend.

Definition at line 160 of file IntReg.h.

uint64_t GENAPI_NAMESPACE::CIntRegImpl::m_SignMask [mutable, protected]

The bit to be set to -1 if the number is negative.

Definition at line 163 of file IntReg.h.

GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CIntRegImpl::m_Unit [protected]

the physical unit name

Definition at line 154 of file IntReg.h.

---

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

• IntReg.h