GENAPI_NAMESPACE::CEventPort Class Reference

Port attachable to an event. More...

#include <EventPort.h>

List of all members.

Public Member Functions
void	AttachEvent (uint8_t *pBaseAddress, int64_t Length)
	Attaches the an Event to the EventPort.
bool	AttachNode (GENAPI_NAMESPACE::INode *pNode)
	Attaches to the Node.
	CEventPort (INode *pNode=NULL)
	Constructor; can attach to a node.
bool	CheckEventID (uint8_t *pEventIDBuffer, int EventIDLength) const
	Checks if a EventID matches.
bool	CheckEventID (uint64_t EventID) const
	Checks if a EventID matches, version using uint64_t ID representation.
void	DetachEvent ()
	Detaches the Event from the EventPort.
void	DetachNode ()
	Detaches from the Node.
virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node.
int	GetEventIDLength ()
	Gets the EventID length.
virtual EInterfaceType	GetPrincipalInterfaceType () const
	Get the type of the main interface of a node.
virtual EYesNo	GetSwapEndianess ()
	Determines if the port adapter must perform an endianess swap.
void	InvalidateNode ()
virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port.
virtual void	SetPortImpl (GENAPI_NAMESPACE::IPort *pPort)
	Called from the port node to give the chunk port a pointer to itself.
virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port.
	~CEventPort ()
	Destructor; detaches from the port.
Protected Member Functions
CLock &	GetLock () const
Private Member Functions
void	ResetEventDataBuffer ()
Private Attributes
int64_t	m_EventDataAlloc
	Space allocated for the data.
int64_t	m_EventDataLength
	Length of the data.
int	m_EventIDLength
	Length of the EventID buffer.
uint64_t	m_EventIDNumber
	Event ID stored as a number (for more straightforward access)
bool	m_EventIDNumberValid
	indicates if the m_EventIDNumber is valid (could be invalid eg. if the ID does not fit in 64-bit range)
bool	m_IsAttachedToPortNode
	indicates if the object is attached to a port node or another node type
uint8_t *	m_pEventData
	Pointer to the begin of the buffer.
uint8_t *	m_pEventIDBuffer
	Binary version of the EventID.
CNodePtr	m_ptrNode
	Pointer to the node holding a reference to this implementation.

---

Detailed Description

Port attachable to an event.

Definition at line 45 of file EventPort.h.

---

Constructor & Destructor Documentation

GENAPI_NAMESPACE::CEventPort::CEventPort

(

INode *

pNode = NULL

)

Constructor; can attach to a node.

GENAPI_NAMESPACE::CEventPort::~CEventPort

(

)

Destructor; detaches from the port.

---

Member Function Documentation

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

Attaches the an Event to the EventPort.

bool GENAPI_NAMESPACE::CEventPort::AttachNode

(

GENAPI_NAMESPACE::INode *

pNode

)

Attaches to the Node.

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

Checks if a EventID matches.

bool GENAPI_NAMESPACE::CEventPort::CheckEventID

(

uint64_t

EventID

)

const

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

void GENAPI_NAMESPACE::CEventPort::DetachEvent

(

)

Detaches the Event from the EventPort.

void GENAPI_NAMESPACE::CEventPort::DetachNode

(

)

Detaches from the Node.

virtual EAccessMode GENAPI_NAMESPACE::CEventPort::GetAccessMode

(

)

const [virtual]

Get the access mode of the node.

int GENAPI_NAMESPACE::CEventPort::GetEventIDLength

(

)

Gets the EventID length.

CLock& GENAPI_NAMESPACE::CEventPort::GetLock

(

)

const [protected]

virtual EInterfaceType GENAPI_NAMESPACE::CEventPort::GetPrincipalInterfaceType

(

)

const [virtual]

Get the type of the main interface of a node.

virtual EYesNo GENAPI_NAMESPACE::CEventPort::GetSwapEndianess

(

)

[virtual]

Determines if the port adapter must perform an endianess swap.

void GENAPI_NAMESPACE::CEventPort::InvalidateNode

(

)

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

Reads a chunk of bytes from the port.

void GENAPI_NAMESPACE::CEventPort::ResetEventDataBuffer

(

)

[private]

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.

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

int64_t GENAPI_NAMESPACE::CEventPort::m_EventDataAlloc [private]

Space allocated for the data.

Definition at line 126 of file EventPort.h.

int64_t GENAPI_NAMESPACE::CEventPort::m_EventDataLength [private]

Length of the data.

Definition at line 123 of file EventPort.h.

int GENAPI_NAMESPACE::CEventPort::m_EventIDLength [private]

Length of the EventID buffer.

Definition at line 137 of file EventPort.h.

uint64_t GENAPI_NAMESPACE::CEventPort::m_EventIDNumber [private]

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

Definition at line 143 of file EventPort.h.

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 146 of file EventPort.h.

bool GENAPI_NAMESPACE::CEventPort::m_IsAttachedToPortNode [private]

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

Definition at line 140 of file EventPort.h.

uint8_t* GENAPI_NAMESPACE::CEventPort::m_pEventData [private]

Pointer to the begin of the buffer.

Definition at line 120 of file EventPort.h.

uint8_t* GENAPI_NAMESPACE::CEventPort::m_pEventIDBuffer [private]

Binary version of the EventID.

Definition at line 134 of file EventPort.h.

CNodePtr GENAPI_NAMESPACE::CEventPort::m_ptrNode [private]

Pointer to the node holding a reference to this implementation.

Definition at line 130 of file EventPort.h.

---

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

• EventPort.h