Class Spinnaker::GenApi::CTestPortStruct

template <class CDataStruct>

ClassList > GenApi > CTestPortStruct

More...

• #include <StructPort.h>

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

Public Functions

Type	Name
	CTestPortStruct (int64_t BaseAddress=0)
virtual EAccessMode	GetAccessMode () const
int64_t	GetNumReads ()
int64_t	GetNumWrites ()
virtual EInterfaceType	GetPrincipalInterfaceType () const
void	MemSet (const char FillValue)
virtual void	Read (void * pBuffer, int64_t Address, int64_t Length)
void	ResetStatistics ()
virtual void	Write (const void * pBuffer, int64_t Address, int64_t Length)

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

Type	Name
int64_t	m_BaseAddress
int64_t	m_NumReads
int64_t	m_NumWrites

Protected Attributes inherited from Spinnaker::GenApi::CPortImpl

See Spinnaker::GenApi::CPortImpl

Type	Name
CNodePtr	m_ptrPort

Detailed Description

Implements a register spaces based on a C++ struct

Public Functions Documentation

function CTestPortStruct

inline GenApi::CTestPortStruct::CTestPortStruct (
    int64_t BaseAddress=0
) 

---

function GetAccessMode

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

Get the access mode of the node

Implements Spinnaker::GenApi::CPortImpl::GetAccessMode

---

function GetNumReads

inline int64_t GenApi::CTestPortStruct::GetNumReads () 

Returns the number of reads since lastReset Statistics

---

function GetNumWrites

inline int64_t GenApi::CTestPortStruct::GetNumWrites () 

Returns the number of writes since lastReset Statistics

---

function GetPrincipalInterfaceType

inline virtual EInterfaceType GenApi::CTestPortStruct::GetPrincipalInterfaceType () const

Get the type of the main interface of a node

---

function MemSet

inline void GenApi::CTestPortStruct::MemSet (
    const  char FillValue
) 

---

function Read

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

Reads a chunk of bytes from the port

Implements Spinnaker::GenApi::CPortImpl::Read

---

function ResetStatistics

inline void GenApi::CTestPortStruct::ResetStatistics () 

Resets the read/write statistics

---

function Write

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

Writes a chunk of bytes to the port

Implements Spinnaker::GenApi::CPortImpl::Write

---

Protected Attributes Documentation

variable m_BaseAddress

int64_t Spinnaker::GenApi::CTestPortStruct< CDataStruct >::m_BaseAddress;

the base address used for the struct

---

variable m_NumReads

int64_t Spinnaker::GenApi::CTestPortStruct< CDataStruct >::m_NumReads;

Number of reads since last reset

---

variable m_NumWrites

int64_t Spinnaker::GenApi::CTestPortStruct< CDataStruct >::m_NumWrites;

Number of writes since last reset

---

---

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