Public Member Functions | List of all members
GENAPI_NAMESPACE::CEnumerationImpl Class Reference

#include <Enumeration.h>

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

Public Member Functions

 CEnumerationImpl ()
 Constructor. 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)
 
INodeMapPrivateGetNodeMapPrivate ()
 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 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 IsSelector () const
 
virtual void GetSelectedFeatures (FeatureList_t &list) const
 
virtual void GetSelectingFeatures (FeatureList_t &) const
 

INode implementation

enum  _EStatus { statusUninitialized, statusIdle, statusBusy }
 possible stati of the command node More...
 
typedef enum GENAPI_NAMESPACE::CEnumerationImpl::_EStatus EStatus
 possible stati of the command node More...
 
typedef std::map< GENICAM_NAMESPACE::gcstring, IEnumEntry * > EnumEntrySymbolicMap_t
 the type of the map holding enum entry pointers referenced by the corresponding symbolic name More...
 
typedef std::map< int64_t, IEnumEntry * > EnumEntryIntValueMap_t
 the type of the map holding enum entry pointers referenced by the corresponding int value More...
 
EStatus m_Status
 the internal status of the command node More...
 
EnumEntrySymbolicMap_t m_EnumEntrySymbolicMap
 the map holding the enum entries referenced by their symbolic name More...
 
EnumEntryIntValueMap_t m_EnumEntryIntValueMap
 the map holding the enum entries referenced by their int value More...
 
NodeList_t m_EnumEntryList
 a list holding pointers to the EnumEntries More...
 
CIntegerPolyRef m_Value
 Reference to the value. More...
 
int64_t m_SelfClearingValue
 Value which will be self cleared by the device. More...
 
virtual bool Poll (int64_t ElapsedTime)
 Invalidates the node if the polling time has elapsed. More...
 
virtual void FinalConstruct ()
 
virtual void SetProperty (CProperty &Property)
 
virtual bool GetProperty (CNodeDataMap *pNodeDataMap, CPropertyID::EProperty_ID_t PropertyID, CNodeData::PropertyVector_t &PropertyList) const
 
virtual void InternalGetSymbolics (StringList_t &Symbolics)
 Get the enumeration map. More...
 
virtual void InternalGetEntries (NodeList_t &Entries)
 Get list of entry nodes. More...
 
virtual EAccessMode InternalGetAccessMode () const
 Get the access mode of the node. More...
 
virtual EInterfaceType InternalGetPrincipalInterfaceType () const
 Implementation of IBase::GetPrincipalInterfaceType() More...
 
virtual GENICAM_NAMESPACE::gcstring InternalToString (bool Verify=false, bool IgnoreCache=false)
 Gets the symbolic value. More...
 
virtual void InternalFromString (const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true)
 Sets from symbolic value. More...
 
virtual void InternalSetIntValue (int64_t Value, bool Verify=true)
 Sets the integer value. More...
 
virtual int64_t InternalGetIntValue (bool Verify=false, bool IgnoreCache=false)
 Gets the integer value. More...
 
virtual IEnumEntryInternalGetEntryByName (const GENICAM_NAMESPACE::gcstring &Symbolic)
 Get an entry node by name. More...
 
virtual IEnumEntryInternalGetEntry (const int64_t IntValue)
 Get an entry node by its IntValue. More...
 
virtual bool InternalIsValueCacheValid () const
 Checks if the value comes from cache or is requested from another node. More...
 
virtual EYesNo InternalIsAccessModeCacheable () const
 True if the AccessMode can be cached. More...
 
void InternalSetIntValue (IEnumEntry *pEnumEntry, int64_t Value, bool Verify)
 

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...
 
- 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 ECachingMode InternalGetCachingMode () const
 Get Caching Mode. 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 INodeMapInternalGetNodeMap () 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 INodeGetAlias () const
 Retrieves the a node which describes the same feature in a different way. More...
 
virtual INodeGetCastAlias () 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...
 
bool IsAccessModeCached () const
 returns true, if the AccessModeCache is valid More...
 
GENICAM_NAMESPACE::gcstring GetNodeType () const
 
CLockGetLock () const
 Acquire central lock. More...
 
CounterGetBathometer () 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
 
- 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. 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. 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...
 
LOG4CPP_NS::Categorym_pAccessLog
 Logger for messages concerning the AccessMode. More...
 
LOG4CPP_NS::Categorym_pValueLog
 Logger for messages concerning the getting and setting values. More...
 
LOG4CPP_NS::Categorym_pRangeLog
 Logger for messages concerning the range check. More...
 
LOG4CPP_NS::Categorym_pPortLog
 Logger for messages concerning the port access. More...
 
LOG4CPP_NS::Categorym_pCacheLog
 Logger for messages concerning the caching access. More...
 
LOG4CPP_NS::Categorym_pPreProcLog
 Logger for things done during pre-processing of the node map, e.g. determining dependencies. More...
 
LOG4CPP_NS::Categorym_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...
 
IEnumerationm_pError
 Pointer to a Error class. More...
 
INodem_pAlias
 Pointer to a Node, which describes the same feature as this one. More...
 
INodem_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...
 
INodeMapPrivatem_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...
 
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...
 

Detailed Description

Definition at line 49 of file Enumeration.h.

Member Typedef Documentation

the type of the map holding enum entry pointers referenced by the corresponding int value

Definition at line 127 of file Enumeration.h.

the type of the map holding enum entry pointers referenced by the corresponding symbolic name

Definition at line 121 of file Enumeration.h.

possible stati of the command node

Member Enumeration Documentation

possible stati of the command node

Enumerator
statusUninitialized 
statusIdle 
statusBusy 

Definition at line 110 of file Enumeration.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CEnumerationImpl::CEnumerationImpl ( )

Constructor.

Member Function Documentation

virtual void GENAPI_NAMESPACE::CEnumerationImpl::FinalConstruct ( )
virtual

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

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

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalFromString ( const GENICAM_NAMESPACE::gcstring ValueStr,
bool  Verify = true 
)
protectedvirtual

Sets from symbolic value.

virtual EAccessMode GENAPI_NAMESPACE::CEnumerationImpl::InternalGetAccessMode ( ) const
protectedvirtual

Get the access mode of the node.

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntries ( NodeList_t Entries)
protectedvirtual

Get list of entry nodes.

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntry ( const int64_t  IntValue)
protectedvirtual

Get an entry node by its IntValue.

virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntryByName ( const GENICAM_NAMESPACE::gcstring Symbolic)
protectedvirtual

Get an entry node by name.

virtual int64_t GENAPI_NAMESPACE::CEnumerationImpl::InternalGetIntValue ( bool  Verify = false,
bool  IgnoreCache = false 
)
protectedvirtual

Gets the integer value.

virtual EInterfaceType GENAPI_NAMESPACE::CEnumerationImpl::InternalGetPrincipalInterfaceType ( ) const
protectedvirtual

Implementation of IBase::GetPrincipalInterfaceType()

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalGetSymbolics ( StringList_t Symbolics)
protectedvirtual

Get the enumeration map.

virtual EYesNo GENAPI_NAMESPACE::CEnumerationImpl::InternalIsAccessModeCacheable ( ) const
protectedvirtual

True if the AccessMode can be cached.

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual bool GENAPI_NAMESPACE::CEnumerationImpl::InternalIsValueCacheValid ( ) const
protectedvirtual

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

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalSetIntValue ( int64_t  Value,
bool  Verify = true 
)
protectedvirtual

Sets the integer value.

void GENAPI_NAMESPACE::CEnumerationImpl::InternalSetIntValue ( IEnumEntry pEnumEntry,
int64_t  Value,
bool  Verify 
)
private
virtual GENICAM_NAMESPACE::gcstring GENAPI_NAMESPACE::CEnumerationImpl::InternalToString ( bool  Verify = false,
bool  IgnoreCache = false 
)
protectedvirtual

Gets the symbolic value.

virtual bool GENAPI_NAMESPACE::CEnumerationImpl::Poll ( int64_t  ElapsedTime)
virtual

Invalidates the node if the polling time has elapsed.

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

virtual void GENAPI_NAMESPACE::CEnumerationImpl::SetProperty ( CProperty &  Property)
virtual

Reimplemented from GENAPI_NAMESPACE::CNodeImpl.

Member Data Documentation

EnumEntryIntValueMap_t GENAPI_NAMESPACE::CEnumerationImpl::m_EnumEntryIntValueMap
protected

the map holding the enum entries referenced by their int value

Definition at line 130 of file Enumeration.h.

NodeList_t GENAPI_NAMESPACE::CEnumerationImpl::m_EnumEntryList
protected

a list holding pointers to the EnumEntries

Definition at line 133 of file Enumeration.h.

EnumEntrySymbolicMap_t GENAPI_NAMESPACE::CEnumerationImpl::m_EnumEntrySymbolicMap
protected

the map holding the enum entries referenced by their symbolic name

Definition at line 124 of file Enumeration.h.

int64_t GENAPI_NAMESPACE::CEnumerationImpl::m_SelfClearingValue
protected

Value which will be self cleared by the device.

Definition at line 139 of file Enumeration.h.

EStatus GENAPI_NAMESPACE::CEnumerationImpl::m_Status
protected

the internal status of the command node

Definition at line 118 of file Enumeration.h.

CIntegerPolyRef GENAPI_NAMESPACE::CEnumerationImpl::m_Value
protected

Reference to the value.

Definition at line 136 of file Enumeration.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 19:10:55