Aravis.ChunkParser

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class	new (xml, size)
	get_boolean_value (buffer, chunk)
	get_float_value (buffer, chunk)
	get_integer_value (buffer, chunk)
	get_string_value (buffer, chunk)
	set_integer_feature_value (feature, value)
	set_string_feature_value (feature, value)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name	Type	Flags	Short Description
genicam	Aravis.Gc	r/w/co	Genicam instance

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Aravis.ChunkParser(**kwargs)

Bases:

GObject.Object

Abstract:

No

Structure:

Aravis.ChunkParserClass

[class`ArvChunkParser`] provides a class for the instantiation of chunk parsers used for the extraction of chunk data stored in the stream payload.

Chunks are tagged blocks of data stored in a [class`ArvBuffer`] containing a Aravis.BufferPayloadType.CHUNK_DATA payload. The tags allow a chunk parser to dissect the data payload into its elements and to identify the content.

Chunk data are enabled using either [method`ArvCamera`.set_chunks] or [method`ArvCamera`.set_chunk_mode]. Both functions are simple convenience wrappers that handle the setting of ChunkModeActive, ChunkSelector and ChunkEnable GENICAM features.

Here is an example of this API in use: tests/arvchunkparsertest.c

classmethod new(xml, size)

Parameters:

• xml (str) – XML genicam data

• size (int) – genicam data size, -1 if None terminated

Returns:

a new Aravis.ChunkParser object

Return type:

Aravis.ChunkParser

Creates a new chunk_parser.

Added in version 0.4.0.

get_boolean_value(buffer, chunk)

Parameters:

• buffer (Aravis.Buffer) – a Aravis.Buffer with a Aravis.BufferPayloadType.CHUNK_DATA payload

• chunk (str) – chunk data name

Raises:

GLib.Error

Returns:

the boolean chunk data value.

Return type:

bool

get_float_value(buffer, chunk)

Parameters:

• buffer (Aravis.Buffer) – a Aravis.Buffer with a Aravis.BufferPayloadType.CHUNK_DATA payload

• chunk (str) – chunk data name

Raises:

GLib.Error

Returns:

the float chunk data value.

Return type:

float

get_integer_value(buffer, chunk)

Parameters:

• buffer (Aravis.Buffer) – a Aravis.Buffer with a Aravis.BufferPayloadType.CHUNK_DATA payload

• chunk (str) – chunk data name

Raises:

GLib.Error

Returns:

the integer chunk data integer.

Return type:

int

get_string_value(buffer, chunk)

Parameters:

• buffer (Aravis.Buffer) – a Aravis.Buffer with a Aravis.BufferPayloadType.CHUNK_DATA payload

• chunk (str) – chunk data name

Raises:

GLib.Error

Returns:

the string chunk data value.

Return type:

str

set_integer_feature_value(feature, value)

Parameters:

• feature (str) – feature name

• value (int) – feature value

Raises:

GLib.Error

Set a feature value using a 64 bit value. The main use for this function is to set a Selector feature, in order to access the corresponding chunk value. As the Genicam data owned by the parser is not shared with the device, this function is limited to features that don’t trigger device access.

Added in version 0.8.35.

set_string_feature_value(feature, value)

Parameters:

• feature (str) – feature name

• value (str) – feature value

Raises:

GLib.Error

Set a feature value using a string. The main use for this function is to set a Selector feature, in order to access the corresponding chunk value. As the Genicam data owned by the parser is not shared with the device, this function is limited to features that don’t trigger device access.

Added in version 0.8.35.

Property Details

Aravis.ChunkParser.props.genicam

Name:

genicam

Type:

Aravis.Gc

Default Value:

None

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

Internal Genicam object