#include <Enumeration.h>
Public Member Functions | |
| CEnumerationImpl () | |
| Constructor. | |
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 | |
| typedef std::map < GENICAM_NAMESPACE::gcstring, IEnumEntry * > | EnumEntrySymbolicMap_t |
| the type of the map holding enum entry pointers referenced by the corresponding symbolic name | |
| typedef std::map< int64_t, IEnumEntry * > | EnumEntryIntValueMap_t |
| the type of the map holding enum entry pointers referenced by the corresponding int value | |
| EStatus | m_Status |
| the internal status of the command node | |
| EnumEntrySymbolicMap_t | m_EnumEntrySymbolicMap |
| the map holding the enum entries referenced by their symbolic name | |
| EnumEntryIntValueMap_t | m_EnumEntryIntValueMap |
| the map holding the enum entries referenced by their int value | |
| NodeList_t | m_EnumEntryList |
| a list holding pointers to the EnumEntries | |
| CIntegerPolyRef | m_Value |
| Reference to the value. | |
| int64_t | m_SelfClearingValue |
| Value which will be self cleared by the device. | |
| virtual bool | Poll (int64_t ElapsedTime) |
| Invalidates the node if the polling time has elapsed. | |
| 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. | |
| virtual void | InternalGetEntries (NodeList_t &Entries) |
| Get list of entry nodes. | |
| virtual EAccessMode | InternalGetAccessMode () const |
| Get the access mode of the node. | |
| virtual EInterfaceType | InternalGetPrincipalInterfaceType () const |
| Implementation of IBase::GetPrincipalInterfaceType() | |
| virtual GENICAM_NAMESPACE::gcstring | InternalToString (bool Verify=false, bool IgnoreCache=false) |
| Gets the symbolic value. | |
| virtual void | InternalFromString (const GENICAM_NAMESPACE::gcstring &ValueStr, bool Verify=true) |
| Sets from symbolic value. | |
| virtual void | InternalSetIntValue (int64_t Value, bool Verify=true) |
| Sets the integer value. | |
| virtual int64_t | InternalGetIntValue (bool Verify=false, bool IgnoreCache=false) |
| Gets the integer value. | |
| virtual IEnumEntry * | InternalGetEntryByName (const GENICAM_NAMESPACE::gcstring &Symbolic) |
| Get an entry node by name. | |
| virtual IEnumEntry * | InternalGetEntry (const int64_t IntValue) |
| Get an entry node by its IntValue. | |
| virtual bool | InternalIsValueCacheValid () const |
| Checks if the value comes from cache or is requested from another node. | |
| virtual EYesNo | InternalIsAccessModeCacheable () const |
| True if the AccessMode can be cached. | |
| void | InternalSetIntValue (IEnumEntry *pEnumEntry, int64_t Value, bool Verify) |
Detailed Description
Definition at line 49 of file Enumeration.h.
Member Typedef Documentation
typedef std::map<int64_t, IEnumEntry*> GENAPI_NAMESPACE::CEnumerationImpl::EnumEntryIntValueMap_t [protected] |
the type of the map holding enum entry pointers referenced by the corresponding int value
Definition at line 127 of file Enumeration.h.
typedef std::map<GENICAM_NAMESPACE::gcstring, IEnumEntry*> GENAPI_NAMESPACE::CEnumerationImpl::EnumEntrySymbolicMap_t [protected] |
the type of the map holding enum entry pointers referenced by the corresponding symbolic name
Definition at line 121 of file Enumeration.h.
typedef enum GENAPI_NAMESPACE::CEnumerationImpl::_EStatus GENAPI_NAMESPACE::CEnumerationImpl::EStatus [protected] |
possible stati of the command node
Member Enumeration Documentation
enum GENAPI_NAMESPACE::CEnumerationImpl::_EStatus [protected] |
possible stati of the command node
Definition at line 110 of file Enumeration.h.
Constructor & Destructor Documentation
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 |
||
| ) | [protected, virtual] |
Sets from symbolic value.
| virtual EAccessMode GENAPI_NAMESPACE::CEnumerationImpl::InternalGetAccessMode | ( | ) | const [protected, virtual] |
Get the access mode of the node.
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
| virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntries | ( | NodeList_t & | Entries | ) | [protected, virtual] |
Get list of entry nodes.
| virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntry | ( | const int64_t | IntValue | ) | [protected, virtual] |
Get an entry node by its IntValue.
| virtual IEnumEntry* GENAPI_NAMESPACE::CEnumerationImpl::InternalGetEntryByName | ( | const GENICAM_NAMESPACE::gcstring & | Symbolic | ) | [protected, virtual] |
Get an entry node by name.
| virtual int64_t GENAPI_NAMESPACE::CEnumerationImpl::InternalGetIntValue | ( | bool | Verify = false, |
| bool | IgnoreCache = false |
||
| ) | [protected, virtual] |
Gets the integer value.
| virtual EInterfaceType GENAPI_NAMESPACE::CEnumerationImpl::InternalGetPrincipalInterfaceType | ( | ) | const [protected, virtual] |
Implementation of IBase::GetPrincipalInterfaceType()
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
| virtual void GENAPI_NAMESPACE::CEnumerationImpl::InternalGetSymbolics | ( | StringList_t & | Symbolics | ) | [protected, virtual] |
Get the enumeration map.
| virtual EYesNo GENAPI_NAMESPACE::CEnumerationImpl::InternalIsAccessModeCacheable | ( | ) | const [protected, virtual] |
True if the AccessMode can be cached.
Reimplemented from GENAPI_NAMESPACE::CNodeImpl.
| virtual bool GENAPI_NAMESPACE::CEnumerationImpl::InternalIsValueCacheValid | ( | ) | const [protected, virtual] |
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 |
||
| ) | [protected, virtual] |
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 |
||
| ) | [protected, virtual] |
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
the map holding the enum entries referenced by their int value
Definition at line 130 of file Enumeration.h.
a list holding pointers to the EnumEntries
Definition at line 133 of file Enumeration.h.
the map holding the enum entries referenced by their symbolic name
Definition at line 124 of file Enumeration.h.
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.
Reference to the value.
Definition at line 136 of file Enumeration.h.
The documentation for this class was generated from the following file: