CEventPort Class Reference

Port attachable to an event. More...

#include <EventPort.h>

Inheritance diagram for CEventPort:

Public Member Functions
	CEventPort (INode *pNode=NULL)
	Constructor; can attach to a node.
	~CEventPort ()
	Destructor; detaches from the port.
virtual EAccessMode	GetAccessMode () const
	Get the access mode of the node.
virtual EInterfaceType	GetPrincipalInterfaceType () const
	Get the type of the main interface of a node.
virtual void	Read (void *pBuffer, int64_t Address, int64_t Length)
	Reads a chunk of bytes from the port.
virtual void	Write (const void *pBuffer, int64_t Address, int64_t Length)
	Writes a chunk of bytes to the port.
virtual void	SetPortImpl (::Spinnaker::GenApi::IPort *pPort)
	Called from the port node to give the chunk port a pointer to itself.
virtual EYesNo	GetSwapEndianess ()
	Determines if the port adapter must perform an endianness swap.
void	InvalidateNode ()
bool	AttachNode (::Spinnaker::GenApi::INode *pNode)
	Attaches to the Node.
void	DetachNode ()
	Detaches from the Node.
int	GetEventIDLength ()
	Gets the EventID length.
bool	CheckEventID (uint8_t *pEventIDBuffer, int EventIDLength)
	Checks if a EventID matches.
bool	CheckEventID (uint64_t EventID)
	Checks if a EventID matches, version using uint64_t ID representation.
void	AttachEvent (uint8_t *pBaseAddress, int64_t Length)
	Attaches the an Event to the EventPort.
void	DetachEvent ()
	Detaches the Event from the EventPort.

Protected Attributes
CNodePtr	m_pNode
std::shared_ptr< PortAdapter >	m_pPortAdapter
void *	m_pEventPort

Detailed Description

Port attachable to an event.

Constructor & Destructor Documentation

CEventPort()

CEventPort

(

INode *

pNode = NULL

)

Constructor; can attach to a node.

~CEventPort()

~CEventPort

(

)

Destructor; detaches from the port.

Member Function Documentation

AttachEvent()

void AttachEvent	(	uint8_t *	pBaseAddress,
		int64_t	Length
	)

Attaches the an Event to the EventPort.

AttachNode()

bool AttachNode

(

::Spinnaker::GenApi::INode *

pNode

)

Attaches to the Node.

CheckEventID() [1/2]

bool CheckEventID

(

uint64_t

EventID

)

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

CheckEventID() [2/2]

bool CheckEventID	(	uint8_t *	pEventIDBuffer,
		int	EventIDLength
	)

Checks if a EventID matches.

DetachEvent()

void DetachEvent

(

)

Detaches the Event from the EventPort.

DetachNode()

void DetachNode

(

)

Detaches from the Node.

GetAccessMode()

virtual EAccessMode GetAccessMode ( ) const

virtual

Get the access mode of the node.

GetEventIDLength()

int GetEventIDLength

(

)

Gets the EventID length.

GetPrincipalInterfaceType()

virtual EInterfaceType GetPrincipalInterfaceType ( ) const

virtual

Get the type of the main interface of a node.

GetSwapEndianess()

virtual EYesNo GetSwapEndianess ( )

inlinevirtual

Determines if the port adapter must perform an endianness swap.

InvalidateNode()

void InvalidateNode

(

)

Read()

virtual void Read ( void *  pBuffer, int64_t  Address, int64_t  Length  )

virtual

Reads a chunk of bytes from the port.

SetPortImpl()

virtual void SetPortImpl ( ::Spinnaker::GenApi::IPort *  pPort )

virtual

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

Write()

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

virtual

Writes a chunk of bytes to the port.

Member Data Documentation

m_pEventPort

void* m_pEventPort

protected

m_pNode

CNodePtr m_pNode

protected

m_pPortAdapter

std::shared_ptr<PortAdapter> m_pPortAdapter

protected

---

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

• include/SpinGenApi/EventPort.h