ArvGcFeatureNode: Aravis Reference Manual

ArvGcFeatureNode

ArvGcFeatureNode — Base class for Genicam feature nodes

Functions

const char *	arv_gc_feature_node_get_value_as_string ()
void	arv_gc_feature_node_set_value_from_string ()
const char *	arv_gc_feature_node_get_name ()
ArvGcNameSpace	arv_gc_feature_node_get_name_space ()
const char *	arv_gc_feature_node_get_display_name ()
const char *	arv_gc_feature_node_get_tooltip ()
const char *	arv_gc_feature_node_get_description ()
gboolean	arv_gc_feature_node_is_available ()
gboolean	arv_gc_feature_node_is_implemented ()
gboolean	arv_gc_feature_node_is_locked ()
ArvGcVisibility	arv_gc_feature_node_get_visibility ()
ArvGcAccessMode	arv_gc_feature_node_get_imposed_access_mode ()
ArvGcAccessMode	arv_gc_feature_node_get_actual_access_mode ()

Types and Values

ArvGcFeatureNode

Object Hierarchy

    GObject
    ╰── ArvDomNode
        ╰── ArvDomElement
            ╰── ArvGcNode
                ╰── ArvGcFeatureNode
                    ├── ArvGcBoolean
                    ├── ArvGcCategory
                    ├── ArvGcCommand
                    ├── ArvGcConverter
                    ├── ArvGcEnumEntry
                    ├── ArvGcEnumeration
                    ├── ArvGcFloatNode
                    ├── ArvGcRegisterNode
                    ├── ArvGcGroupNode
                    ├── ArvGcSwissKnife
                    ├── ArvGcIntegerNode
                    ├── ArvGcPort
                    ├── ArvGcRegisterDescriptionNode
                    ├── ArvGcStringNode
                    ╰── ArvGcStructEntryNode

Description

ArvGcFeatureNode provides a base class for the implementation of the different types of Genicam feature node (Group, Integer, Float, Enumeration...).

Functions

arv_gc_feature_node_get_value_as_string ()

const char *
arv_gc_feature_node_get_value_as_string
                               (ArvGcFeatureNode *gc_feature_node,
                                GError **error);

Retrieve the node value a string.

Please note the string content is still owned by the node object, which means the returned pointer may not be still valid after a new call to this function.

Parameters

gc_feature_node	a ArvGcFeatureNode
error	return location for a GError, or NULL

Returns

a string representation of the node value, NULL if not applicable.

[transfer none]

arv_gc_feature_node_set_value_from_string ()

void
arv_gc_feature_node_set_value_from_string
                               (ArvGcFeatureNode *gc_feature_node,
                                const char *string,
                                GError **error);

Set the node value using a string representation of the value. May not be applicable to every node type, but safe.

Parameters

gc_feature_node	a ArvGcFeatureNode
string	new node value, as string
error	return location for a GError, or NULL

arv_gc_feature_node_get_name ()

const char *
arv_gc_feature_node_get_name (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_get_name_space ()

ArvGcNameSpace
arv_gc_feature_node_get_name_space (ArvGcFeatureNode *gc_feature_node);

Get feature name space.

Parameters

gc_feature_node

a ArvGcFeatureNode

Returns

Name space value as ArvGcNameSpace.

Since: 0.8.0

arv_gc_feature_node_get_display_name ()

const char *
arv_gc_feature_node_get_display_name (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_get_tooltip ()

const char *
arv_gc_feature_node_get_tooltip (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_get_description ()

const char *
arv_gc_feature_node_get_description (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_is_available ()

gboolean
arv_gc_feature_node_is_available (ArvGcFeatureNode *gc_feature_node,
                                  GError **error);

arv_gc_feature_node_is_implemented ()

gboolean
arv_gc_feature_node_is_implemented (ArvGcFeatureNode *gc_feature_node,
                                    GError **error);

arv_gc_feature_node_is_locked ()

gboolean
arv_gc_feature_node_is_locked (ArvGcFeatureNode *gc_feature_node,
                               GError **error);

arv_gc_feature_node_get_visibility ()

ArvGcVisibility
arv_gc_feature_node_get_visibility (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_get_imposed_access_mode ()

ArvGcAccessMode
arv_gc_feature_node_get_imposed_access_mode
                               (ArvGcFeatureNode *gc_feature_node);

Gets feature node imposed access mode property.

Note that this function will not give the actual access mode. Please use arv_gc_feature_node_get_actual_access_mode to get an access mode combined from imposed access mode and underlying register access mode properties.

Parameters

gc_feature_node

a ArvGcFeatureNode

Returns

Access mode as ArvGcAccessMode

Since: 0.8.0

arv_gc_feature_node_get_actual_access_mode ()

ArvGcAccessMode
arv_gc_feature_node_get_actual_access_mode
                               (ArvGcFeatureNode *gc_feature_node);

Gets feature node allowed access mode. This is a combination of Genicam ImposedAccessMode and AccessMode properties of underlying features and registers.

Parameters

gc_feature_node

a ArvGcFeatureNode

Returns

Access mode as ArvGcAccessMode

Since: 0.8.0

Types and Values

ArvGcFeatureNode

typedef struct _ArvGcFeatureNode ArvGcFeatureNode;