Implements a register spaces based on a C++ struct. More...
#include <StructPort.h>
Public Member Functions | |
| CTestPortStruct (int64_t BaseAddress=0) | |
| virtual GENAPI_NAMESPACE::EAccessMode | GetAccessMode () const |
| Get the access mode of the node. | |
| int64_t | GetNumReads () |
| Returns the number of reads since lastReset Statistics. | |
| int64_t | GetNumWrites () |
| Returns the number of writes since lastReset Statistics. | |
| virtual GENAPI_NAMESPACE::EInterfaceType | GetPrincipalInterfaceType () const |
| Get the type of the main interface of a node. | |
| void | MemSet (const char FillValue) |
| virtual void | Read (void *pBuffer, int64_t Address, int64_t Length) |
| Reads a chunk of bytes from the port. | |
| void | ResetStatistics () |
| Resets the read/write statistics. | |
| virtual void | Write (const void *pBuffer, int64_t Address, int64_t Length) |
| Writes a chunk of bytes to the port. | |
Protected Attributes | |
| int64_t | m_BaseAddress |
| the base address used for the struct | |
| int64_t | m_NumReads |
| Number of reads since last reset. | |
| int64_t | m_NumWrites |
| Number of writes since last reset. | |
Detailed Description
template<class CDataStruct>
class GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >
Implements a register spaces based on a C++ struct.
Definition at line 42 of file StructPort.h.
Constructor & Destructor Documentation
| GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::CTestPortStruct | ( | int64_t | BaseAddress = 0 | ) | [inline] |
Definition at line 45 of file StructPort.h.
Member Function Documentation
| virtual GENAPI_NAMESPACE::EAccessMode GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetAccessMode | ( | ) | const [inline, virtual] |
Get the access mode of the node.
Implements GENAPI_NAMESPACE::CPortImpl.
Definition at line 57 of file StructPort.h.
| int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetNumReads | ( | ) | [inline] |
Returns the number of reads since lastReset Statistics.
Definition at line 117 of file StructPort.h.
| int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetNumWrites | ( | ) | [inline] |
Returns the number of writes since lastReset Statistics.
Definition at line 123 of file StructPort.h.
| virtual GENAPI_NAMESPACE::EInterfaceType GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetPrincipalInterfaceType | ( | ) | const [inline, virtual] |
Get the type of the main interface of a node.
Definition at line 63 of file StructPort.h.
| void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::MemSet | ( | const char | FillValue | ) | [inline] |
Definition at line 100 of file StructPort.h.
| virtual void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::Read | ( | void * | pBuffer, |
| int64_t | Address, | ||
| int64_t | Length | ||
| ) | [inline, virtual] |
Reads a chunk of bytes from the port.
Implements GENAPI_NAMESPACE::CPortImpl.
Definition at line 73 of file StructPort.h.
| void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::ResetStatistics | ( | ) | [inline] |
Resets the read/write statistics.
Definition at line 110 of file StructPort.h.
| virtual void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::Write | ( | const void * | pBuffer, |
| int64_t | Address, | ||
| int64_t | Length | ||
| ) | [inline, virtual] |
Writes a chunk of bytes to the port.
Implements GENAPI_NAMESPACE::CPortImpl.
Definition at line 85 of file StructPort.h.
Member Data Documentation
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::m_BaseAddress [protected] |
the base address used for the struct
Definition at line 136 of file StructPort.h.
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::m_NumReads [protected] |
Number of reads since last reset.
Definition at line 130 of file StructPort.h.
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::m_NumWrites [protected] |
Number of writes since last reset.
Definition at line 133 of file StructPort.h.
The documentation for this class was generated from the following file: