Class SpinnakerNET::GenApi::abstract¶

ClassList > SpinnakerNET > GenApi > abstract

Base class of all adapters delivering chunks to anINodeMap .More...

#include <ChunkAdapter.h>

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

Public Attributes¶

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for the`Port` .
property IntPtr	Handle = `/* multi line expression /` Gets or sets the native chunk adapter handle.*
property System::IntPtr	Handle = `/* multi line expression /` Gets or sets the native* `GenApi::IPort` handle.

Public Attributes inherited from SpinnakerNET::GenApi::IBase¶

See SpinnakerNET::GenApi::IBase

Type	Name
property SpinnakerNET::GenApi::AccessMode	AccessMode = `/* multi line expression /` Gets the* `AccessMode` for the`Node` .

Public Functions¶

Type	Name
virtual void __clrcall	AttachChunk (IntPtr buffer, int length) override = 0 Attaches the chunk data in buffer to the ports with matching chunk ID.
virtual void __clrcall	AttachChunk (IntPtr buffer, int length, int % numChunkPorts, int % numChunks, int % numAttachedChunks) override = 0 Attaches the chunk data in buffer to the ports with matching chunk ID.
void __clrcall	AttachNodeMap (SpinnakerNET::GenApi::INodeMap ^ nodeMap) Attaches nodeMap to this adapter.
void __clrcall	AttachNodeMap (SpinnakerNET::GenApi::INodeMap ^ nodeMap) Attaches nodeMap to this adapter.
virtual bool __clrcall	CheckChunkLayout (IntPtr buffer, int length) override = 0 Checks if the chunk data in buffer has a known chunk format.
virtual void __clrcall	DeliverMessage (IntPtr message, int length) override = 0 Attaches the event data in message to the ports with matching event ID.
void __clrcall	DeliverMessage (array< Byte > ^ message) Attaches the event data in message to the ports with matching event ID.
void __clrcall	DetachChunk () Detaches the current chunk buffer from all chunk ports.
void __clrcall	DetachNodeMap () Detaches the current `INodeMap` from this adapter.
void __clrcall	DetachNodeMap () Detaches the current `INodeMap` from this adapter.
virtual void	Read (System::IntPtr buffer, __int64 address, __int64 length) override = 0 Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
virtual void	Read (__int64 address, array< System::Byte > ^ buffer) override = 0 Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
virtual void	Read (__int64 address, array< System::Byte > ^ buffer) override Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
virtual void	Read (System::IntPtr buffer, __int64 address, __int64 length) override Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
virtual void	Write (System::IntPtr buffer, __int64 address, __int64 length) override = 0 Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
virtual void	Write (__int64 address, array< System::Byte > ^ buffer) override = 0 Writes buffer .Length bytes to__address of this`Port` from the given__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 void	Write (System::IntPtr buffer, __int64 address, __int64 length) override Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
virtual __clrcall	~ChunkAdapter (void) Disposes all managed and unmanaged resources.
virtual __clrcall	~EventAdapter (void) Disposes all managed and unmanaged resources.

Public Functions inherited from SpinnakerNET::GenApi::IPort¶

See SpinnakerNET::GenApi::IPort

Type	Name
void	Read (System::IntPtr buffer, __int64 address, __int64 length) Reads length bytes from__address of this`Port` to the preallocated memory at__buffer .
void	Read (__int64 address, array< System::Byte > ^ buffer) Reads buffer .Length bytes from__address of this`Port` to the given__buffer .
void	Write (System::IntPtr buffer, __int64 address, __int64 length) Writes length bytes to__address of this`Port` from the preallocated memory at__buffer .
void	Write (__int64 address, array< System::Byte > ^ buffer) Writes buffer .Length bytes to__address of this`Port` from the given__buffer .

Public Static Functions¶

Type	Name
Port __clrcall	FromHandle (System::IntPtr handle) Creates a `Port` from a native`GenApi::IPort` handle.

Protected Attributes¶

Type	Name
property array< ChunkPort^>	ChunkPorts = `/* multi line expression /` Gets the list of all chunk ports. This function is only supported if this is a managed chunk adapter.*
property array< EventPort^>	EventPorts = `/* multi line expression /` Gets the list of all event ports. This function is only supported if this is a managed event adapter.*
::Spinnaker::GenApi::CChunkAdapter *	chunkAdapterHandle Pointer to native `CChunkAdapter` object.
::Spinnaker::GenApi::CEventAdapter *	eventAdapterHandle Pointer to native `CEventAdapter` object.

Protected Functions¶

Type	Name
void __clrcall	CheckStatus () Checks if the underlying objects are still valid.
void __clrcall	CheckStatus () Checks if the underlying objects are still valid.
__clrcall	ChunkAdapter (void) Constructor for a managed `ChunkAdapter` .
__clrcall	ChunkAdapter (IntPtr handle) Constructor for a native `ChunkAdapter` .
__clrcall	EventAdapter (void) Constructor for a managed `EventAdapter` .
__clrcall	EventAdapter (IntPtr handle) Constructor for a native `EventAdapter` .
__clrcall	Port (void) Base constructor for all managed`Port` s.
__clrcall	Port (System::IntPtr handle) Base constructor for all unmanaged`Port` s (simple wrapper).
void __clrcall	set (IntPtr handle)
void __clrcall	set (IntPtr handle)
void __clrcall	set (System::IntPtr handle)
virtual __clrcall	~Port (void) Disposes all managed and unmanaged resources.

Detailed Description¶

Helper Port base class to implement managed ports. In this port only the array related Read and Write methods must be implemented.

Helper Port base class to implement managed ports. In this port only the IntPtr related Read and Write methods must be implemented.

Port base class to implement managed ports.

Base class of all adapters delivering events to an INodeMap.

Public Attributes Documentation¶

variable AccessMode¶

Gets the AccessMode for thePort .

virtual property SpinnakerNET::GenApi::AccessMode SpinnakerNET::GenApi::abstract::AccessMode;

Default implementation: If a handle is present AccessMode.RW; AccessMode.NI otherwise.

GenICam.GenApi.AccessMode of this Port.

variable Handle [1/2]¶

Gets or sets the native chunk adapter handle.

property IntPtr SpinnakerNET::GenApi::abstract::Handle;

Gets or sets the native event adapter handle.

Handle pointing to the native CChunkAdapter object

Handle pointing to the native CEventAdapter object

variable Handle [2/2]¶

Gets or sets the native GenApi::IPort handle.

virtual property System::IntPtr SpinnakerNET::GenApi::abstract::Handle;

Pointer to the native GenApi::IPort object.

Public Functions Documentation¶

function AttachChunk [1/2]¶

Attaches the chunk data in buffer to the ports with matching chunk ID.

virtual void  __clrcall SpinnakerNET::GenApi::abstract::AttachChunk (
    IntPtr buffer,
    int length
) override = 0

Parameters:

buffer Pointer to chunk data.
length Length of buffer in bytes.

function AttachChunk [2/2]¶

Attaches the chunk data in buffer to the ports with matching chunk ID.

virtual void  __clrcall SpinnakerNET::GenApi::abstract::AttachChunk (
    IntPtr buffer,
    int length,
    int % numChunkPorts,
    int % numChunks,
    int % numAttachedChunks
) override = 0

Parameters:

buffer Pointer to chunk data.
length Length of buffer in bytes.

function AttachNodeMap [1/2]¶

Attaches nodeMap to this adapter.

void  __clrcall SpinnakerNET::GenApi::abstract::AttachNodeMap (
    SpinnakerNET::GenApi::INodeMap ^ nodeMap
)

Parameters:

nodeMap Node map object to attach to.

function AttachNodeMap [1/2]¶

Attaches nodeMap to this adapter.

void  __clrcall SpinnakerNET::GenApi::abstract::AttachNodeMap (
    SpinnakerNET::GenApi::INodeMap ^ nodeMap
)

Parameters:

nodeMap Node map object to attach to.

function CheckChunkLayout¶

Checks if the chunk data in buffer has a known chunk format.

virtual bool  __clrcall SpinnakerNET::GenApi::abstract::CheckChunkLayout (
    IntPtr buffer,
    int length
) override = 0

Parameters:

buffer Pointer to chunk data.
length Length of buffer in bytes.

function DeliverMessage [1/2]¶

Attaches the event data in message to the ports with matching event ID.

virtual void  __clrcall SpinnakerNET::GenApi::abstract::DeliverMessage (
    IntPtr message,
    int length
) override = 0

Parameters:

message Pointer to message data.
length Length of message in bytes.

function DeliverMessage [2/2]¶

Attaches the event data in message to the ports with matching event ID.

void  __clrcall SpinnakerNET::GenApi::abstract::DeliverMessage (
    array < Byte > ^ message
)

Parameters:

message Pointer to message data.

function DetachChunk¶

Detaches the current chunk buffer from all chunk ports.

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

function DetachNodeMap [1/2]¶

Detaches the current INodeMap from this adapter.

void  __clrcall SpinnakerNET::GenApi::abstract::DetachNodeMap ()

function DetachNodeMap [1/2]¶

Detaches the current INodeMap from this adapter.

void  __clrcall SpinnakerNET::GenApi::abstract::DetachNodeMap ()

function Read [1/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::Read (
    System::IntPtr buffer,
    __int64 address,
    __int64 length
) override = 0

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.

Implements SpinnakerNET::GenApi::IPort::Read

function Read [2/4]¶

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

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

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.

Implements SpinnakerNET::GenApi::IPort::Read

function Read [3/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::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.

Implements SpinnakerNET::GenApi::IPort::Read

function Read [4/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::Read (
    System::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.

Implements SpinnakerNET::GenApi::IPort::Read

function Write [1/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::Write (
    System::IntPtr buffer,
    __int64 address,
    __int64 length
) override = 0

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.

Implements SpinnakerNET::GenApi::IPort::Write

function Write [2/4]¶

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

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

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.

Implements SpinnakerNET::GenApi::IPort::Write

function Write [3/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::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.

Implements SpinnakerNET::GenApi::IPort::Write

function Write [4/4]¶

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

virtual void SpinnakerNET::GenApi::abstract::Write (
    System::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.

Implements SpinnakerNET::GenApi::IPort::Write

function ~ChunkAdapter¶

Disposes all managed and unmanaged resources.

virtual __clrcall SpinnakerNET::GenApi::abstract::~ChunkAdapter (
    void
)

function ~EventAdapter¶

Disposes all managed and unmanaged resources.

virtual __clrcall SpinnakerNET::GenApi::abstract::~EventAdapter (
    void
)

Public Static Functions Documentation¶

function FromHandle¶

Creates a Port from a nativeGenApi::IPort handle.

static Port  __clrcall SpinnakerNET::GenApi::abstract::FromHandle (
    System::IntPtr handle
)

Parameters:

handle Pointer to the native GenApi::IPort object.

Protected Attributes Documentation¶

variable ChunkPorts¶

Gets the list of all chunk ports. This function is only supported if this is a managed chunk adapter.

property array<ChunkPort^> SpinnakerNET::GenApi::abstract::ChunkPorts;

All ports of the associated nodemap having an chunk ID are in this list.

variable EventPorts¶

Gets the list of all event ports. This function is only supported if this is a managed event adapter.

property array<EventPort^> SpinnakerNET::GenApi::abstract::EventPorts;

All ports of the associated nodemap having an event ID are in this list.

variable chunkAdapterHandle¶

Pointer to native CChunkAdapter object.

::Spinnaker::GenApi::CChunkAdapter* SpinnakerNET::GenApi::abstract::chunkAdapterHandle;

variable eventAdapterHandle¶

Pointer to native CEventAdapter object.

::Spinnaker::GenApi::CEventAdapter* SpinnakerNET::GenApi::abstract::eventAdapterHandle;

Protected Functions Documentation¶

function CheckStatus [1/2]¶

Checks if the underlying objects are still valid.

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

function CheckStatus [1/2]¶

Checks if the underlying objects are still valid.

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

function ChunkAdapter [1/2]¶

Constructor for a managed ChunkAdapter .

__clrcall SpinnakerNET::GenApi::abstract::ChunkAdapter (
    void
)

function ChunkAdapter [2/2]¶

Constructor for a native ChunkAdapter .

__clrcall SpinnakerNET::GenApi::abstract::ChunkAdapter (
    IntPtr handle
)

Parameters:

handle Pointer to native GenApi::CChunkAdapter object.

function EventAdapter [1/2]¶

Constructor for a managed EventAdapter .

__clrcall SpinnakerNET::GenApi::abstract::EventAdapter (
    void
)

function EventAdapter [2/2]¶

Constructor for a native EventAdapter .

__clrcall SpinnakerNET::GenApi::abstract::EventAdapter (
    IntPtr handle
)

Parameters:

handle Pointer to native GenApi::CEventAdapter object.

function Port [1/2]¶

Base constructor for all managedPort s.

__clrcall SpinnakerNET::GenApi::abstract::Port (
    void
)

function Port [2/2]¶

Base constructor for all unmanagedPort s (simple wrapper).

__clrcall SpinnakerNET::GenApi::abstract::Port (
    System::IntPtr handle
)

Parameters:

handle Pointer to the native GenApi::IPort object.

function set [1/3]¶

void  __clrcall SpinnakerNET::GenApi::abstract::set (
    IntPtr handle
)

function set [1/3]¶

void  __clrcall SpinnakerNET::GenApi::abstract::set (
    IntPtr handle
)

function set [3/3]¶

void  __clrcall SpinnakerNET::GenApi::abstract::set (
    System::IntPtr handle
)

function ~Port¶

Disposes all managed and unmanaged resources.

virtual __clrcall SpinnakerNET::GenApi::abstract::~Port (
    void
)

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