Public Member Functions | Protected Member Functions | Protected Attributes
GENAPI_NAMESPACE::CFltRegImpl Class Reference

IFloat implementation for a register. More...

#include <FltReg.h>

Inheritance diagram for GENAPI_NAMESPACE::CFltRegImpl:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 CFltRegImpl ()
 Constructor.
virtual bool GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const
virtual void SetProperty (CProperty &Property)

Protected Member Functions

virtual EDisplayNotation InternalGetDisplayNotation () const
 Get the way the float should be converted to a string.
virtual int64_t InternalGetDisplayPrecision () const
 Get the precision to be used when converting the float to a string.
virtual double InternalGetInc ()
 Get the constant increment if there is any.
virtual int64_t InternalGetLength ()
 Retrieves the Length of the register [Bytes].
virtual const double_autovector_t InternalGetListOfValidValues ()
 Get list of valid value.
virtual double InternalGetMax ()
 Get maximum value allowed.
virtual double InternalGetMin ()
 Get minimum value allowed.
virtual EInterfaceType InternalGetPrincipalInterfaceType () const
 Implementation of IBase::GetPrincipalInterfaceType()
virtual ERepresentation InternalGetRepresentation () const
 Get recommended representation.
virtual GENICAM_NAMESPACE::gcstring InternalGetUnit () const
 Get the unit.
virtual double InternalGetValue (bool Verify=false, bool IgnoreCache=false)
 Get node value.
virtual bool InternalHasInc ()
 True if the float has a constant increment.
virtual void InternalSetValue (double dblValue, bool Verify=true)
 Set node value.
void ReadReg (uint8_t *ValueBytes, bool Verify=false, bool IgnoreCache=false)
 helper to handle the register access incl. swapping
void WriteReg (uint8_t *pValueBytes, bool Verify=true)
 helper to handle the register access incl. swapping

Protected Attributes

EDisplayNotation m_DisplayNotation
 the printf format specifier used to convert the float number to a string
int64_t m_DisplayPrecision
 the precision the float is converted with to a string
EEndianess m_Endianess
 endianess of the register
ERepresentation m_Representation
 The float's reprsentation.
GENICAM_NAMESPACE::gcstring m_Unit
 the physical unit name

Detailed Description

IFloat implementation for a register.

Definition at line 45 of file FltReg.h.


Constructor & Destructor Documentation

Constructor.


Member Function Documentation

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

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

virtual EDisplayNotation GENAPI_NAMESPACE::CFltRegImpl::InternalGetDisplayNotation ( ) const [inline, protected, virtual]

Get the way the float should be converted to a string.

Definition at line 122 of file FltReg.h.

virtual int64_t GENAPI_NAMESPACE::CFltRegImpl::InternalGetDisplayPrecision ( ) const [inline, protected, virtual]

Get the precision to be used when converting the float to a string.

Definition at line 128 of file FltReg.h.

virtual double GENAPI_NAMESPACE::CFltRegImpl::InternalGetInc ( ) [inline, protected, virtual]

Get the constant increment if there is any.

Definition at line 98 of file FltReg.h.

Retrieves the Length of the register [Bytes].

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Get list of valid value.

Definition at line 90 of file FltReg.h.

virtual double GENAPI_NAMESPACE::CFltRegImpl::InternalGetMax ( ) [protected, virtual]

Get maximum value allowed.

virtual double GENAPI_NAMESPACE::CFltRegImpl::InternalGetMin ( ) [protected, virtual]

Get minimum value allowed.

Implementation of IBase::GetPrincipalInterfaceType()

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

Definition at line 54 of file FltReg.h.

virtual ERepresentation GENAPI_NAMESPACE::CFltRegImpl::InternalGetRepresentation ( ) const [inline, protected, virtual]

Get recommended representation.

Definition at line 107 of file FltReg.h.

virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CFltRegImpl::InternalGetUnit ( ) const [inline, protected, virtual]

Get the unit.

Definition at line 116 of file FltReg.h.

virtual double GENAPI_NAMESPACE::CFltRegImpl::InternalGetValue ( bool  Verify = false,
bool  IgnoreCache = false 
) [protected, virtual]

Get node value.

virtual bool GENAPI_NAMESPACE::CFltRegImpl::InternalHasInc ( ) [inline, protected, virtual]

True if the float has a constant increment.

Definition at line 83 of file FltReg.h.

virtual void GENAPI_NAMESPACE::CFltRegImpl::InternalSetValue ( double  dblValue,
bool  Verify = true 
) [protected, virtual]

Set node value.

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

helper to handle the register access incl. swapping

virtual void GENAPI_NAMESPACE::CFltRegImpl::SetProperty ( CProperty &  Property) [virtual]

Reimplemented from GENAPI_NAMESPACE::CRegisterImpl.

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

helper to handle the register access incl. swapping


Member Data Documentation

the printf format specifier used to convert the float number to a string

Definition at line 162 of file FltReg.h.

the precision the float is converted with to a string

Definition at line 165 of file FltReg.h.

endianess of the register

Definition at line 156 of file FltReg.h.

The float's reprsentation.

Definition at line 153 of file FltReg.h.

the physical unit name

Definition at line 159 of file FltReg.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 18:42:48