Public Member Functions | Private Attributes | List of all members
GENAPI_NAMESPACE::CPortImpl Class Referenceabstract

Standard implementation for a port ! More...

#include <PortImpl.h>

Inheritance diagram for GENAPI_NAMESPACE::CPortImpl:
Inheritance graph
[legend]

Public Member Functions

 CPortImpl ()
 Constructor. More...
 
virtual EAccessMode GetAccessMode () const =0
 Get the access mode of the node. More...
 
virtual EYesNo GetSwapEndianess ()
 Determines if the port adapter must perform an endianess swap. More...
 
void InvalidateNode ()
 
virtual void Read (void *pBuffer, int64_t Address, int64_t Length)=0
 Reads a chunk of bytes from the port. More...
 
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 void Write (const void *pBuffer, int64_t Address, int64_t Length)=0
 Writes a chunk of bytes to the port. More...
 
virtual ~CPortImpl ()
 Destructor. More...
 

Private Attributes

CNodePtr m_ptrPort
 Pointer to the node holding a reference to this implementation. More...
 

Detailed Description

Standard implementation for a port !

Definition at line 58 of file PortImpl.h.

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CPortImpl::CPortImpl ( )
inline

Constructor.

Definition at line 62 of file PortImpl.h.

virtual GENAPI_NAMESPACE::CPortImpl::~CPortImpl ( )
inlinevirtual

Destructor.

Definition at line 67 of file PortImpl.h.

Member Function Documentation

virtual EAccessMode GENAPI_NAMESPACE::CPortImpl::GetAccessMode ( ) const
pure virtual

Get the access mode of the node.

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

Implemented in GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >.

virtual EYesNo GENAPI_NAMESPACE::CPortImpl::GetSwapEndianess ( )
inlinevirtual

Determines if the port adapter must perform an endianess swap.

Definition at line 101 of file PortImpl.h.

void GENAPI_NAMESPACE::CPortImpl::InvalidateNode ( )
inline

Definition at line 127 of file PortImpl.h.

virtual void GENAPI_NAMESPACE::CPortImpl::Read ( void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Reads a chunk of bytes from the port.

Implemented in GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >.

virtual void GENAPI_NAMESPACE::CPortImpl::Replay ( IPortWriteList pPortRecorder,
bool  Invalidate = true 
)
inlinevirtual

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.

Definition at line 117 of file PortImpl.h.

virtual void GENAPI_NAMESPACE::CPortImpl::SetPortImpl ( IPort pPort)
inlinevirtual

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

Definition at line 94 of file PortImpl.h.

virtual void GENAPI_NAMESPACE::CPortImpl::Write ( const void *  pBuffer,
int64_t  Address,
int64_t  Length 
)
pure virtual

Writes a chunk of bytes to the port.

Implemented in GENAPI_NAMESPACE::CTestPortStruct< CDataStruct >.

Member Data Documentation

CNodePtr GENAPI_NAMESPACE::CPortImpl::m_ptrPort
private

Pointer to the node holding a reference to this implementation.

Definition at line 135 of file PortImpl.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Mar 17 2021 02:48:42