Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
PortRecorder Class Reference

Interface for recording write commands on a port. More...

Inheritance diagram for PortRecorder:
PortReplay PortNode Node

Public Member Functions

 PortRecorder ()
 
virtual ~PortRecorder ()
 
virtual void StartRecording (IPortWriteList *pPortRecorder)
 starts logging all WriteRegister commands to a list More...
 
virtual void StopRecording ()
 stops recording More...
 
virtual EAccessMode GetAccessMode () const
 Get the access mode of the node. More...
 
virtual void SetReference (IPort *pBase)
 overload SetReference for Value More...
 
virtual void Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
 sends the commands to the camera. More...
 
virtual void Read (void *pBuffer, int64_t Address, int64_t Length)
 Reads a chunk of bytes from the port. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)
 Writes a chunk of bytes to the port. More...
 
- Public Member Functions inherited from PortReplay
 PortReplay ()
 
virtual ~PortReplay ()
 
void * GetPortReplayHandle ()
 
- Public Member Functions inherited from PortNode
 PortNode ()
 Constructor. More...
 
 PortNode (std::shared_ptr< Node::NodeImpl > pValue)
 constructor with GenICam IValue More...
 
 ~PortNode ()
 Destructor. More...
 
void SetPortImpl (IPort *pPort)
 Sets pointer the real port implementation; this function may called only once. More...
 
virtual EYesNo GetSwapEndianess ()
 Determines if the port adapter must perform an endianess swap. More...
 
virtual
Spinnaker::GenICam::gcstring 
GetChunkID () const
 Get the Id of the chunk the port should be attached to. More...
 
virtual EYesNo CacheChunkData () const
 Indicates if the chunk a adapter must hold a cached version of the chunk data. More...
 
virtual void SetReference (INode *pBase)
 overload SetReference for Value More...
 
virtual void SetReference (IChunkPort *pBase)
 overload SetReference for Value More...
 
std::shared_ptr< Node::NodeImpl > GetPortHandle ()
 
- Public Member Functions inherited from Node
 Node ()
 Constructor. More...
 
 Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Constructor. More...
 
 ~Node ()
 Destructor. More...
 
virtual GenICam::gcstring GetName (bool FullQualified=false) const
 Get node name. More...
 
virtual GenApi::ENameSpace GetNameSpace () const
 Get name space. More...
 
virtual EVisibility GetVisibility () const
 Get the recommended visibility of the node. More...
 
virtual void InvalidateNode ()
 Indicates that the node's value may have changed. More...
 
virtual bool IsCachable () const
 Is the node value cacheable. More...
 
virtual EYesNo IsAccessModeCacheable () const
 True if the AccessMode can be cached. More...
 
virtual ECachingMode GetCachingMode () const
 Get Caching Mode. More...
 
virtual int64_t GetPollingTime () const
 recommended polling time (for not cacheable nodes) More...
 
virtual GenICam::gcstring GetToolTip () const
 Get a short description of the node. More...
 
virtual GenICam::gcstring GetDescription () const
 Get a long description of the node. More...
 
virtual GenICam::gcstring GetDisplayName () const
 Get a name string for display. More...
 
virtual GenICam::gcstring GetDeviceName () const
 Get a name of the device. More...
 
virtual void GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const
 Get all nodes this node directly depends on. More...
 
virtual void GetParents (GenApi::NodeList_t &Parents) const
 Gets all nodes this node is directly depending on. More...
 
virtual CallbackHandleType RegisterCallback (CNodeCallback *pCallback)
 Register change callback Takes ownership of the CNodeCallback object. More...
 
virtual bool DeregisterCallback (CallbackHandleType hCallback)
 De register change callback Destroys CNodeCallback object. More...
 
virtual INodeMapGetNodeMap () const
 Retrieves the central node map. More...
 
virtual GenICam::gcstring GetEventID () const
 Get the EventId of the node. More...
 
virtual bool IsStreamable () const
 True if the node is streamable. More...
 
virtual void GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const
 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)
 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)
 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 GenICam::gcstring GetDocuURL () const
 Gets a URL pointing to the documentation of that feature. More...
 
virtual bool IsDeprecated () const
 True if the node should not be used any more. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
virtual bool IsFeature () const
 True if the node can be reached via category nodes from a category node named "Root". More...
 
void SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
 Set Node handle. More...
 
std::shared_ptr< Node::NodeImpl > GetNodeHandle () const
 Get Node handle. More...
 
virtual bool IsSelector () const
 Selector interface overrides. More...
 
virtual void GetSelectedFeatures (FeatureList_t &) const
 retrieve the group of selected features More...
 
virtual void GetSelectingFeatures (FeatureList_t &) const
 retrieve the group of features selecting this node More...
 
virtual void SetReference (ISelector *pBase)
 
void SetNodeMap (INodeMap *pNodeMap)
 
virtual bool operator== (int nullPtr) const
 
virtual bool operator!= (int nullPtr) const
 

Additional Inherited Members

- Protected Attributes inherited from Node
std::shared_ptr< Node::NodeImpl > m_pNodeData
 
std::list< CallbackHandleType_t * > m_Callbacks
 List of callbacks. More...
 
INodeMapm_pNodeMap
 

Detailed Description

Interface for recording write commands on a port.

Constructor & Destructor Documentation

virtual ~PortRecorder ( )
virtual

Member Function Documentation

virtual EAccessMode GetAccessMode ( ) const
virtual

Get the access mode of the node.

Reimplemented from PortReplay.

virtual void Read ( void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
inlinevirtual

Reads a chunk of bytes from the port.

Reimplemented from PortReplay.

virtual void Replay ( IPortWriteList pPortRecorder,
bool  Invalidate = true 
)
inlinevirtual

sends the commands to the camera.

the default implementation just walks the list and issues each command using the WriteRegister method. Depending on the capabilities of the transport layer the implementation can however use a special command which sends all register write commands as one package.

Reimplemented from PortReplay.

virtual void SetReference ( IPort pBase)
virtual

overload SetReference for Value

Reimplemented from PortReplay.

virtual void StartRecording ( IPortWriteList pPortRecorder)
virtual

starts logging all WriteRegister commands to a list

Reimplemented from PortNode.

virtual void StopRecording ( )
virtual

stops recording

Reimplemented from PortNode.

virtual void Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
inlinevirtual

Writes a chunk of bytes to the port.

Reimplemented from PortReplay.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference