IFloat implementation with integrated conversion. More...
#include <Converter.h>
Public Member Functions | |
| CConverterImpl () | |
| Constructor. More... | |
| void | CheckIncreasing () |
| virtual bool | GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const |
| virtual void | SetProperty (CProperty &Property) |
| Checks if the node is terminal. More... | |
 Public Member Functions inherited from GENAPI_NAMESPACE::CNodeImpl | |
| void | add_child (CPropertyID::EProperty_ID_t PropertyID, CProperty &, INodePrivate *pNode) |
| void | add_orphan_child (CPropertyID::EProperty_ID_t PropertyID, CProperty &, INodePrivate *pNode) |
| INodeMapPrivate * | GetNodeMapPrivate () |
| Retrieves the INodeMapPrivate interface. More... | |
| void | SetParent (INodePrivate *pParent) |
| Sets a parent : CAVE : for internal use only... More... | |
| CNodeImpl () | |
| Constructor. More... | |
| virtual | ~CNodeImpl () |
| Destructor. More... | |
| virtual void | Initialize (GENAPI_NAMESPACE::INodeMapPrivate *const pNodeMap, CNodeData::ENodeType_t NodeType, NodeID_t &NodeID) |
| virtual CNodeData::ENodeType_t | GetNodeType () |
| virtual NodeID_t | GetNodeID () |
| virtual void | FinalConstruct () |
| virtual void | SetInvalid (ESetInvalidMode simMode) |
| virtual void | CollectCallbacksToFire (std::list< CNodeCallback * > &CallbacksToFire, bool allDependents=false) |
| virtual bool | IsTerminalNode () const |
| virtual void | GetTerminalNodes (GENAPI_NAMESPACE::NodeList_t &Terminals) const |
| virtual bool | Poll (int64_t ElapsedTime) |
| virtual bool | IsSelector () const |
| virtual void | GetSelectedFeatures (FeatureList_t &list) const |
| virtual void | GetSelectingFeatures (FeatureList_t &) const |
Protected Member Functions | |
| virtual EAccessMode | InternalGetAccessMode () const |
| Get the access mode of the node. More... | |
| virtual ECachingMode | InternalGetCachingMode () const |
| Get Caching Mode. More... | |
| virtual EDisplayNotation | InternalGetDisplayNotation () const |
| Get the way the float should be converted to a string. More... | |
| virtual int64_t | InternalGetDisplayPrecision () const |
| Get the precision to be used when converting the float to a string. More... | |
| virtual double | InternalGetInc () |
| Get the constant increment if there is any. More... | |
| virtual const double_autovector_t | InternalGetListOfValidValues () |
| Get list of valid value. More... | |
| virtual double | InternalGetMax () |
| virtual double | InternalGetMin () |
| virtual EInterfaceType | InternalGetPrincipalInterfaceType () const |
| Implementation of IBase::GetPrincipalInterfaceType() More... | |
| virtual ERepresentation | InternalGetRepresentation () const |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetUnit () const |
| Get the unit. More... | |
| virtual double | InternalGetValue (bool Verify=false, bool IgnoreCache=false) |
| virtual bool | InternalHasInc () |
| True if the float has a constant increment. More... | |
| virtual void | InternalSetValue (double Value, bool Verify=true) |
| bool | IsMaxUninitialized () const |
| Checks if <Max> has ben set. More... | |
| bool | IsMinUninititialized () const |
| Checks if <Min> has ben set. More... | |
| Protected Member Functions inherited from GENAPI_NAMESPACE::CNodeImpl | |
| EAccessMode | InternalGetAccessMode (IBase *pValue) const |
| Default implementation of GetAccessMode taking into account another node. More... | |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetName (bool FullQualified=false) const |
| Get node name. More... | |
| virtual GENAPI_NAMESPACE::ENameSpace | InternalGetNameSpace () const |
| Get name space. More... | |
| virtual EVisibility | InternalGetVisibility () const |
| Get the recommended visibility of the node. More... | |
| virtual void | InternalInvalidateNode (std::list< CNodeCallback * > &CallbacksToFire) |
| virtual bool | InternalIsCachable () const |
| Is the node value cachable. More... | |
| virtual int64_t | InternalGetPollingTime () const |
| recommended polling time (for not cachable nodes) More... | |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetToolTip () const |
| Get a short description of the node. More... | |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetDescription () const |
| Get a long description of the node. More... | |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetDisplayName () const |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetDeviceName () const |
| Get a name of the device. More... | |
| virtual void | InternalGetChildren (GENAPI_NAMESPACE::NodeList_t &Children, ELinkType LinkType) const |
| Get all children of the node. More... | |
| virtual CallbackHandleType | InternalRegisterCallback (CNodeCallback *pCallback) |
| Register change callback. More... | |
| virtual bool | InternalDeregisterCallback (CallbackHandleType hCallback) |
| Deregister change callback. More... | |
| virtual INodeMap * | InternalGetNodeMap () const |
| Retrieves the node map. More... | |
| virtual GENICAM_NAMESPACE::gcstring | GetEventID () const |
| Get the EventId of the node. More... | |
| virtual bool | IsStreamable () const |
| True if the node is streamable. More... | |
| virtual void | GetParents (GENAPI_NAMESPACE::NodeList_t &Parents) const |
| virtual void | GetPropertyNames (GENICAM_NAMESPACE::gcstring_vector &PropertyNames) const |
| Returns a list of the names all properties set during initialization. More... | |
| virtual bool | GetProperty (const GENICAM_NAMESPACE::gcstring &PropertyName, GENICAM_NAMESPACE::gcstring &ValueStr, GENICAM_NAMESPACE::gcstring &AttributeStr) const |
| Retrieves a property plus an additional attribute by name. More... | |
| virtual void | ImposeAccessMode (EAccessMode ImposedAccessMode) |
| Imposes an access mode to the natural access mode of the node. More... | |
| virtual void | ImposeVisibility (EVisibility ImposedVisibility) |
| Imposes a visibility to the natural visibility of the node. More... | |
| virtual INode * | GetAlias () const |
| Retrieves the a node which describes the same feature in a different way. More... | |
| virtual INode * | GetCastAlias () const |
| Retrieves the a node which describes the same feature so that it can be casted. More... | |
| virtual void | InternalCheckError () const |
| Checks for an explicitly via the <pError> element defined error. More... | |
| virtual GENICAM_NAMESPACE::gcstring | InternalGetDocuURL () const |
| Gets a URL pointing to the documentation of that feature. More... | |
| virtual bool | InternalIsDeprecated () const |
| True if the node should not be used any more. More... | |
| virtual bool | IsFeature () const |
| True if the node can be reached via category nodes from a category node named "Std::Root". More... | |
| virtual EYesNo | InternalIsAccessModeCacheable () const |
| True if the AccessMode can be cached. More... | |
| bool | IsAccessModeCached () const |
| returns true, if the AccessModeCache is valid More... | |
| GENICAM_NAMESPACE::gcstring | GetNodeType () const |
| CLock & | GetLock () const |
| Acquire central lock. More... | |
| Counter & | GetBathometer () const |
| The bathometer is a counter used to measure the depth of SetValue-like call chains. More... | |
| void | PreSetValue () |
| Invalidates all nodes which will become affected by a SetValue call into the node tree. More... | |
| void | PostSetValue (std::list< CNodeCallback * > &CallbacksToFire) |
| Fires callback on all nodes which became affected by a SetValue call into the node tree. More... | |
| GENICAM_NAMESPACE::gcstring | GetQualifiedName (GENICAM_NAMESPACE::gcstring Name, ENameSpace NameSpace) const |
| Creates the full qualified name. More... | |
| void | CacheAccessModeIfPossible (EAccessMode AccessMode) const |
| virtual bool | InternalIsValueCacheValid () const |
| Checks if the value comes from cache or is requested from another node. More... | |
Protected Attributes | |
| CFloatPolyRef | m_ConvertFrom |
| The Swiss Knife for Get. More... | |
| CFloatPolyRef | m_ConvertTo |
| The Swiss Knife for Set. More... | |
| EDisplayNotation | m_DisplayNotation |
| the printf format specifier used to convert the float number to a string More... | |
| int64_t | m_DisplayPrecision |
| the precision the float is converted with to a string More... | |
| GENICAM_NAMESPACE::gcstring | m_FormulaFrom |
| The SwissKnife formula for Get. More... | |
| GENICAM_NAMESPACE::gcstring | m_FormulaTo |
| The SwissKnife formula for Set. More... | |
| GENICAM_NAMESPACE::gcstring | m_InputName |
| The Name of the external Variable. More... | |
| EYesNo | m_IsLinear |
| indicates if the conversion is linear More... | |
| ERepresentation | m_Representation |
| recommended representation of the value More... | |
| ESlope | m_Slope |
| indicates if the formula is strictly monotonous increasing or decreating More... | |
| GENICAM_NAMESPACE::gcstring | m_Unit |
| the physical unit name More... | |
| CFloatPolyRef | m_Value |
| Reference to the value. More... | |
| Protected Attributes inherited from GENAPI_NAMESPACE::CNodeImpl | |
| EYesNo | m_ExposeStatic |
| NodeID_t | m_NodeID |
| The node's ID. More... | |
| CNodeData::ENodeType_t | m_NodeTypeEnum |
| UserData_t | m_pUserData |
| Storage of user defined data. Ownership remains by the user!. Use IUserData interface to access the data. More... | |
| NodePrivateVector_t | m_Parents |
| All nodes for which this node is at least a DependecyChild. More... | |
| NodePrivateVector_t | m_ReadingChildren |
| all nodes which can be read from For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies More... | |
| NodePrivateVector_t | m_WritingChildren |
| all nodes which can write a value further down the node stack For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies More... | |
| NodePrivateVector_t | m_InvalidatingChildren |
| All directly connected nodes which invalidate this node For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies. More... | |
| NodePrivateVector_t | m_AllDependingNodes |
| All directly or indirectly connected nodes which are invalidated by this nodes (i.e. which are dependent on this node) For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies. More... | |
| NodePrivateVector_t | m_AllTerminalNodes |
| All indirectly connected terminal nodes For details see GenICam wiki : GenApi/SoftwareArchitecture/NodeDependencies. More... | |
| NodePrivateVector_t | m_VariableChildren |
| All node use as variable by this node. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pAccessLog |
| Logger for messages concerning the AccessMode. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pValueLog |
| Logger for messages concerning the getting and setting values. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pRangeLog |
| Logger for messages concerning the range check. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pPortLog |
| Logger for messages concerning the port access. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pCacheLog |
| Logger for messages concerning the caching access. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pPreProcLog |
| Logger for things done during pre-processing of the node map, e.g. determining dependencies. More... | |
| GENICAM_NAMESPACE::ILogger * | m_pMiscLog |
| Logger for messages concerning miscellaneous access which does not fit to the other categories. More... | |
| GENICAM_NAMESPACE::gcstring | m_Name |
| The name of the node. More... | |
| GENICAM_NAMESPACE::gcstring | m_Extension |
| The metadata from the extension. More... | |
| ENameSpace | m_NameSpace |
| The namespace of the node. More... | |
| GENICAM_NAMESPACE::gcstring | m_DeviceName |
| The device name of the node tree. More... | |
| GENICAM_NAMESPACE::gcstring | m_DisplayName |
| The display name string of the node. More... | |
| GENICAM_NAMESPACE::gcstring | m_ToolTip |
| The ToolTip for the node. More... | |
| GENICAM_NAMESPACE::gcstring | m_Description |
| The Description of the node. More... | |
| EVisibility | m_Visibility |
| recommended visibility; More... | |
| CBooleanPolyRef | m_IsImplemented |
| Reference to a Node, which indicates if the node is implemented. More... | |
| CBooleanPolyRef | m_IsAvailable |
| Reference to a Node, which indicates if the node is available. More... | |
| CBooleanPolyRef | m_IsLocked |
| Reference to a Node, which indicates if the node is locked (i.e. not writable) More... | |
| CBooleanPolyRef | m_BlockPolling |
| Reference to a Node, which indicates if the node is not cached. More... | |
| IEnumeration * | m_pError |
| Pointer to a Error class. More... | |
| INode * | m_pAlias |
| Pointer to a Node, which describes the same feature as this one. More... | |
| INode * | m_pCastAlias |
| Pointer to a Node, which describes the same feature as this one so that it can be casted. More... | |
| ECachingMode | m_CachingMode |
| indicates that the node has changed More... | |
| FeatureList_t | m_Selected |
| List of selected features. More... | |
| FeatureList_t | m_Selecting |
| List of selecting features. More... | |
| GENICAM_NAMESPACE::gcstring | m_EventID |
| The EventID. More... | |
| EYesNo | m_IsStreamable |
| indicates if the node is streamable More... | |
| EAccessMode | m_ImposedAccessMode |
| Access mode imposed on the natural access mode of the node. More... | |
| EVisibility | m_ImposedVisibility |
| Visibility imposed to the natural visibility of the node. More... | |
| int64_t | m_PollingTime |
| recommended polling time in [ms] More... | |
| ETerminalPropagationState | m_propagationState |
| Current state for propagating terminals. More... | |
| NodeList_t | m_Invalidators |
| List of references to nodes which may invalidate this node. More... | |
| GENICAM_NAMESPACE::gcstring | m_DocuURL |
| A URL pointing or the documentation of this featrues. More... | |
| EYesNo | m_IsDeprecated |
| indicates that the feature should not be used any more More... | |
| GENICAM_NAMESPACE::gcstring_vector | m_PropertyNames |
| Helper: A list of all properties belonging to this node. More... | |
| EYesNo | m_IsFeature |
| indicates that the node is a feature that is reachable from the Root node via categories More... | |
| INodeMapPrivate * | m_pNodeMap |
| Pointer to the node map. More... | |
| int64_t | m_ElapsedTime |
| time elapsed since the last poll More... | |
| bool | m_DontDeleteThisCache |
| indicates that the cache has been filled and should not be cleared at the end of the operation More... | |
| bool | m_TerminalNodeWritten |
| indicates that this terminal node was written and not yet invalidated. More... | |
| std::list< CNodeCallback * > | m_Callbacks |
| List of callbacks. More... | |
| ECachingMode | m_CachingModeCache |
| stores the cached value of the CachingMode More... | |
| EAccessMode | m_AccessModeCache |
| cache access mode More... | |
| bool | m_ValueCacheValid |
| true if the value cache is valid More... | |
| bool | m_ListOfValidValuesCacheValid |
| true if the list of valid value is cached More... | |
| EYesNo | m_AccessModeCacheability |
| indicates if the AccessMode is cacheable More... | |
Additional Inherited Members | |
| Protected Types inherited from GENAPI_NAMESPACE::CNodeImpl | |
| enum | ETerminalPropagationState { eNotVisited, eBeingVisited, eTerminalPropagationDone } |
| States when propagating terminals. More... | |
| typedef AutoLock | Lock |
| shortcut for the lock type More... | |
IFloat implementation with integrated conversion.
Works like a Float, but has integrated conversion formulas by which the values are converted before writing and after reading.
The Representation may be defined using one of the values in ERepresentation. The default is _UndefinedRepresentation.
Definition at line 58 of file Converter.h.
| GENAPI_NAMESPACE::CConverterImpl::CConverterImpl | ( | ) |
Constructor.
| void GENAPI_NAMESPACE::CConverterImpl::CheckIncreasing | ( | ) |
|
virtual |
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
|
protectedvirtual |
Get the access mode of the node.
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
|
protectedvirtual |
Get Caching Mode.
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
|
inlineprotectedvirtual |
Get the way the float should be converted to a string.
Definition at line 118 of file Converter.h.
|
inlineprotectedvirtual |
Get the precision to be used when converting the float to a string.
Definition at line 127 of file Converter.h.
|
protectedvirtual |
Get the constant increment if there is any.
|
protectedvirtual |
Get list of valid value.
|
protectedvirtual |
|
protectedvirtual |
|
inlineprotectedvirtual |
Implementation of IBase::GetPrincipalInterfaceType()
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
Definition at line 103 of file Converter.h.
|
inlineprotectedvirtual |
Definition at line 91 of file Converter.h.
|
inlineprotectedvirtual |
Get the unit.
Definition at line 109 of file Converter.h.
|
protectedvirtual |
|
protectedvirtual |
True if the float has a constant increment.
|
protectedvirtual |
|
protected |
Checks if <Max> has ben set.
|
protected |
Checks if <Min> has ben set.
|
virtual |
Checks if the node is terminal.
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
|
protected |
The Swiss Knife for Get.
Definition at line 178 of file Converter.h.
|
protected |
The Swiss Knife for Set.
Definition at line 175 of file Converter.h.
|
protected |
the printf format specifier used to convert the float number to a string
Definition at line 190 of file Converter.h.
|
protected |
the precision the float is converted with to a string
Definition at line 193 of file Converter.h.
|
protected |
The SwissKnife formula for Get.
Definition at line 169 of file Converter.h.
|
protected |
The SwissKnife formula for Set.
Definition at line 166 of file Converter.h.
|
protected |
The Name of the external Variable.
Definition at line 172 of file Converter.h.
|
protected |
indicates if the conversion is linear
Definition at line 199 of file Converter.h.
|
mutableprotected |
recommended representation of the value
Definition at line 184 of file Converter.h.
|
protected |
indicates if the formula is strictly monotonous increasing or decreating
Definition at line 196 of file Converter.h.
|
protected |
the physical unit name
Definition at line 187 of file Converter.h.
|
protected |
Reference to the value.
Definition at line 181 of file Converter.h.
