Class Spinnaker::GenApi::CPortImpl¶

ClassList > GenApi > CPortImpl

Standard implementation for a port.

#include <PortImpl.h>

Inherits the following classes: IPortConstruct, IPortReplay

Inherited by the following classes: Spinnaker::GenApi::CRegisterPortImpl, Spinnaker::GenApi::CTestPortStruct

Public Functions¶

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¶

Type	Name
CNodePtr	m_ptrPort

Public Functions Documentation¶

function CPortImpl¶

inline GenApi::CPortImpl::CPortImpl ()

Constructor

function GetAccessMode¶

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

Get the access mode of the node

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

function GetSwapEndianess¶

inline virtual EYesNo GenApi::CPortImpl::GetSwapEndianess ()

Determines if the port adapter must perform an endianness swap

function InvalidateNode¶

inline void GenApi::CPortImpl::InvalidateNode ()

function Read¶

virtual void GenApi::CPortImpl::Read (
    void * pBuffer,
    int64_t Address,
    int64_t Length
) = 0

Reads a chunk of bytes from the port

function Replay¶

inline virtual void GenApi::CPortImpl::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.

function SetPortImpl¶

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

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

function Write¶

virtual void GenApi::CPortImpl::Write (
    const  void * pBuffer,
    int64_t Address,
    int64_t Length
) = 0

Writes a chunk of bytes to the port

function ~CPortImpl¶

inline virtual GenApi::CPortImpl::~CPortImpl ()

Destructor

Protected Attributes Documentation¶

variable m_ptrPort¶

CNodePtr Spinnaker::GenApi::CPortImpl::m_ptrPort;

Pointer to the node holding a reference to this implementation

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