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

#include <PortRecorder.h>

Inheritance diagram for PortRecorder:

Public Member Functions
	PortRecorder ()

virtual	~PortRecorder ()

virtual void	StartRecording (IPortWriteList *pPortRecorder)
	starts logging all WriteRegister commands to a list

virtual void	StopRecording ()
	stops recording

virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node.

virtual void	SetReference (IPort *pBase)
	overload SetReference for Value

virtual void	Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
	sends the commands to the camera.

virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port.

virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port.

Public Member Functions inherited from PortReplay
	PortReplay ()

virtual	~PortReplay ()

virtual void	Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
	sends the commands to the camera.

virtual void	SetReference (IPort *pBase)
	overload SetReference for Value

void *	GetPortReplayHandle ()

virtual EAccessMode	GetAccessMode () const
	Base interface overrides.

virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port.

virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port.

Public Member Functions inherited from PortNode
	PortNode ()
	Constructor.

	PortNode (std::shared_ptr< Node::NodeImpl > pValue)
	constructor with GenICam IValue

	~PortNode ()
	Destructor.

virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port.

virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port.

void	SetPortImpl (IPort *pPort)
	Sets pointer the real port implementation; this function may called only once.

virtual EYesNo	GetSwapEndianess ()
	Determines if the port adapter must perform an endianess swap.

virtual Spinnaker::GenICam::gcstring	GetChunkID () const
	Get the Id of the chunk the port should be attached to.

virtual EYesNo	CacheChunkData () const
	Indicates if the chunk a adapter must hold a cached version of the chunk data.

virtual void	StartRecording (IPortWriteList *pPortRecorder)
	Starts logging all WriteRegister commands to a list.

virtual void	StopRecording ()
	Stops recording.

virtual void	Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
	Sends the commands to the camera.

virtual void	SetReference (INode *pBase)
	overload SetReference for Value

virtual void	SetReference (IPort *pBase)
	overload SetReference for Value

virtual void	SetReference (IChunkPort *pBase)
	overload SetReference for Value

std::shared_ptr< Node::NodeImpl >	GetPortHandle ()

virtual void	SetReference (INode *pBase)
	Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

virtual void	SetReference (ISelector *pBase)

Public Member Functions inherited from Node
	Node ()
	Constructor.

	Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Constructor.

	~Node ()
	Destructor.

virtual GenICam::gcstring	GetName (bool FullQualified=false) const
	Get node name.

virtual GenApi::ENameSpace	GetNameSpace () const
	Get name space.

virtual EVisibility	GetVisibility () const
	Get the recommended visibility of the node.

virtual void	InvalidateNode ()
	Indicates that the node's value may have changed.

virtual bool	IsCachable () const
	Is the node value cacheable.

virtual EYesNo	IsAccessModeCacheable () const
	True if the AccessMode can be cached.

virtual ECachingMode	GetCachingMode () const
	Get Caching Mode.

virtual int64_t	GetPollingTime () const
	recommended polling time (for not cacheable nodes)

virtual GenICam::gcstring	GetToolTip () const
	Get a short description of the node.

virtual GenICam::gcstring	GetDescription () const
	Get a long description of the node.

virtual GenICam::gcstring	GetDisplayName () const
	Get a name string for display.

virtual GenICam::gcstring	GetDeviceName () const
	Get a name of the device.

virtual void	GetChildren (GenApi::NodeList_t &Children, ELinkType LinkType=ctReadingChildren) const
	Get all nodes this node directly depends on.

virtual void	GetParents (GenApi::NodeList_t &Parents) const
	Gets all nodes this node is directly depending on.

virtual void	GetLockNodes (GenApi::NodeList_t &LockNodes) const
	Gets all nodes which can directly lock this node.

virtual CallbackHandleType	RegisterCallback (CNodeCallback *pCallback)
	Register change callback Takes ownership of the CNodeCallback object.

virtual bool	DeregisterCallback (CallbackHandleType hCallback)
	De register change callback Destroys CNodeCallback object.

virtual INodeMap *	GetNodeMap () const
	Retrieves the central node map.

virtual GenICam::gcstring	GetEventID () const
	Get the EventId of the node.

virtual bool	IsStreamable () const
	True if the node is streamable.

virtual void	GetPropertyNames (GenICam::gcstring_vector &PropertyNames) const
	Returns a list of the names all properties set during initialization.

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.

virtual void	ImposeAccessMode (EAccessMode ImposedAccessMode)
	Imposes an access mode to the natural access mode of the node.

virtual void	ImposeVisibility (EVisibility ImposedVisibility)
	Imposes a visibility to the natural visibility of the node.

virtual INode *	GetAlias () const
	Retrieves the a node which describes the same feature in a different way.

virtual INode *	GetCastAlias () const
	Retrieves the a node which describes the same feature so that it can be casted.

virtual GenICam::gcstring	GetDocuURL () const
	Gets a URL pointing to the documentation of that feature.

virtual bool	IsDeprecated () const
	True if the node should not be used any more.

virtual EInterfaceType	GetPrincipalInterfaceType () const
	Get the type of the main interface of a node.

virtual bool	IsFeature () const
	True if the node can be reached via category nodes from a category node named "Root".

void	SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
	Set Node handle.

std::shared_ptr< Node::NodeImpl >	GetNodeHandle () const
	Get Node handle.

virtual EAccessMode	GetAccessMode () const
	Base interface overrides.

virtual bool	IsSelector () const
	Selector interface overrides.

virtual void	GetSelectedFeatures (FeatureList_t &) const
	retrieve the group of selected features

virtual void	GetSelectingFeatures (FeatureList_t &) const
	retrieve the group of features selecting this node

virtual void	SetReference (INode *pBase)
	Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.

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.

INodeMap *	m_pNodeMap

Detailed Description

Interface for recording write commands on a port.

Constructor & Destructor Documentation

◆ PortRecorder()

PortRecorder ( )

◆ ~PortRecorder()

virtual ~PortRecorder ( )

virtual

Member Function Documentation

◆ GetAccessMode()

virtual EAccessMode GetAccessMode ( ) const

virtual

Get the access mode of the node.

Reimplemented from PortReplay.

◆ Read()

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

inlinevirtual

Reads a chunk of bytes from the port.

Reimplemented from PortReplay.

◆ Replay()

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.

◆ SetReference()

virtual void SetReference ( IPort * pBase )

virtual

overload SetReference for Value

Reimplemented from PortReplay.

◆ StartRecording()

virtual void StartRecording ( IPortWriteList * pPortRecorder )

virtual

starts logging all WriteRegister commands to a list

Reimplemented from PortNode.

◆ StopRecording()

virtual void StopRecording ( )

virtual

stops recording

Reimplemented from PortNode.

◆ Write()

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:

include/SpinGenApi/PortRecorder.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PortRecorder()

◆ ~PortRecorder()

Member Function Documentation

◆ GetAccessMode()

◆ Read()

◆ Replay()

◆ SetReference()

◆ StartRecording()

◆ StopRecording()

◆ Write()