ArvGc: Aravis Reference Manual

ArvGc

ArvGc — Genicam root document class

Functions

ArvGc *	arv_gc_new ()
ArvGcNode *	arv_gc_get_node ()
ArvDevice *	arv_gc_get_device ()
ArvBuffer *	arv_gc_get_buffer ()
void	arv_gc_set_buffer ()
ArvRangeCheckPolicy	arv_gc_get_range_check_policy ()
void	arv_gc_set_range_check_policy ()
ArvRegisterCachePolicy	arv_gc_get_register_cache_policy ()
void	arv_gc_set_register_cache_policy ()

Types and Values

	ArvGc
enum	ArvRangeCheckPolicy
enum	ArvRegisterCachePolicy
enum	ArvGcNameSpace
enum	ArvGcAccessMode
enum	ArvGcCachable
enum	ArvGcSignedness
enum	ArvGcIsLinear
enum	ArvGcVisibility
enum	ArvGcRepresentation
enum	ArvGcDisplayNotation
enum	ArvGcStreamable

Object Hierarchy

    GObject
    ╰── ArvDomNode
        ╰── ArvDomDocument
            ╰── ArvGc

Description

ArvGc implements the root document for the storage of the Genicam feature nodes. It builds the node tree by parsing an xml file in the Genicam standard format. See http://www.genicam.org.

Functions

arv_gc_new ()

ArvGc *
arv_gc_new (ArvDevice *device,
            const void *xml,
            size_t size);

arv_gc_get_node ()

ArvGcNode *
arv_gc_get_node (ArvGc *genicam,
                 const char *name);

Retrieves a genicam node by name.

Parameters

genicam	a ArvGc object
name	node name

Returns

a ArvGcNode, null if not found.

[transfer none]

arv_gc_get_device ()

ArvDevice *
arv_gc_get_device (ArvGc *genicam);

Retrieves the device handled by this genicam interface. The device is used for register access.

Parameters

genicam

a ArvGc object

Returns

a ArvDevice.

[transfer none]

arv_gc_get_buffer ()

ArvBuffer *
arv_gc_get_buffer (ArvGc *genicam);

Retrieves the binded buffer.

Parameters

genicam

a ArvGc object

Returns

a ArvBuffer.

[transfer none]

arv_gc_set_buffer ()

void
arv_gc_set_buffer (ArvGc *genicam,
                   ArvBuffer *buffer);

arv_gc_get_range_check_policy ()

ArvRangeCheckPolicy
arv_gc_get_range_check_policy (ArvGc *genicam);

arv_gc_set_range_check_policy ()

void
arv_gc_set_range_check_policy (ArvGc *genicam,
                               ArvRangeCheckPolicy policy);

arv_gc_get_register_cache_policy ()

ArvRegisterCachePolicy
arv_gc_get_register_cache_policy (ArvGc *genicam);

arv_gc_set_register_cache_policy ()

void
arv_gc_set_register_cache_policy (ArvGc *genicam,
                                  ArvRegisterCachePolicy policy);

Types and Values

ArvGc

typedef struct _ArvGc ArvGc;

enum ArvRangeCheckPolicy

Members

ARV_RANGE_CHECK_POLICY_DISABLE	never check if float or integer node value is in min/max range
ARV_RANGE_CHECK_POLICY_ENABLE	always check if if float or integer node is in min/max range
ARV_RANGE_CHECK_POLICY_DEBUG	check the value, but only display an error message if the value is not allowed (Since 0.8.8)
ARV_RANGE_CHECK_POLICY_DEFAULT	default range check policy

Since: 0.8.6

enum ArvRegisterCachePolicy

Members

ARV_REGISTER_CACHE_POLICY_DISABLE	disable register caching
ARV_REGISTER_CACHE_POLICY_ENABLE	enable register caching
ARV_REGISTER_CACHE_POLICY_DEBUG	enable register caching, but read the acual register value for comparison
ARV_REGISTER_CACHE_POLICY_DEFAULT	default cache policy

Since: 0.8.0

enum ArvGcNameSpace

Specifies feature node or register name space type. Standard name space features are listed in Genicam materials. Any other vendor-specific features should use custom name space type.

Members

ARV_GC_NAME_SPACE_UNDEFINED	undefined name space
ARV_GC_NAME_SPACE_STANDARD	Genicam standardized name space
ARV_GC_NAME_SPACE_CUSTOM	non-standardized name space

enum ArvGcAccessMode

Specifies access mode for feature nodes and registers.

Members

ARV_GC_ACCESS_MODE_UNDEFINED	undefined access mode
ARV_GC_ACCESS_MODE_RO	read-only access
ARV_GC_ACCESS_MODE_WO	write-only access
ARV_GC_ACCESS_MODE_RW	read and write access

enum ArvGcCachable

Specifies caching mode for register values.

Members

ARV_GC_CACHABLE_UNDEFINED	undefined cache mode
ARV_GC_CACHABLE_NO_CACHE	no value caching
ARV_GC_CACHABLE_WRITE_THROUGH	write-through cache mode
ARV_GC_CACHABLE_WRITE_AROUND	write-around cache mode

enum ArvGcSignedness

Specifies signedness of integer registers. Per standard Genicam internally uses signed 64-bit signed integers for representing all integer registers. Therefore unsigned 64-bit integers are not available.

Members

ARV_GC_SIGNEDNESS_UNDEFINED	undefined sign
ARV_GC_SIGNEDNESS_SIGNED	signed integer
ARV_GC_SIGNEDNESS_UNSIGNED	unsigned integer

enum ArvGcIsLinear

Describes relationship between TO and FROM variables in Converter feature nodes.

Members

ARV_GC_IS_LINEAR_UNDEFINED	undefined relationship between variables
ARV_GC_IS_LINEAR_NO	non-linear relationship between variables
ARV_GC_IS_LINEAR_YES	linear relationship between variables

enum ArvGcVisibility

Specifies feature node recommended visibility in user interfaces.

Members

ARV_GC_VISIBILITY_UNDEFINED	undefined feature visibility level
ARV_GC_VISIBILITY_INVISIBLE	feature should be not be visible in user interface
ARV_GC_VISIBILITY_GURU	very advanced feature to be shown to very experienced users
ARV_GC_VISIBILITY_EXPERT	advanced feature to be shown to expert users
ARV_GC_VISIBILITY_BEGINNER	basic feature to be shown to all users

enum ArvGcRepresentation

Number representation formats.

Members

ARV_GC_REPRESENTATION_UNDEFINED	undefined representation
ARV_GC_REPRESENTATION_LINEAR	number presented on linear scale (e.g. on a linear slider)
ARV_GC_REPRESENTATION_LOGARITHMIC	number presented on logarithmic scale (e.g. on a logarithmic slider)
ARV_GC_REPRESENTATION_BOOLEAN	binary choice (e.g. a checkbox)
ARV_GC_REPRESENTATION_PURE_NUMBER	number presented in an editable field (e.g. a spinbox)
ARV_GC_REPRESENTATION_HEX_NUMBER	number presented in hexadecimal format
ARV_GC_REPRESENTATION_IPV4_ADDRESS	IPv4 address
ARV_GC_REPRESENTATION_MAC_ADDRESS	MAC address

Since: 0.8.0

enum ArvGcDisplayNotation

Number display notations for showing numbers in user interfaces.

Members

ARV_GC_DISPLAY_NOTATION_UNDEFINED	undefined number notation
ARV_GC_DISPLAY_NOTATION_AUTOMATIC	automatically detect whether to use fixed or scientific number notation
ARV_GC_DISPLAY_NOTATION_FIXED	used fixed (i.e. decimal) notation for displaying numbers
ARV_GC_DISPLAY_NOTATION_SCIENTIFIC	use scientific notation for displaying numbers

Since: 0.8.0

enum ArvGcStreamable

Denotes that the corresponding feature is prepared to be stored to and loaded from a file via the node tree. The idea is to persist the state of a camera by storing the features marked as Streamable and restore the state by writing those features back to the node tree.

Members

ARV_GC_STREAMABLE_UNDEFINED	undefined streamable
ARV_GC_STREAMABLE_NO	the feature can't be used for camera state persistence
ARV_GC_STREAMABLE_YES	the feature can be used for camera state persistence

Since: 0.8.8