|
| void SPINNAKER_API | SET_GUID (SPIN_GUID &name, uint32_t l, uint16_t w1, uint16_t w2, uint8_t b1, uint8_t b2, uint8_t b3, uint8_t b4, uint8_t b5, uint8_t b6, uint8_t b7, uint8_t b8) |
| |
| virtual void | operator= (bool Value) |
| | Set node value.
|
| |
| virtual bool | GetValue (bool Verify=false, bool IgnoreCache=false) const =0 |
| | Get node value.
|
| |
| virtual bool | operator() () const |
| | Get node value.
|
| |
| virtual EYesNo | CacheChunkData () const =0 |
| | Indicates if the chunk a adapter must hold a cached version of the chunk data.
|
| |
| virtual bool | IsDone (bool Verify=true)=0 |
| | Query whether the command is executed.
|
| |
| virtual GenICam::gcstring | GetVendorName ()=0 |
| | Get the vendor name.
|
| |
| virtual GenICam::gcstring | GetToolTip ()=0 |
| | Get tool tip.
|
| |
| virtual GenICam::gcstring | GetStandardNameSpace ()=0 |
| | Get the standard name space.
|
| |
| virtual void | GetGenApiVersion (GenICam::Version_t &Version, uint16_t &Build)=0 |
| | Get the version of the DLL's GenApi implementation.
|
| |
| virtual void | GetSchemaVersion (GenICam::Version_t &Version)=0 |
| | Get the schema version number.
|
| |
| virtual void | GetDeviceVersion (GenICam::Version_t &Version)=0 |
| | Get the version of the device description file.
|
| |
| virtual GenICam::gcstring | GetProductGuid ()=0 |
| | Get the Guid describing the product.
|
| |
| virtual GenICam::gcstring | GetVersionGuid ()=0 |
| | Get the Guid describing the product version.
|
| |
| virtual GenICam::gcstring | GetSymbolic () const =0 |
| | Get symbolic enum value.
|
| |
| virtual double | GetNumericValue ()=0 |
| | Get double number associated with the entry.
|
| |
| virtual bool | IsSelfClearing ()=0 |
| | Indicates if the corresponding EnumEntry is self clearing.
|
| |
| virtual void | GetEntries (NodeList_t &Entries)=0 |
| | Get list of entry nodes.
|
| |
| virtual IEnumeration & | operator= (const GenICam::gcstring &ValueStr)=0 |
| | Set string node value.
|
| |
| virtual void | SetIntValue (int64_t Value, bool Verify=true)=0 |
| | Set integer node value.
|
| |
| virtual GenICam::gcstring | operator* ()=0 |
| | Get string node value.
|
| |
| virtual int64_t | GetIntValue (bool Verify=false, bool IgnoreCache=false)=0 |
| | Get integer node value.
|
| |
| virtual IEnumEntry * | GetEntryByName (const GenICam::gcstring &Symbolic)=0 |
| | Get an entry node by name.
|
| |
| virtual IEnumEntry * | GetEntry (const int64_t IntValue)=0 |
| | Get an entry node by its IntValue.
|
| |
| virtual IEnumEntry * | GetCurrentEntry (bool Verify=false, bool IgnoreCache=false)=0 |
| | Get the current entry.
|
| |
| virtual IEnumeration & | operator= (EnumT Value)=0 |
| | Set node value.
|
| |
| virtual IEnumEntry * | GetEntry (const EnumT Value)=0 |
| | returns the EnumEntry object belonging to the Value
|
| |
| virtual IFloat & | operator= (double Value)=0 |
| | Set node value.
|
| |
| virtual double | GetMin ()=0 |
| | Get minimum value allowed.
|
| |
| virtual double | GetMax ()=0 |
| | Get maximum value allowed.
|
| |
| virtual bool | HasInc ()=0 |
| | True if the float has a constant increment.
|
| |
| virtual EIncMode | GetIncMode ()=0 |
| | Get increment mode.
|
| |
| virtual double | GetInc ()=0 |
| | Get the constant increment if there is any.
|
| |
| virtual double_autovector_t | GetListOfValidValues (bool bounded=true)=0 |
| | Get list of valid value.
|
| |
| virtual ERepresentation | GetRepresentation ()=0 |
| | Get recommended representation.
|
| |
| virtual GenICam::gcstring | GetUnit () const =0 |
| | Get the physical unit name.
|
| |
| virtual EDisplayNotation | GetDisplayNotation () const =0 |
| | Get the way the float should be converted to a string.
|
| |
| virtual int64_t | GetDisplayPrecision () const =0 |
| | Get the precision to be used when converting the float to a string.
|
| |
| virtual void | ImposeMin (double Value)=0 |
| | Restrict minimum value.
|
| |
| virtual void | ImposeMax (double Value)=0 |
| | Restrict maximum value.
|
| |
| virtual IInteger & | operator= (int64_t Value)=0 |
| | Set node value.
|
| |
| virtual void | ImposeMin (int64_t Value)=0 |
| | Restrict minimum value.
|
| |
| virtual void | ImposeMax (int64_t Value)=0 |
| | Restrict maximum value.
|
| |
| virtual GenApi::ENameSpace | GetNameSpace () const =0 |
| | Get name space.
|
| |
| virtual EVisibility | GetVisibility () const =0 |
| | Get the recommended visibility of the node.
|
| |
| virtual void | InvalidateNode ()=0 |
| | Indicates that the node's value may have changed.
|
| |
| virtual bool | IsCachable () const =0 |
| | Is the node value cacheable.
|
| |
| virtual EYesNo | IsAccessModeCacheable () const =0 |
| | True if the AccessMode can be cached.
|
| |
| virtual ECachingMode | GetCachingMode () const =0 |
| | Get Caching Mode.
|
| |
| virtual int64_t | GetPollingTime () const =0 |
| | recommended polling time (for non-cacheable nodes)
|
| |
| virtual GenICam::gcstring | GetDescription () const =0 |
| | Get a long description of the node.
|
| |
| virtual GenICam::gcstring | GetDisplayName () const =0 |
| | Get a name string for display.
|
| |
| virtual GenICam::gcstring | GetDeviceName () const =0 |
| | Get a name of the device.
|
| |
| virtual void | GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const =0 |
| | Get all nodes this node directly depends on.
|
| |
| virtual void | GetParents (GenApi::NodeList_t &Parents) const =0 |
| | Gets all nodes this node is directly depending on.
|
| |
| virtual void | GetLockNodes (GenApi::NodeList_t &LockNodes) const =0 |
| | Gets all nodes which can directly lock this node.
|
| |
| virtual CallbackHandleType | RegisterCallback (CNodeCallback *pCallback)=0 |
| | Register change callback Takes ownership of the CNodeCallback object.
|
| |
| virtual bool | DeregisterCallback (CallbackHandleType hCallback)=0 |
| | De register change callback Destroys CNodeCallback object.
|
| |
| virtual INodeMap * | GetNodeMap () const =0 |
| | Retrieves the central node map.
|
| |
| virtual GenICam::gcstring | GetEventID () const =0 |
| | Get the EventId of the node.
|
| |
| virtual bool | IsStreamable () const =0 |
| | True if the node is streamable.
|
| |
| virtual void | GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const =0 |
| | Returns a list of the names all properties set during initialization.
|
| |
| virtual bool | GetProperty (const GenICam::gcstring &PropertyName, GenICam::gcstring &ValueStr, GenICam::gcstring &AttributeStr)=0 |
| | Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters.
|
| |
| virtual void | ImposeAccessMode (EAccessMode ImposedAccessMode)=0 |
| | Imposes an access mode to the natural access mode of the node.
|
| |
| virtual void | ImposeVisibility (EVisibility ImposedVisibility)=0 |
| | Imposes a visibility to the natural visibility of the node.
|
| |
| virtual INode * | GetAlias () const =0 |
| | Retrieves the a node which describes the same feature in a different way.
|
| |
| virtual INode * | GetCastAlias () const =0 |
| | Retrieves the a node which describes the same feature so that it can be casted.
|
| |
| virtual GenICam::gcstring | GetDocuURL () const =0 |
| | Gets a URL pointing to the documentation of that feature.
|
| |
| virtual bool | IsDeprecated () const =0 |
| | True if the node should not be used any more.
|
| |
| virtual EInterfaceType | GetPrincipalInterfaceType () const =0 |
| | Get the type of the main interface of a node.
|
| |
| virtual bool | IsFeature () const =0 |
| | True if the node can be reached via category nodes from a category node named "Root".
|
| |
| virtual bool | operator== (int nullPtr) const =0 |
| |
| virtual bool | operator!= (int nullPtr) const =0 |
| |
| bool | IsReadable (EAccessMode AccessMode) |
| | Tests if readable.
|
| |
| bool | IsReadable (const IBase *p) |
| | Checks if a node is readable.
|
| |
| bool | IsReadable (const IBase &r) |
| | Checks if a node is readable.
|
| |
| bool | IsWritable (EAccessMode AccessMode) |
| | Tests if writable.
|
| |
| bool | IsWritable (const IBase *p) |
| | Checks if a node is writable.
|
| |
| bool | IsWritable (const IBase &r) |
| | Checks if a node is writable.
|
| |
| bool | IsImplemented (EAccessMode AccessMode) |
| | Tests if implemented.
|
| |
| bool | IsImplemented (const IBase *p) |
| | Checks if a node is implemented.
|
| |
| bool | IsImplemented (const IBase &r) |
| | Checks if a node is implemented.
|
| |
| bool | IsAvailable (EAccessMode AccessMode) |
| | Tests if available.
|
| |
| bool | IsAvailable (const IBase *p) |
| | Checks if a node is available.
|
| |
| bool | IsAvailable (const IBase &r) |
| | Checks if a node is available.
|
| |
| EAccessMode | Combine (EAccessMode Peter, EAccessMode Paul) |
| | Computes which access mode the two guards allow together.
|
| |
| bool | IsVisible (EVisibility Visibility, EVisibility MaxVisiblity) |
| | Tests Visibility CAVE : this relies on the EVisibility enum's coding.
|
| |
| EVisibility | Combine (EVisibility Peter, EVisibility Paul) |
| | Computes which visibility the two guards allow together.
|
| |
| bool | IsCacheable (ECachingMode CachingMode) |
| | Tests Cacheability.
|
| |
| ECachingMode | Combine (ECachingMode Peter, ECachingMode Paul) |
| | Computes which CachingMode results from a combination.
|
| |
| virtual INode * | GetNode (const GenICam::gcstring &Name) const =0 |
| | Retrieves the node from the central map by Name.
|
| |
| virtual void | InvalidateNodes () const =0 |
| | Invalidates all nodes.
|
| |
| virtual bool | Connect (IPort *pPort, const GenICam::gcstring &PortName) const =0 |
| | Connects a port to a port node with given name.
|
| |
| virtual bool | Connect (IPort *pPort) const =0 |
| | Connects a port to the standard port "Device".
|
| |
| virtual void | Poll (int64_t ElapsedTime)=0 |
| | Fires nodes which have a polling time.
|
| |
| virtual CLock & | GetLock () const =0 |
| | Returns the lock which guards the node map.
|
| |
| virtual uint64_t | GetNumNodes () const =0 |
| | Get the number of nodes in the map.
|
| |
| virtual void | LoadXMLFromFile (const GenICam::gcstring &FileName)=0 |
| | Loads an XML from a file.
|
| |
| virtual void | LoadXMLFromFileInject (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectFileName)=0 |
| | Loads an XML from a file with injection.
|
| |
| virtual void | LoadXMLFromString (const GenICam::gcstring &XMLData)=0 |
| | Loads an XML from a string.
|
| |
| virtual void | LoadXMLFromStringInject (const GenICam::gcstring &TargetXMLData, const GenICam::gcstring &InjectXMLData)=0 |
| | Loads an XML from a string with injection.
|
| |
| virtual void | PreprocessXMLFromFile (const GenICam::gcstring &XMLFileName, const GenICam::gcstring &StyleSheetFileName, const GenICam::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0 |
| | Loads an XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file.
|
| |
| virtual void | MergeXMLFiles (const GenICam::gcstring &TargetFileName, const GenICam::gcstring &InjectedFileName, const GenICam::gcstring &OutputFileName)=0 |
| | Injects an XML file into a target file.
|
| |
| virtual void | ExtractIndependentSubtree (const GenICam::gcstring &XMLData, const GenICam::gcstring &InjectXMLData, const GenICam::gcstring &SubTreeRootNodeName, GenICam::gcstring &ExtractedSubtree)=0 |
| | Extract independent subtree.
|
| |
| virtual void | GetSupportedSchemaVersions (GenICam::gcstring_vector &SchemaVersions)=0 |
| | Gets a list of supported schema versions.
|
| |
| virtual void | LoadXMLFromZIPFile (const GenICam::gcstring &ZipFileName)=0 |
| | Loads an XML from a ZIP file.
|
| |
| virtual void | LoadXMLFromZIPData (const void *zipData, size_t zipSize)=0 |
| | Loads an XML from a ZIP data buffer.
|
| |
| virtual void | PreprocessXMLFromZIPFile (const GenICam::gcstring &XMLFileName, const GenICam::gcstring &StyleSheetFileName, const GenICam::gcstring &OutputFileName, const uint32_t XMLValidation=xvDefault)=0 |
| | Loads a Zipped XML, checks it for correctness, pre-processes it, caches it, and optionally applies a style sheet, and optionally writes it to a file.
|
| |
| virtual void | Write (const void *pBuffer, int64_t Address, int64_t Length)=0 |
| | Writes a chunk of bytes to the port.
|
| |
| virtual EYesNo | GetSwapEndianess ()=0 |
| | Determines if the port adapter must perform an endianess swap.
|
| |
| virtual void | Replay (IPort *pPort)=0 |
| | Replays the write command to the given port interface.
|
| |
| virtual void | SetCookie (const int64_t Value)=0 |
| | Sets a cookie in case the port implementation want to cache a command list.
|
| |
| virtual int64_t | GetCookie ()=0 |
| | Gets the cookie a port implementation may have set for caching a command list.
|
| |
| virtual void | StopRecording ()=0 |
| | Stops recording.
|
| |
| virtual void | Get (uint8_t *pBuffer, int64_t Length, bool Verify=false, bool IgnoreCache=false)=0 |
| | Fills a buffer with the register's contents.
|
| |
| virtual int64_t | GetLength ()=0 |
| | Retrieves the Length of the register [Bytes].
|
| |
| virtual int64_t | GetAddress ()=0 |
| | Retrieves the Address of the register.
|
| |
| virtual void | GetSelectedFeatures (FeatureList_t &) const =0 |
| | retrieve the group of selected features
|
| |
| virtual void | GetSelectingFeatures (FeatureList_t &) const =0 |
| | retrieve the group of features selecting this node
|
| |
| virtual bool | SetNext (bool Tick=true)=0 |
| | Sets digit to next value.
|
| |
| virtual void | Restore ()=0 |
| | Restores the selectors' values found at creation.
|
| |
| virtual GenICam::gcstring | ToString ()=0 |
| | Returns a string representation of the digit.
|
| |
| virtual void | GetSelectorList (FeatureList_t &SelectorList, bool Incremental=false)=0 |
| | Retrieves an ordered list of selectors.
|
| |
| virtual int64_t | GetMaxLength ()=0 |
| | Retrieves the maximum length of the string in bytes.
|
| |
| virtual GenICam::gcstring | ToString (bool Verify=false, bool IgnoreCache=false)=0 |
| | Get content of the node as string.
|
| |
| virtual void | FromString (const GenICam::gcstring &ValueStr, bool Verify=true)=0 |
| | Set content of the node as string.
|
| |
| virtual bool | IsValueCacheValid () const =0 |
| | Checks if the value comes from cache or is requested from another node.
|
| |
| template<class Function > |
| CNodeCallback * | make_NodeCallback (INode *pNode, Function function, ECallbackType CallbackType) |
| | make a new callback object for C functions
|
| |
| template<class Function > |
| intptr_t | Register (INode *pNode, Function f, ECallbackType CallbackType=cbPostInsideLock) |
| | Register a C-function as a callback.
|
| |
| template<class Client , class Member > |
| CNodeCallback * | make_NodeCallback (INode *pNode, Client &client, Member member, ECallbackType CallbackType) |
| | make a new callback object for member functions
|
| |
| template<class Client , class Member > |
| intptr_t | Register (INode *pNode, Client &c, Member m, ECallbackType CallbackType=cbPostInsideLock) |
| | Register a C++-member function a callback.
|
| |
| SPINNAKER_API void | Deregister (GenApi::CallbackHandleType pCallbackInfo) |
| | Unregistering callback by handle.
|
| |
| virtual void | PersistFeature (IValue &item)=0 |
| | Stores a feature.
|
| |
| SPINNAKER_API std::istream & | EatComments (std::istream &is) |
| | Helper function ignoring lines starting with comment character '#'.
|
| |
| SPINNAKER_API std::istream & | operator>> (std::istream &is, CFeatureBag &FeatureBag) |
| | Reads in persistent data from a stream.
|
| |
| SPINNAKER_API std::ostream & | operator<< (std::ostream &os, const CFeatureBag &FeatureBag) |
| | writes out persistent data to a stream
|
| |
| template<class T , class B > |
| bool | IsReadable (const Spinnaker::GenApi::CPointer< T, B > &ptr) |
| | Checks if a node is readable.
|
| |
| template<class T , class B > |
| bool | IsWritable (const Spinnaker::GenApi::CPointer< T, B > &ptr) |
| | Checks if a node is Writable.
|
| |
| template<class T , class B > |
| bool | IsImplemented (const Spinnaker::GenApi::CPointer< T, B > &ptr) |
| | Checks if a node is Implemented.
|
| |
| template<class T , class B > |
| bool | IsAvailable (const Spinnaker::GenApi::CPointer< T, B > &ptr) |
| | Checks if a node is Available.
|
| |
| GenICam::gcstring | GetInterfaceName (IBase *pBase) |
| | Returns the name of the main interface as string DEPRICATED, use IBase::GetPrincipalInterfaceType() instead.
|
| |
| virtual void | SetNumEnums (int NumEnums)=0 |
| | sets the number of enum values
|
| |
