Class SpinnakerNET::GenApi::ChunkPort¶

ClassList > SpinnakerNET > GenApi > ChunkPort

Port attachable to an chunk port node.

#include <ChunkPort.h>

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

Public Attributes¶

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

Public Functions¶

Type	Name
void __clrcall	AttachChunk (IntPtr baseAddress, __int64 offset, __int64 length) Attaches the given event data to the attached node.
bool __clrcall	AttachPort (SpinnakerNET::GenApi::IPort ^ port) Attaches an port to this adapter to which the events will be attached.
bool __clrcall	CheckChunkID (array< Byte > ^ chunkID) Checks whether the given chunkID matches the one of the attached port.
__clrcall	ChunkPort (void) Constructor for an unattached managed `ChunkPort` .
__clrcall	ChunkPort (SpinnakerNET::GenApi::IPort ^ port) Constructor for an attached managed `ChunkPort` .
void __clrcall	DetachChunk () Detaches the event data from the attached node.
void __clrcall	DetachPort () Detaches the port from this adapter.
void __clrcall	Invalidate () Invalidates the attached port.
virtual void __clrcall	Read (IntPtr buffer, __int64 address, __int64 length) override Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
virtual void	Read (__int64 address, array< System::Byte > ^ buffer) override Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
void __clrcall	UpdateChunk (IntPtr baseAddress) Updates just the base address of the chunk data.
virtual void __clrcall	Write (IntPtr buffer, __int64 address, __int64 length) override Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
virtual void	Write (__int64 address, array< System::Byte > ^ buffer) override Writes buffer .Length bytes to__address of this`Port` from the given__buffer .
virtual __clrcall	~ChunkPort (void) Disposes all managed and unmanaged resources.

Public Static Functions¶

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

Protected Functions¶

Type	Name
void __clrcall	CheckStatus ()
__clrcall	ChunkPort (IntPtr handle) Constructor for a native `CChunkPort` from the given__handle .

Public Attributes Documentation¶

variable ChunkIDLength¶

Gets the length of the ID of the attached node.

property int SpinnakerNET::GenApi::ChunkPort::ChunkIDLength;

The length in bytes of the chunk ID.

Public Functions Documentation¶

function AttachChunk¶

Attaches the given event data to the attached node.

void  __clrcall SpinnakerNET::GenApi::ChunkPort::AttachChunk (
    IntPtr baseAddress,
    __int64 offset,
    __int64 length
)

Parameters:

baseAddress Base address of chunk data to attach.
offset Offset from the baseAddress .
length Chunks data length to attach.

function AttachPort¶

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

bool  __clrcall SpinnakerNET::GenApi::ChunkPort::AttachPort (
    SpinnakerNET::GenApi::IPort ^ port
)

Parameters:

port IPort to which the events will be attached to.

Returns:

true on success; false otherwise.

function CheckChunkID¶

Checks whether the given chunkID matches the one of the attached port.

bool  __clrcall SpinnakerNET::GenApi::ChunkPort::CheckChunkID (
    array < Byte > ^ chunkID
)

Parameters:

chunkID Chunk ID to be checked.

Returns:

true if the IDs match; false otherwise.

function ChunkPort [1/3]¶

Constructor for an unattached managed ChunkPort .

__clrcall SpinnakerNET::GenApi::ChunkPort::ChunkPort (
    void
)

function ChunkPort [2/3]¶

Constructor for an attached managed ChunkPort .

__clrcall SpinnakerNET::GenApi::ChunkPort::ChunkPort (
    SpinnakerNET::GenApi::IPort ^ port
)

Parameters:

port IPort object to attach to.

function DetachChunk¶

Detaches the event data from the attached node.

void  __clrcall SpinnakerNET::GenApi::ChunkPort::DetachChunk ()

function DetachPort¶

Detaches the port from this adapter.

void  __clrcall SpinnakerNET::GenApi::ChunkPort::DetachPort ()

function Invalidate¶

Invalidates the attached port.

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

function Read [1/2]¶

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

virtual void  __clrcall SpinnakerNET::GenApi::ChunkPort::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::ChunkPort::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 UpdateChunk¶

Updates just the base address of the chunk data.

void  __clrcall SpinnakerNET::GenApi::ChunkPort::UpdateChunk (
    IntPtr baseAddress
)

Parameters:

baseAddress Base address of chunk data to attach.

function Write [1/2]¶

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

virtual void  __clrcall SpinnakerNET::GenApi::ChunkPort::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::ChunkPort::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 ~ChunkPort¶

Disposes all managed and unmanaged resources.

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

Public Static Functions Documentation¶

function FromHandle¶

Creates an ChunkPort from the given__handle .

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

Parameters:

handle Pointer to native CChunkPort object.

Protected Functions Documentation¶

function CheckStatus¶

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

function ChunkPort [3/3]¶

Constructor for a native CChunkPort from the given__handle .

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

Parameters:

handle Pointer to native CChunkPort object.

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