Class SpinnakerNET::GenApi::EventPort

ClassList > SpinnakerNET > GenApi > EventPort

Port attachable to an event port node.

• #include <EventPort.h>

Inherits the following classes: SpinnakerNET::GenApi::Port

Public Attributes

Type	Name
property int	EventIDLength = /* multi line expression */ Gets the length of the ID of the attached node.

Public Functions

Type	Name
void __clrcall	AttachEvent (array< Byte > ^ data) Attaches the given data to the attached node.
void __clrcall	AttachEvent (IntPtr baseAddress, int length) Attaches the given event data to the attached node.
bool __clrcall	AttachNode (SpinnakerNET::GenApi::INode ^ node) Attaches an node to this adapter to which the events will be attached.
bool __clrcall	CheckEventID (array< Byte > ^ eventID) Checks whether the given eventID matches the one of the attached node.
void __clrcall	DetachEvent () Detaches the event data from the attached node.
void __clrcall	DetachNode () Detaches the node from this adapter.
__clrcall	EventPort (void) Constructor for an unattached managed EventPort s.
__clrcall	EventPort (SpinnakerNET::GenApi::INode ^ node) Constructor for an attached managed EventPort .
void __clrcall	Invalidate () Invalidates the attached node.
virtual void __clrcall	Read (IntPtr buffer, __int64 address, __int64 length) override Reads length bytes from__address of thisPort to the preallocated memory at__buffer .
virtual void	Read (__int64 address, array<::System::Byte > ^ buffer) override Reads buffer .Length bytes from__address of thisPort to the given__buffer .
virtual void __clrcall	Write (IntPtr buffer, __int64 address, __int64 length) override Writes length bytes to__address of thisPort from the preallocated memory at__buffer .
virtual void	Write (__int64 address, array<::System::Byte > ^ buffer) override Writes buffer .Length bytes to__address of thisPort from the given__buffer .
virtual __clrcall	~EventPort (void) Disposes all managed and unmanaged resources.

Public Static Functions

Type	Name
EventPort __clrcall	FromHandle (IntPtr handle) Creates an EventPort from the given__handle .

Protected Functions

Type	Name
void __clrcall	CheckStatus ()
__clrcall	EventPort (IntPtr handle) Constructor for a native CEventPort from the given__handle .

Public Attributes Documentation

variable EventIDLength

Gets the length of the ID of the attached node.

property int SpinnakerNET::GenApi::EventPort::EventIDLength;

The length in bytes of the event ID.

---

Public Functions Documentation

function AttachEvent [1/2]

Attaches the given data to the attached node.

void  __clrcall SpinnakerNET::GenApi::EventPort::AttachEvent (
    array < Byte > ^ data
) 

Parameters:

• data Event data to attach.

---

function AttachEvent [2/2]

Attaches the given event data to the attached node.

void  __clrcall SpinnakerNET::GenApi::EventPort::AttachEvent (
    IntPtr baseAddress,
    int length
) 

Parameters:

• baseAddress Base address of event data to attach.
• length Event data length to /// attach.

---

function AttachNode

Attaches an node to this adapter to which the events will be attached.

bool  __clrcall SpinnakerNET::GenApi::EventPort::AttachNode (
    SpinnakerNET::GenApi::INode ^ node
) 

Parameters:

• node INode to which the events will be attached to.

Returns:

true on success; false otherwise.

---

function CheckEventID

Checks whether the given eventID matches the one of the attached node.

bool  __clrcall SpinnakerNET::GenApi::EventPort::CheckEventID (
    array < Byte > ^ eventID
) 

Parameters:

• eventID Event ID to be checked.

Returns:

true if the IDs match; false otherwise.

---

function DetachEvent

Detaches the event data from the attached node.

void  __clrcall SpinnakerNET::GenApi::EventPort::DetachEvent () 

---

function DetachNode

Detaches the node from this adapter.

void  __clrcall SpinnakerNET::GenApi::EventPort::DetachNode () 

---

function EventPort [1/3]

Constructor for an unattached managed EventPort s.

__clrcall SpinnakerNET::GenApi::EventPort::EventPort (
    void
) 

---

function EventPort [2/3]

Constructor for an attached managed EventPort .

__clrcall SpinnakerNET::GenApi::EventPort::EventPort (
    SpinnakerNET::GenApi::INode ^ node
) 

Parameters:

• node INode object to attach to.

---

function Invalidate

Invalidates the attached node.

void  __clrcall SpinnakerNET::GenApi::EventPort::Invalidate () 

---

function Read [1/2]

Reads length bytes from__address of thisPort to the preallocated memory at__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::EventPort::Read (
    IntPtr buffer,
    __int64 address,
    __int64 length
) override

Parameters:

• buffer Pointer to the preallocated memory chunk of at least length bytes.
• address Register address to access. Must be multiples of four.
• length Number of bytes to be read from Port. Must be multiples of four.

---

function Read [2/2]

Reads buffer .Length bytes from__address of thisPort to the given__buffer .

virtual void SpinnakerNET::GenApi::EventPort::Read (
    __int64 address,
    array <::System::Byte > ^ buffer
) override

Parameters:

• address Register address to access. Must be multiples of four.
• buffer Array to which the data is written to. Length must be multiples of four.

---

function Write [1/2]

Writes length bytes to__address of thisPort from the preallocated memory at__buffer .

virtual void  __clrcall SpinnakerNET::GenApi::EventPort::Write (
    IntPtr buffer,
    __int64 address,
    __int64 length
) override

Parameters:

• buffer Pointer to the preallocated memory chunk of at least length bytes.
• address Register address to access. Must be multiples of four.
• length Number of bytes to be written to Port. Must be multiples of four.

---

function Write [2/2]

Writes buffer .Length bytes to__address of thisPort from the given__buffer .

virtual void SpinnakerNET::GenApi::EventPort::Write (
    __int64 address,
    array <::System::Byte > ^ buffer
) override

Parameters:

• address Register address to access. Must be multiples of four.
• buffer Array from which the data is written. Length must be multiples of four.

---

function ~EventPort

Disposes all managed and unmanaged resources.

virtual __clrcall SpinnakerNET::GenApi::EventPort::~EventPort (
    void
) 

---

Public Static Functions Documentation

function FromHandle

Creates an EventPort from the given__handle .

static EventPort  __clrcall SpinnakerNET::GenApi::EventPort::FromHandle (
    IntPtr handle
) 

Parameters:

• handle Pointer to native CEventPort object.

---

Protected Functions Documentation

function CheckStatus

void  __clrcall SpinnakerNET::GenApi::EventPort::CheckStatus () 

---

function EventPort [3/3]

Constructor for a native CEventPort from the given__handle .

__clrcall SpinnakerNET::GenApi::EventPort::EventPort (
    IntPtr handle
) 

Parameters:

• handle Pointer to native CEventPort object.

---

---

The documentation for this class was generated from the following file /workspace/src/SpinnakerNET/GenApiNet/EventPort.h