CTestPortStruct< CDataStruct > Class Template Reference

Implements a register spaces based on a C++ struct. More...

#include <StructPort.h>

Inheritance diagram for CTestPortStruct< CDataStruct >:

Public Member Functions
	CTestPortStruct (int64_t BaseAddress=0)
virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node.
virtual EInterfaceType	GetPrincipalInterfaceType () const
	Get the type of the main interface of a node.
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	MemSet (const char FillValue)
void	ResetStatistics ()
	Resets the read/write statistics.
int64_t	GetNumReads ()
	Returns the number of reads since lastReset Statistics.
int64_t	GetNumWrites ()
	Returns the number of writes since lastReset Statistics.
Public Member Functions inherited from CPortImpl
	CPortImpl ()
	Constructor.
virtual	~CPortImpl ()
	Destructor.
virtual EAccessMode	GetAccessMode () const =0
	Get the access mode of the node.
virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)=0
	Reads a chunk of bytes from the port.
virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)=0
	Writes a chunk of bytes to the port.
virtual 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 endianness swap.
virtual void	Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
	sends the commands to the camera.
void	InvalidateNode ()

Protected Attributes
int64_t	m_NumReads
	Number of reads since last reset.
int64_t	m_NumWrites
	Number of writes since last reset.
int64_t	m_BaseAddress
	the base address used for the struct
Protected Attributes inherited from CPortImpl
CNodePtr	m_ptrPort
	Pointer to the node holding a reference to this implementation.

Detailed Description

template<class CDataStruct>
class Spinnaker::GenApi::CTestPortStruct< CDataStruct >

Implements a register spaces based on a C++ struct.

Constructor & Destructor Documentation

CTestPortStruct()

template<class CDataStruct >

CTestPortStruct ( int64_t  BaseAddress = 0 )

inline

Member Function Documentation

GetAccessMode()

template<class CDataStruct >

virtual EAccessMode GetAccessMode ( ) const

inlinevirtual

Get the access mode of the node.

Implements CPortImpl.

GetNumReads()

template<class CDataStruct >

int64_t GetNumReads ( )

inline

Returns the number of reads since lastReset Statistics.

GetNumWrites()

template<class CDataStruct >

int64_t GetNumWrites ( )

inline

Returns the number of writes since lastReset Statistics.

GetPrincipalInterfaceType()

template<class CDataStruct >

virtual EInterfaceType GetPrincipalInterfaceType ( ) const

inlinevirtual

Get the type of the main interface of a node.

MemSet()

template<class CDataStruct >

void MemSet ( const char  FillValue )

inline

Read()

template<class CDataStruct >

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

inlinevirtual

Reads a chunk of bytes from the port.

Implements CPortImpl.

ResetStatistics()

template<class CDataStruct >

void ResetStatistics ( )

inline

Resets the read/write statistics.

Write()

template<class CDataStruct >

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

inlinevirtual

Writes a chunk of bytes to the port.

Implements CPortImpl.

Member Data Documentation

m_BaseAddress

template<class CDataStruct >

int64_t m_BaseAddress

protected

the base address used for the struct

m_NumReads

template<class CDataStruct >

int64_t m_NumReads

protected

Number of reads since last reset.

m_NumWrites

template<class CDataStruct >

int64_t m_NumWrites

protected

Number of writes since last reset.

---

The documentation for this class was generated from the following file:

• include/SpinGenApi/StructPort.h