Spinnaker C++
2.6.0.0
Classes | Typedefs | Enumerations | Functions | Variables
Spinnaker::GenApi Namespace Reference

Classes

class  int64_autovector_t
 Vector of integers with reference counting. More...
 
class  double_autovector_t
 Vector of doubles with reference counting. More...
 
class  BooleanNode
 Interface for string properties. More...
 
class  CategoryNode
 Interface for string properties. More...
 
class  CChunkAdapter
 Connects a chunked buffer to a node map. More...
 
class  CChunkAdapterDcam
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterGeneric
 
class  CChunkAdapterGEV
 Connects a chunked DCAM buffer to a node map. More...
 
class  CChunkAdapterU3V
 Connects a chunked U3V buffer to a node map. More...
 
class  CChunkPort
 Port attachable to a chunk in a buffer. More...
 
class  CommandNode
 Interface for string properties. More...
 
class  Counter
 Definition of a simple Counter class. More...
 
class  ESignClass
 Holds conversion methods for the sign enumeration. More...
 
class  EEndianessClass
 Holds conversion methods for the endianess enumeration. More...
 
class  ERepresentationClass
 Holds conversion methods for the representation enumeration. More...
 
class  EVisibilityClass
 Holds conversion methods for the visibility enumeration. More...
 
class  EAccessModeClass
 Holds conversion methods for the access mode enumeration. More...
 
class  ECachingModeClass
 Holds conversion methods for the caching mode enumeration. More...
 
class  ENameSpaceClass
 Holds conversion methods for the namespace enumeration. More...
 
class  EYesNoClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  EStandardNameSpaceClass
 Holds conversion methods for the standard namespace enumeration. More...
 
class  ESlopeClass
 Holds conversion methods for the converter formulas. More...
 
class  EDisplayNotationClass
 Holds conversion methods for the notation type of floats. More...
 
class  EInputDirectionClass
 Holds conversion methods for the notation type of floats. More...
 
class  EGenApiSchemaVersionClass
 helper class converting EGenApiSchemaVersion from and to string More...
 
class  EnumEntryNode
 Interface for string properties. More...
 
class  EnumNode
 Interface for string properties. More...
 
class  CEnumerationTRef
 Interface for string properties. More...
 
class  CEventAdapter
 Delivers Events to ports. More...
 
class  CEventAdapter1394
 Distribute the events to the node map. More...
 
class  CEventAdapterGeneric
 Connects a generic event to a node map. More...
 
class  CEventAdapterGEV
 Connects a GigE Event to a node map. More...
 
class  CEventAdapterU3V
 Connects a U3V Event to a node map. More...
 
class  CEventPort
 Port attachable to an event. More...
 
class  FileProtocolAdapter
 Adapter between the std::iostreambuf and the SFNC Features representing the device file system. More...
 
class  IDevFileStreamBuf
 
class  ODevFileStreamBuf
 
class  ODevFileStreamBase
 
class  IDevFileStreamBase
 
class  FloatNode
 Interface for string properties. More...
 
class  FloatRegNode
 Interface for string properties. More...
 
class  IntegerNode
 Interface for string properties. More...
 
class  IntRegNode
 Interface for string properties. More...
 
class  Node
 class common to all nodes More...
 
class  CNodeCallback
 callback body instance for INode pointers More...
 
class  Function_NodeCallback
 Container for a function pointer. More...
 
class  Member_NodeCallback
 Container for a member function pointer. More...
 
class  NodeMap
 Smart pointer template for NodeMaps with create function. More...
 
class  CNodeMapFactory
 The node map factory is used for creating node maps from camera description files. More...
 
class  CNodeMapRefT
 Smartpointer template for NodeMaps with create function. More...
 
class  CGeneric_XMLLoaderParams
 Empty base class used by class CNodeMapRef as generic template argument. More...
 
class  CNodeMapRef
 Smartpointer for NodeMaps with create function. More...
 
class  CFeatureBag
 Bag holding streamable features of a nodetree. More...
 
class  CPointer
 Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...
 
class  CFloatPtr
 SmartPointer for IFloat interface pointer. More...
 
class  CPortImpl
 Standard implementation for a port. More...
 
class  PortNode
 Interface for value properties. More...
 
class  PortRecorder
 Interface for recording write commands on a port. More...
 
class  PortReplay
 Interface for replaying write commands on a port. More...
 
class  CPortWriteList
 Container holding a list of port write commands. More...
 
class  RegisterNode
 Interface for string properties. More...
 
class  CRegisterPortImpl
 Standard implementation for a port using a register based transport layer. More...
 
class  CSelectorSet
 The set of selectors selecting a given node. More...
 
class  SpinTestCamera
 
class  StringNode
 Interface for string properties. More...
 
class  StringRegNode
 Interface for string properties. More...
 
class  CTestPortStruct
 Implements a register spaces based on a C++ struct. More...
 
class  CLock
 A lock class. More...
 
class  CLockEx
 This class is for testing purposes only. More...
 
class  AutoLock
 
class  ValueNode
 Interface for value properties. More...
 

Typedefs

typedef BooleanNode CBooleanRef
 
typedef CategoryNode CCategoryRef
 
typedef CommandNode CCommandRef
 
typedef EnumEntryNode CEnumEntryRef
 
typedef EnumNode CEnumerationRef
 
typedef ODevFileStreamBase
< char, std::char_traits< char > > 
ODevFileStream
 
typedef IDevFileStreamBase
< char, std::char_traits< char > > 
IDevFileStream
 
typedef FloatNode CFloatRef
 
typedef node_vector NodeList_t
 a list of node references More...
 
typedef intptr_t CallbackHandleType
 the callback handle for nodes More...
 
typedef IntegerNode CIntegerRef
 
typedef Node CNodeRef
 
typedef Node CSelectorRef
 
typedef NodeMap CNodeMapRef
 
typedef CPointer< IBaseCBasePtr
 SmartPointer for IBase interface pointer. More...
 
typedef CPointer< INode, IBaseCNodePtr
 SmartPointer for INode interface pointer. More...
 
typedef CPointer< IValueCValuePtr
 SmartPointer for IValue interface pointer. More...
 
typedef CPointer< ICategoryCCategoryPtr
 SmartPointer for ICategory interface pointer. More...
 
typedef CPointer< IBooleanCBooleanPtr
 SmartPointer for IBoolean interface pointer. More...
 
typedef CPointer< IIntegerCIntegerPtr
 SmartPointer for IInteger interface pointer. More...
 
typedef CPointer< IStringCStringPtr
 SmartPointer for IString interface pointer. More...
 
typedef CPointer< IRegisterCRegisterPtr
 SmartPointer for IRegister interface pointer. More...
 
typedef CPointer< IEnumerationCEnumerationPtr
 SmartPointer for IEnumeration interface pointer. More...
 
typedef CPointer< IEnumEntryCEnumEntryPtr
 SmartPointer for IEnumEntry interface pointer. More...
 
typedef CPointer< IPortCPortPtr
 SmartPointer for IPort interface pointer. More...
 
typedef CPointer< IPortReplayCPortReplayPtr
 SmartPointer for IPortReplay interface pointer. More...
 
typedef CPointer< IPortRecorderCPortRecorderPtr
 SmartPointer for IPortRecorder interface pointer. More...
 
typedef CPointer
< IPortWriteList,
IPortWriteList
CPortWriteListPtr
 SmartPointer for IPortWriteList interface pointer. More...
 
typedef CPointer< IChunkPortCChunkPortPtr
 SmartPointer for IChunkPort interface pointer. More...
 
typedef CPointer< INodeMap,
INodeMap
CNodeMapPtr
 SmartPointer for INodeMap interface pointer. More...
 
typedef CPointer< INodeMapDyn,
INodeMap
CNodeMapDynPtr
 SmartPointer for INodeMapDyn interface pointer. More...
 
typedef CPointer< IDeviceInfo,
INodeMap
CDeviceInfoPtr
 SmartPointer for IDeviceInfo interface pointer. More...
 
typedef CPointer< ISelectorCSelectorPtr
 SmartPointer for ISelector interface pointer. More...
 
typedef CPointer< ICommandCCommandPtr
 SmartPointer for ICommand interface pointer. More...
 
typedef CPointer< IPortConstructCPortConstructPtr
 SmartPointer for IPortConstruct interface pointer. More...
 
typedef PortNode CPortRef
 
typedef PortRecorder CPortRecorderRef
 Reference to an IPortRecorder pointer. More...
 
typedef RegisterNode CRegisterRef
 
typedef StringNode CStringRef
 
typedef GenICam::gcstring_vector StringList_t
 A list of strings. More...
 
typedef ValueNode CValueRef
 

Enumerations

enum  GVCP_MESSAGE_TAGS { TAG_EVENT_CMD = 0xc0, TAG_EVENTDATA_CMD = 0xc2 }
 
enum  ECallbackType { cbPostInsideLock = 1, cbPostOutsideLock = 2 }
 the type of callback More...
 
enum  ECacheUsage_t { CacheUsage_Automatic, CacheUsage_ForceWrite, CacheUsage_ForceRead, CacheUsage_Ignore }
 Lists the cache usage strategies. More...
 
enum  EContentType_t { ContentType_Xml, ContentType_ZippedXml }
 Lists the processable file types. More...
 
enum  ESign { Signed, Unsigned, _UndefinedSign }
 signed or unsigned integers More...
 
enum  EAccessMode {
  NI, NA, WO, RO,
  RW, _UndefinedAccesMode, _CycleDetectAccesMode
}
 access mode of a node More...
 
enum  EVisibility {
  Beginner = 0, Expert = 1, Guru = 2, Invisible = 3,
  _UndefinedVisibility = 99
}
 recommended visibility of a node More...
 
enum  ECachingMode { NoCache, WriteThrough, WriteAround, _UndefinedCachingMode }
 caching mode of a register More...
 
enum  ERepresentation {
  Linear, Logarithmic, Boolean, PureNumber,
  HexNumber, IPV4Address, MACAddress, _UndefinedRepresentation
}
 recommended representation of a node value More...
 
enum  EEndianess { BigEndian, LittleEndian, _UndefinedEndian }
 Endianess of a value in a register. More...
 
enum  ENameSpace { Custom, Standard, _UndefinedNameSpace }
 Defines if a node name is standard or custom. More...
 
enum  EStandardNameSpace {
  None, GEV, IIDC, CL,
  USB, _UndefinedStandardNameSpace
}
 Defines from which standard namespace a node name comes from. More...
 
enum  EYesNo { Yes = 1, No = 0, _UndefinedYesNo = 2 }
 Defines the choices of a Yes/No alternative. More...
 
enum  ESlope {
  Increasing, Decreasing, Varying, Automatic,
  _UndefinedESlope
}
 typedef for formula type More...
 
enum  EXMLValidation {
  xvLoad = 0x00000001L, xvCycles = 0x00000002L, xvSFNC = 0x00000004L, xvDefault = 0x00000000L,
  xvAll = 0xffffffffL, _UndefinedEXMLValidation = 0x8000000L
}
 typedef describing the different validity checks which can be performed on an XML file More...
 
enum  EDisplayNotation { fnAutomatic, fnFixed, fnScientific, _UndefinedEDisplayNotation }
 typedef for float notation More...
 
enum  EInterfaceType {
  intfIValue, intfIBase, intfIInteger, intfIBoolean,
  intfICommand, intfIFloat, intfIString, intfIRegister,
  intfICategory, intfIEnumeration, intfIEnumEntry, intfIPort
}
 typedef for interface type More...
 
enum  ELinkType {
  ctParentNodes, ctReadingChildren, ctWritingChildren, ctInvalidatingChildren,
  ctDependingNodes, ctTerminalNodes
}
 typedef for link type More...
 
enum  EIncMode { noIncrement, fixedIncrement, listIncrement }
 typedef for increment mode More...
 
enum  EInputDirection { idFrom, idTo, idNone }
 typedef for link type More...
 
enum  EGenApiSchemaVersion { v1_0 = 1, v1_1 = 2, _Undefined = -1 }
 GenApi schema version. More...
 

Functions

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

Variables

interface SPINNAKER_API_ABSTRACT IBase
 Base interface common to all nodes. More...
 
const uint8_t COMMAND_MAGIC = 0x42
 
const uint32_t U3V_EVENT_PREFIX = 0x45563355
 
const uint16_t GENCP_EVENT_CMD_ID = 0x0C00
 
const size_t GENCP_COMMAND_HEADER_SIZE = sizeof(U3V_COMMAND_HEADER)
 
const size_t GENCP_EVENT_BASIC_SIZE = sizeof(U3V_EVENT_MESSAGE)
 
interface SPINNAKER_API_ABSTRACT IBoolean
 Interface for Boolean properties. More...
 
interface
SPINNAKER_API_ABSTRACT bool 
Verify = true) = 0
 
interface SPINNAKER_API_ABSTRACT ICategory
 Gives access to a category node. More...
 
interface SPINNAKER_API_ABSTRACT IChunkPort
 Interface for ports attached to a chunk. More...
 
interface SPINNAKER_API_ABSTRACT ICommand
 Interface for command like properties. More...
 
interface SPINNAKER_API_ABSTRACT IDestroy
 Interface to destroy an object. More...
 
interface SPINNAKER_API_ABSTRACT IDeviceInfo
 Interface to get information about the device (= nodemap) More...
 
interface SPINNAKER_API_ABSTRACT IEnumEntry
 Interface of single enum value. More...
 
interface SPINNAKER_API_ABSTRACT IEnumeration
 Interface for enumeration properties. More...
 
template<typename EnumT >
interface SPINNAKER_API_ABSTRACT IEnumerationT
 Interface for enumeration properties. More...
 
template<typename EnumT >
interface
SPINNAKER_API_ABSTRACT virtual
public 
IEnumReference
 Interface to construct an enum reference. More...
 
interface SPINNAKER_API_ABSTRACT IFloat
 Interface for float properties. More...
 
interface SPINNAKER_API_ABSTRACT IInteger
 Interface for integer properties. More...
 
interface SPINNAKER_API_ABSTRACT INode
 Interface common to all nodes. More...
 
interface
SPINNAKER_API_ABSTRACT virtual
public 
IReference
 Interface to construct a reference. More...
 
interface SPINNAKER_API_ABSTRACT INodeMap
 Interface to access the node map. More...
 
interface SPINNAKER_API_ABSTRACT INodeMapDyn
 Interface to access the node map. More...
 
interface SPINNAKER_API_ABSTRACT IPort
 Interface for ports. More...
 
interface
SPINNAKER_API_ABSTRACT int64_t 
Address
 
interface
SPINNAKER_API_ABSTRACT int64_t
int64_t 
Length = 0
 
interface SPINNAKER_API IPortConstruct
 Interface for ports. More...
 
interface SPINNAKER_API_ABSTRACT IPortWriteList
 
interface SPINNAKER_API_ABSTRACT IPortReplay
 Interface for replaying write commands on a port. More...
 
interface
SPINNAKER_API_ABSTRACT bool 
Invalidate = true) = 0
 
interface SPINNAKER_API_ABSTRACT IPortRecorder
 Interface for recording write commands on a port. More...
 
interface SPINNAKER_API_ABSTRACT IRegister
 Interface for registers. More...
 
interface SPINNAKER_API_ABSTRACT ISelector
 Interface for groups of features selected by a single one. More...
 
interface SPINNAKER_API_ABSTRACT ISelectorDigit
 Interface of a "digit" of the "counter" formed by the selector set. More...
 
interface SPINNAKER_API_ABSTRACT IString
 Interface for string properties. More...
 
interface SPINNAKER_API_ABSTRACT IValue
 Interface for value properties. More...
 
interface SPINNAKER_API_ABSTRACT IPersistScript
 Basic interface to persist values to. More...
 

Typedef Documentation

typedef IDevFileStreamBase<char, std::char_traits<char> > IDevFileStream
typedef ODevFileStreamBase<char, std::char_traits<char> > ODevFileStream

Enumeration Type Documentation

Enumerator
TAG_EVENT_CMD 
TAG_EVENTDATA_CMD 

Function Documentation

virtual void Spinnaker::GenApi::PersistFeature ( IValue &  item)
pure virtual

Stores a feature.

void SPINNAKER_API Spinnaker::GenApi::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 
)

Variable Documentation

const uint8_t COMMAND_MAGIC = 0x42
const size_t GENCP_COMMAND_HEADER_SIZE = sizeof(U3V_COMMAND_HEADER)
const size_t GENCP_EVENT_BASIC_SIZE = sizeof(U3V_EVENT_MESSAGE)
const uint16_t GENCP_EVENT_CMD_ID = 0x0C00
Initial value:
{
virtual void SetInfo(GenICam::gcstring & Info) = 0

Basic interface to persist values to.

const uint32_t U3V_EVENT_PREFIX = 0x45563355
Contact Support Spinnaker® SDK Programmer's Guide and API Reference