Skip to content

Class Spinnaker::GenApi::CRegisterPortImpl

ClassList > GenApi > CRegisterPortImpl

Standard implementation for a port using a register based transport layer.

  • #include <RegisterPortImpl.h>

Inherits the following classes: Spinnaker::GenApi::CPortImpl

Public Functions

Type Name
CRegisterPortImpl (int MaxNumQuadlets=1, bool TransportLayerSwapsEndianess=false)
virtual EAccessMode GetAccessMode () const = 0
virtual void Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void ReadRegister (uint32_t * pRegisters, int64_t Address, int64_t Length) = 0
virtual void SetPortImpl (IPort * pPort)
virtual void Write (const void * pBuffer, int64_t Address, int64_t Length)
virtual void WriteRegister (const uint32_t * pRegisters, int64_t Address, int64_t Length) = 0
virtual ~CRegisterPortImpl ()

Public Functions inherited from Spinnaker::GenApi::CPortImpl

See Spinnaker::GenApi::CPortImpl

Type Name
CPortImpl ()
virtual EAccessMode GetAccessMode () const = 0
virtual EYesNo GetSwapEndianess ()
void InvalidateNode ()
virtual void Read (void * pBuffer, int64_t Address, int64_t Length) = 0
virtual void Replay (IPortWriteList * pPortRecorder, bool Invalidate=true)
virtual void SetPortImpl (IPort * pPort)
virtual void Write (const void * pBuffer, int64_t Address, int64_t Length) = 0
virtual ~CPortImpl ()

Protected Attributes inherited from Spinnaker::GenApi::CPortImpl

See Spinnaker::GenApi::CPortImpl

Type Name
CNodePtr m_ptrPort

Public Functions Documentation

function CRegisterPortImpl

inline GenApi::CRegisterPortImpl::CRegisterPortImpl (
    int MaxNumQuadlets=1,
    bool TransportLayerSwapsEndianess=false
) 

Constructor


function GetAccessMode

virtual EAccessMode GenApi::CRegisterPortImpl::GetAccessMode () const = 0

Get the access mode of the node

Driver closed => NI, Driver open => RW, analyzing a struct, RO

Implements Spinnaker::GenApi::CPortImpl::GetAccessMode


function Read

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

Reads a chunk of bytes from the port

Implements Spinnaker::GenApi::CPortImpl::Read


function ReadRegister

virtual void GenApi::CRegisterPortImpl::ReadRegister (
    uint32_t * pRegisters,
    int64_t Address,
    int64_t Length
) = 0

Reads an array of quadlets from the port


function SetPortImpl

inline virtual void GenApi::CRegisterPortImpl::SetPortImpl (
    IPort * pPort
) 

Sets pointer the real port implementation; this function may called only once

Implements Spinnaker::GenApi::CPortImpl::SetPortImpl


function Write

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

Writes a chunk of bytes to the port

Implements Spinnaker::GenApi::CPortImpl::Write


function WriteRegister

virtual void GenApi::CRegisterPortImpl::WriteRegister (
    const  uint32_t * pRegisters,
    int64_t Address,
    int64_t Length
) = 0

Writes an array of quadlets to the port


function ~CRegisterPortImpl

inline virtual GenApi::CRegisterPortImpl::~CRegisterPortImpl () 

Destructor



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