Class Spinnaker::GenApi::CEventPort

ClassList > GenApi > CEventPort

Port attachable to an event.

• #include <EventPort.h>

Inherits the following classes: IPortConstruct

Public Functions

Type	Name
void	AttachEvent (uint8_t * pBaseAddress, int64_t Length)
bool	AttachNode (::Spinnaker::GenApi::INode * pNode)
	CEventPort (INode * pNode=NULL)
bool	CheckEventID (uint8_t * pEventIDBuffer, int EventIDLength)
bool	CheckEventID (uint64_t EventID)
void	DetachEvent ()
void	DetachNode ()
virtual EAccessMode	GetAccessMode () const
int	GetEventIDLength ()
virtual EInterfaceType	GetPrincipalInterfaceType () const
virtual EYesNo	GetSwapEndianess ()
void	InvalidateNode ()
virtual void	Read (void * pBuffer, int64_t Address, int64_t Length)
virtual void	SetPortImpl (::Spinnaker::GenApi::IPort * pPort)
virtual void	Write (const void * pBuffer, int64_t Address, int64_t Length)
	~CEventPort ()

Protected Attributes

Type	Name
void *	m_pEventPort
CNodePtr	m_pNode
std::shared_ptr< PortAdapter >	m_pPortAdapter

Public Functions Documentation

function AttachEvent

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

Attaches the an Event to the EventPort

---

function AttachNode

bool GenApi::CEventPort::AttachNode (
    ::Spinnaker::GenApi::INode * pNode
) 

Attaches to the Node

---

function CEventPort

GenApi::CEventPort::CEventPort (
    INode * pNode=NULL
) 

Constructor; can attach to a node

---

function CheckEventID [1/2]

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

Checks if a EventID matches

---

function CheckEventID [2/2]

bool GenApi::CEventPort::CheckEventID (
    uint64_t EventID
) 

Checks if a EventID matches, version using uint64_t ID representation

---

function DetachEvent

void GenApi::CEventPort::DetachEvent () 

Detaches the Event from the EventPort

---

function DetachNode

void GenApi::CEventPort::DetachNode () 

Detaches from the Node

---

function GetAccessMode

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

Get the access mode of the node

---

function GetEventIDLength

int GenApi::CEventPort::GetEventIDLength () 

Gets the EventID length

---

function GetPrincipalInterfaceType

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

Get the type of the main interface of a node

---

function GetSwapEndianess

inline virtual EYesNo GenApi::CEventPort::GetSwapEndianess () 

Determines if the port adapter must perform an endianness swap

---

function InvalidateNode

void GenApi::CEventPort::InvalidateNode () 

---

function Read

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

Reads a chunk of bytes from the port

---

function SetPortImpl

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

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

---

function Write

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

Writes a chunk of bytes to the port

---

function ~CEventPort

GenApi::CEventPort::~CEventPort () 

Destructor; detaches from the port

---

Protected Attributes Documentation

variable m_pEventPort

void* Spinnaker::GenApi::CEventPort::m_pEventPort;

---

variable m_pNode

CNodePtr Spinnaker::GenApi::CEventPort::m_pNode;

---

variable m_pPortAdapter

std::shared_ptr<PortAdapter> Spinnaker::GenApi::CEventPort::m_pPortAdapter;

---

---

The documentation for this class was generated from the following file /workspace/include/SpinGenApi/EventPort.h