Skip to content

Class Spinnaker::GenApi::PortReplay

ClassList > GenApi > PortReplay

Interface for replaying write commands on a port.

  • #include <PortReplay.h>

Inherits the following classes: IPortReplay, Spinnaker::GenApi::PortNode

Inherited by the following classes: Spinnaker::GenApi::PortRecorder

Public Functions

Type Name
virtual EAccessMode GetAccessMode () const
Base interface overrides.
void * GetPortReplayHandle ()
PortReplay ()
virtual void Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void Replay (IPortWriteList * pPortRecorder, bool Invalidate=true)
virtual void SetReference (IPort * pBase)
virtual void Write (const void * pBuffer, int64_t Address, int64_t Length)
virtual ~PortReplay ()

Public Functions inherited from Spinnaker::GenApi::PortNode

See Spinnaker::GenApi::PortNode

Type Name
virtual EYesNo CacheChunkData () const
virtual Spinnaker::GenICam::gcstring GetChunkID () const
std::shared_ptr< Node::NodeImpl > GetPortHandle ()
virtual EYesNo GetSwapEndianess ()
PortNode ()
PortNode (std::shared_ptr< Node::NodeImpl > pValue)
virtual void Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void Replay (IPortWriteList * pPortRecorder, bool Invalidate=true)
void SetPortImpl (IPort * pPort)
virtual void SetReference (INode * pBase)
virtual void SetReference (IPort * pBase)
virtual void SetReference (IChunkPort * pBase)
virtual void SetReference (INode * pBase)
Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void SetReference (ISelector * pBase)
virtual void StartRecording (IPortWriteList * pPortRecorder)
virtual void StopRecording ()
virtual void Write (const void * pBuffer, int64_t Address, int64_t Length)
~PortNode ()

Public Functions inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type Name
virtual bool DeregisterCallback (CallbackHandleType hCallback)
virtual EAccessMode GetAccessMode () const
Base interface overrides.
virtual INode * GetAlias () const
virtual ECachingMode GetCachingMode () const
virtual INode * GetCastAlias () const
virtual void GetChildren (GenApi::NodeList_t & Children, ELinkType LinkType=ctReadingChildren) const
Get all nodes this node directly depends on.
virtual GenICam::gcstring GetDescription () const
virtual GenICam::gcstring GetDeviceName () const
virtual GenICam::gcstring GetDisplayName () const
virtual GenICam::gcstring GetDocuURL () const
virtual GenICam::gcstring GetEventID () const
virtual void GetLockNodes (GenApi::NodeList_t & LockNodes) const
Gets all nodes which can directly lock this node.
virtual GenICam::gcstring GetName (bool FullQualified=false) const
virtual GenApi::ENameSpace GetNameSpace () const
std::shared_ptr< Node::NodeImpl > GetNodeHandle () const
virtual INodeMap * GetNodeMap () const
virtual void GetParents (GenApi::NodeList_t & Parents) const
Gets all nodes this node is directly depending on.
virtual int64_t GetPollingTime () const
virtual EInterfaceType GetPrincipalInterfaceType () const
virtual bool GetProperty (const GenICam::gcstring & PropertyName, GenICam::gcstring & ValueStr, GenICam::gcstring & AttributeStr)
virtual void GetPropertyNames (GenICam::gcstring_vector & PropertyNames) const
virtual void GetSelectedFeatures (FeatureList_t &) const
virtual void GetSelectingFeatures (FeatureList_t &) const
virtual GenICam::gcstring GetToolTip () const
virtual EVisibility GetVisibility () const
virtual void ImposeAccessMode (EAccessMode ImposedAccessMode)
virtual void ImposeVisibility (EVisibility ImposedVisibility)
virtual void InvalidateNode ()
virtual EYesNo IsAccessModeCacheable () const
virtual bool IsCachable () const
virtual bool IsDeprecated () const
virtual bool IsFeature () const
virtual bool IsSelector () const
Selector interface overrides.
virtual bool IsStreamable () const
Node ()
Node (std::shared_ptr< Node::NodeImpl > pNodeHandle)
virtual CallbackHandleType RegisterCallback (CNodeCallback * pCallback)
void SetNodeHandle (std::shared_ptr< Node::NodeImpl > pNodeHandle)
void SetNodeMap (INodeMap * pNodeMap)
virtual void SetReference (INode * pBase)
Reference interface overrides \ingroup Spinnaker_GenApi_PublicImpl.
virtual void SetReference (ISelector * pBase)
virtual bool operator!= (int nullPtr) const
virtual bool operator== (int nullPtr) const
~Node ()

Protected Attributes inherited from Spinnaker::GenApi::Node

See Spinnaker::GenApi::Node

Type Name
std::list< CallbackHandleType_t * > m_Callbacks
std::shared_ptr< Node::NodeImpl > m_pNodeData
INodeMap * m_pNodeMap

Public Functions Documentation

function GetAccessMode

Base interface overrides.

inline virtual EAccessMode GenApi::PortReplay::GetAccessMode () const

Get the access mode of the node

Implements Spinnaker::GenApi::Node::GetAccessMode


function GetPortReplayHandle

void * GenApi::PortReplay::GetPortReplayHandle () 

function PortReplay

GenApi::PortReplay::PortReplay () 

function Read

inline virtual void GenApi::PortReplay::Read (
    void * pBuffer,
    int64_t Address,
    int64_t Length
) 

Reads a chunk of bytes from the port

Implements Spinnaker::GenApi::PortNode::Read


function Replay

virtual void GenApi::PortReplay::Replay (
    IPortWriteList * pPortRecorder,
    bool Invalidate=true
) 

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.

Implements Spinnaker::GenApi::PortNode::Replay


function SetReference

virtual void GenApi::PortReplay::SetReference (
    IPort * pBase
) 

overload SetReference for Value

Implements Spinnaker::GenApi::PortNode::SetReference


function Write

inline virtual void GenApi::PortReplay::Write (
    const  void * pBuffer,
    int64_t Address,
    int64_t Length
) 

Writes a chunk of bytes to the port

Implements Spinnaker::GenApi::PortNode::Write


function ~PortReplay

virtual GenApi::PortReplay::~PortReplay () 


The documentation for this class was generated from the following file C:/workspace/include/SpinGenApi/PortReplay.h