Public Member Functions | Protected Attributes | List of all members
GENAPI_NAMESPACE::CTestPortStruct< CDataStruct > Class Template Reference

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

#include <StructPort.h>

Inheritance diagram for GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >:
Inheritance graph
[legend]

Public Member Functions

 CTestPortStruct (int64_t BaseAddress=0)
 
virtual GENAPI_NAMESPACE::EAccessMode GetAccessMode () const
 Get the access mode of the node. More...
 
int64_t GetNumReads ()
 Returns the number of reads since lastReset Statistics. More...
 
int64_t GetNumWrites ()
 Returns the number of writes since lastReset Statistics. More...
 
virtual GENAPI_NAMESPACE::EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a node. More...
 
void MemSet (const char FillValue)
 
virtual void Read (void *pBuffer, int64_t Address, int64_t Length)
 Reads a chunk of bytes from the port. More...
 
void ResetStatistics ()
 Resets the read/write statistics. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)
 Writes a chunk of bytes to the port. More...
 
- Public Member Functions inherited from GENAPI_NAMESPACE::CPortImpl
 CPortImpl ()
 Constructor. More...
 
virtual EYesNo GetSwapEndianess ()
 Determines if the port adapter must perform an endianess swap. More...
 
void InvalidateNode ()
 
virtual void Replay (IPortWriteList *pPortRecorder, bool Invalidate=true)
 sends the commands to the camera. More...
 
virtual void SetPortImpl (IPort *pPort)
 Sets pointer the real port implementation; this function may called only once. More...
 
virtual ~CPortImpl ()
 Destructor. More...
 

Protected Attributes

int64_t m_BaseAddress
 the base address used for the struct More...
 
int64_t m_NumReads
 Number of reads since last reset. More...
 
int64_t m_NumWrites
 Number of writes since last reset. More...
 

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

template<class CDataStruct >
GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::CTestPortStruct ( int64_t  BaseAddress = 0)
inline

Definition at line 45 of file StructPort.h.

Member Function Documentation

template<class CDataStruct >
virtual GENAPI_NAMESPACE::EAccessMode GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetAccessMode ( ) const
inlinevirtual

Get the access mode of the node.

Implements GENAPI_NAMESPACE::CPortImpl.

Definition at line 57 of file StructPort.h.

template<class CDataStruct >
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetNumReads ( )
inline

Returns the number of reads since lastReset Statistics.

Definition at line 117 of file StructPort.h.

template<class CDataStruct >
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetNumWrites ( )
inline

Returns the number of writes since lastReset Statistics.

Definition at line 123 of file StructPort.h.

template<class CDataStruct >
virtual GENAPI_NAMESPACE::EInterfaceType GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::GetPrincipalInterfaceType ( ) const
inlinevirtual

Get the type of the main interface of a node.

Definition at line 63 of file StructPort.h.

template<class CDataStruct >
void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::MemSet ( const char  FillValue)
inline

Definition at line 100 of file StructPort.h.

template<class CDataStruct >
virtual void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::Read ( void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
inlinevirtual

Reads a chunk of bytes from the port.

Implements GENAPI_NAMESPACE::CPortImpl.

Definition at line 73 of file StructPort.h.

template<class CDataStruct >
void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::ResetStatistics ( )
inline

Resets the read/write statistics.

Definition at line 110 of file StructPort.h.

template<class CDataStruct >
virtual void GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
inlinevirtual

Writes a chunk of bytes to the port.

Implements GENAPI_NAMESPACE::CPortImpl.

Definition at line 85 of file StructPort.h.

Member Data Documentation

template<class CDataStruct >
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::m_BaseAddress
protected

the base address used for the struct

Definition at line 136 of file StructPort.h.

template<class CDataStruct >
int64_t GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >::m_NumReads
protected

Number of reads since last reset.

Definition at line 130 of file StructPort.h.

template<class CDataStruct >
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:


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Thu Jun 6 2019 19:10:56