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

Port attachable to an event. More...

#include <EventPort.h>

Inheritance diagram for GENAPI_NAMESPACE::CEventPort:

Public Member Functions

void AttachEvent (uint8_t *pBaseAddress, int64_t Length)
 Attaches the an Event to the EventPort. More...
 
bool AttachNode (GENAPI_NAMESPACE::INode *pNode)
 Attaches to the Node. More...
 
 CEventPort (INode *pNode=NULL)
 Constructor; can attach to a node. More...
 
bool CheckEventID (uint64_t EventID) const
 Checks if a EventID matches, version using uint64_t ID representation. More...
 
bool CheckEventID (uint8_t *pEventIDBuffer, int EventIDLength) const
 Checks if a EventID matches. More...
 
void DetachEvent ()
 Detaches the Event from the EventPort. More...
 
void DetachNode ()
 Detaches from the Node. More...
 
virtual EAccessMode GetAccessMode () const
 Get the access mode of the node. More...
 
int GetEventIDLength ()
 Gets the EventID length. More...
 
virtual EInterfaceType GetPrincipalInterfaceType () const
 Get the type of the main interface of a 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)
 Reads a chunk of bytes from the port. More...
 
virtual void SetPortImpl (GENAPI_NAMESPACE::IPort *pPort)
 Called from the port node to give the chunk port a pointer to itself. More...
 
virtual void SetPortImpl (GENAPI_NAMESPACE::IPortStacked *pPort)
 Called from the port node to give the chunk port a pointer to itself. More...
 
virtual void Write (const void *pBuffer, int64_t Address, int64_t Length)
 Writes a chunk of bytes to the port. More...
 
 ~CEventPort ()
 Destructor; detaches from the port. More...
 

Protected Member Functions

CLockGetLock () const
 

Private Member Functions

 CEventPort (const CEventPort &)
 
CEventPortoperator= (const CEventPort &)
 
void ResetEventDataBuffer ()
 

Private Attributes

int64_t m_EventDataAlloc
 Space allocated for the data. More...
 
int64_t m_EventDataLength
 Length of the data. More...
 
int m_EventIDLength
 Length of the EventID buffer. More...
 
uint64_t m_EventIDNumber
 Event ID stored as a number (for more straightforward access) More...
 
bool m_EventIDNumberValid
 indicates if the m_EventIDNumber is valid (could be invalid eg. if the ID does not fit in 64-bit range) More...
 
bool m_IsAttachedToPortNode
 indicates if the object is attached to a port node or another node type More...
 
uint8_t * m_pEventData
 Pointer to the begin of the buffer. More...
 
uint8_t * m_pEventIDBuffer
 Binary version of the EventID. More...
 
CNodePtr m_ptrNode
 Pointer to the node holding a reference to this implementation. More...
 

Detailed Description

Port attachable to an event.

Definition at line 45 of file EventPort.h.

Constructor & Destructor Documentation

◆ CEventPort() [1/2]

GENAPI_NAMESPACE::CEventPort::CEventPort ( INode pNode = NULL)

Constructor; can attach to a node.

◆ ~CEventPort()

GENAPI_NAMESPACE::CEventPort::~CEventPort ( )

Destructor; detaches from the port.

◆ CEventPort() [2/2]

GENAPI_NAMESPACE::CEventPort::CEventPort ( const CEventPort )
private

Member Function Documentation

◆ AttachEvent()

void GENAPI_NAMESPACE::CEventPort::AttachEvent ( uint8_t *  pBaseAddress,
int64_t  Length 
)

Attaches the an Event to the EventPort.

◆ AttachNode()

bool GENAPI_NAMESPACE::CEventPort::AttachNode ( GENAPI_NAMESPACE::INode pNode)

Attaches to the Node.

◆ CheckEventID() [1/2]

bool GENAPI_NAMESPACE::CEventPort::CheckEventID ( uint64_t  EventID) const

Checks if a EventID matches, version using uint64_t ID representation.

◆ CheckEventID() [2/2]

bool GENAPI_NAMESPACE::CEventPort::CheckEventID ( uint8_t *  pEventIDBuffer,
int  EventIDLength 
) const

Checks if a EventID matches.

◆ DetachEvent()

void GENAPI_NAMESPACE::CEventPort::DetachEvent ( )

Detaches the Event from the EventPort.

◆ DetachNode()

void GENAPI_NAMESPACE::CEventPort::DetachNode ( )

Detaches from the Node.

◆ GetAccessMode()

virtual EAccessMode GENAPI_NAMESPACE::CEventPort::GetAccessMode ( ) const
virtual

Get the access mode of the node.

◆ GetEventIDLength()

int GENAPI_NAMESPACE::CEventPort::GetEventIDLength ( )

Gets the EventID length.

◆ GetLock()

CLock& GENAPI_NAMESPACE::CEventPort::GetLock ( ) const
protected

◆ GetPrincipalInterfaceType()

virtual EInterfaceType GENAPI_NAMESPACE::CEventPort::GetPrincipalInterfaceType ( ) const
virtual

Get the type of the main interface of a node.

◆ GetSwapEndianess()

virtual EYesNo GENAPI_NAMESPACE::CEventPort::GetSwapEndianess ( )
virtual

Determines if the port adapter must perform an endianess swap.

◆ InvalidateNode()

void GENAPI_NAMESPACE::CEventPort::InvalidateNode ( )

◆ operator=()

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

◆ Read()

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

Reads a chunk of bytes from the port.

◆ ResetEventDataBuffer()

void GENAPI_NAMESPACE::CEventPort::ResetEventDataBuffer ( )
private

◆ SetPortImpl() [1/2]

virtual void GENAPI_NAMESPACE::CEventPort::SetPortImpl ( GENAPI_NAMESPACE::IPort pPort)
virtual

Called from the port node to give the chunk port a pointer to itself.

◆ SetPortImpl() [2/2]

virtual void GENAPI_NAMESPACE::CEventPort::SetPortImpl ( GENAPI_NAMESPACE::IPortStacked pPort)
virtual

Called from the port node to give the chunk port a pointer to itself.

◆ Write()

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

Writes a chunk of bytes to the port.

Member Data Documentation

◆ m_EventDataAlloc

int64_t GENAPI_NAMESPACE::CEventPort::m_EventDataAlloc
private

Space allocated for the data.

Definition at line 132 of file EventPort.h.

◆ m_EventDataLength

int64_t GENAPI_NAMESPACE::CEventPort::m_EventDataLength
private

Length of the data.

Definition at line 129 of file EventPort.h.

◆ m_EventIDLength

int GENAPI_NAMESPACE::CEventPort::m_EventIDLength
private

Length of the EventID buffer.

Definition at line 147 of file EventPort.h.

◆ m_EventIDNumber

uint64_t GENAPI_NAMESPACE::CEventPort::m_EventIDNumber
private

Event ID stored as a number (for more straightforward access)

Definition at line 153 of file EventPort.h.

◆ m_EventIDNumberValid

bool GENAPI_NAMESPACE::CEventPort::m_EventIDNumberValid
private

indicates if the m_EventIDNumber is valid (could be invalid eg. if the ID does not fit in 64-bit range)

Definition at line 156 of file EventPort.h.

◆ m_IsAttachedToPortNode

bool GENAPI_NAMESPACE::CEventPort::m_IsAttachedToPortNode
private

indicates if the object is attached to a port node or another node type

Definition at line 150 of file EventPort.h.

◆ m_pEventData

uint8_t* GENAPI_NAMESPACE::CEventPort::m_pEventData
private

Pointer to the begin of the buffer.

Definition at line 126 of file EventPort.h.

◆ m_pEventIDBuffer

uint8_t* GENAPI_NAMESPACE::CEventPort::m_pEventIDBuffer
private

Binary version of the EventID.

Definition at line 144 of file EventPort.h.

◆ m_ptrNode

CNodePtr GENAPI_NAMESPACE::CEventPort::m_ptrNode
private

Pointer to the node holding a reference to this implementation.

Definition at line 138 of file EventPort.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:12