All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
GENAPI_NAMESPACE::CPortWriteList Class Reference

Container holding a list of port write commands. More...

#include <PortWriteList.h>

Inheritance diagram for GENAPI_NAMESPACE::CPortWriteList:

Classes

struct  WriteCommand_t
 The data associated with a write command. More...
 

Public Member Functions

 CPortWriteList ()
 Constructor. More...
 
virtual int64_t GetCookie ()
 Gets the cookie a port implementation may have set for caching a command list. More...
 
virtual void Replay (IPort *pPort)
 Replays the write command to the given port interface. More...
 
virtual void SetCookie (const int64_t Value)
 Sets a cookie in case the port implementation want to cache a command list. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)
 Writes a chunk of bytes to the port. More...
 
virtual ~CPortWriteList ()
 Destructor. More...
 

Protected Attributes

int64_t m_Cookie
 A cookie helper for caching. More...
 
std::list< WriteCommand_t > * m_pWriteCommands
 a list holding the write commands More...
 

Private Member Functions

 CPortWriteList (const CPortWriteList &)
 
CPortWriteListoperator= (const CPortWriteList &)
 

Detailed Description

Container holding a list of port write commands.

Definition at line 46 of file PortWriteList.h.

Constructor & Destructor Documentation

◆ CPortWriteList() [1/2]

GENAPI_NAMESPACE::CPortWriteList::CPortWriteList ( )

Constructor.

◆ ~CPortWriteList()

virtual GENAPI_NAMESPACE::CPortWriteList::~CPortWriteList ( )
virtual

Destructor.

◆ CPortWriteList() [2/2]

GENAPI_NAMESPACE::CPortWriteList::CPortWriteList ( const CPortWriteList )
private

Member Function Documentation

◆ GetCookie()

virtual int64_t GENAPI_NAMESPACE::CPortWriteList::GetCookie ( )
virtual

Gets the cookie a port implementation may have set for caching a command list.

◆ operator=()

CPortWriteList& GENAPI_NAMESPACE::CPortWriteList::operator= ( const CPortWriteList )
private

◆ Replay()

virtual void GENAPI_NAMESPACE::CPortWriteList::Replay ( IPort pPort)
virtual

Replays the write command to the given port interface.

◆ SetCookie()

virtual void GENAPI_NAMESPACE::CPortWriteList::SetCookie ( const int64_t  Value)
virtual

Sets a cookie in case the port implementation want to cache a command list.

◆ Write()

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

Writes a chunk of bytes to the port.

Member Data Documentation

◆ m_Cookie

int64_t GENAPI_NAMESPACE::CPortWriteList::m_Cookie
protected

A cookie helper for caching.

Definition at line 88 of file PortWriteList.h.

◆ m_pWriteCommands

std::list<WriteCommand_t>* GENAPI_NAMESPACE::CPortWriteList::m_pWriteCommands
protected

a list holding the write commands

Definition at line 85 of file PortWriteList.h.


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


rc_genicam_api
Author(s): Heiko Hirschmueller
autogenerated on Wed Dec 4 2024 03:10:13