ArvGcFeatureNode

ArvGcFeatureNode — Base class for Genicam feature nodes

Synopsis

                    ArvGcFeatureNode;
ArvGcFeatureNode *  arv_gc_feature_node_new             (void);
GType               arv_gc_feature_node_get_value_type  (ArvGcFeatureNode *gc_feature_node);
const char *        arv_gc_feature_node_get_value_as_string
                                                        (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
void                arv_gc_feature_node_set_value_from_string
                                                        (ArvGcFeatureNode *gc_feature_node,
                                                         const char *string,
                                                         GError **error);
const char *        arv_gc_feature_node_get_name        (ArvGcFeatureNode *gc_feature_node);
const char *        arv_gc_feature_node_get_display_name
                                                        (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
const char *        arv_gc_feature_node_get_tooltip     (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
const char *        arv_gc_feature_node_get_description (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
gboolean            arv_gc_feature_node_is_available    (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
void                arv_gc_feature_node_inc_modification_count
                                                        (ArvGcFeatureNode *gc_feature_node);
gint                arv_gc_feature_node_get_modification_count
                                                        (ArvGcFeatureNode *gc_feature_node);
gboolean            arv_gc_feature_node_is_implemented  (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);
gboolean            arv_gc_feature_node_is_locked       (ArvGcFeatureNode *gc_feature_node,
                                                         GError **error);

Object Hierarchy

  GObject
   +----ArvDomNode
         +----ArvDomElement
               +----ArvGcNode
                     +----ArvGcFeatureNode
                           +----ArvGcEnumEntry
                           +----ArvGcGroupNode
                           +----ArvGcBoolean
                           +----ArvGcCategory
                           +----ArvGcCommand
                           +----ArvGcConverter
                           +----ArvGcEnumeration
                           +----ArvGcFloatNode
                           +----ArvGcIntegerNode
                           +----ArvGcPort
                           +----ArvGcRegisterNode
                           +----ArvGcStructEntryNode
                           +----ArvGcSwissKnife

Description

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

Details

ArvGcFeatureNode

typedef struct _ArvGcFeatureNode ArvGcFeatureNode;

arv_gc_feature_node_new ()

ArvGcFeatureNode *  arv_gc_feature_node_new             (void);

arv_gc_feature_node_get_value_type ()

GType               arv_gc_feature_node_get_value_type  (ArvGcFeatureNode *gc_feature_node);

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.

Warning

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.

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.

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_display_name ()

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

arv_gc_feature_node_get_tooltip ()

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

arv_gc_feature_node_get_description ()

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

arv_gc_feature_node_is_available ()

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

arv_gc_feature_node_inc_modification_count ()

void                arv_gc_feature_node_inc_modification_count
                                                        (ArvGcFeatureNode *gc_feature_node);

arv_gc_feature_node_get_modification_count ()

gint                arv_gc_feature_node_get_modification_count
                                                        (ArvGcFeatureNode *gc_feature_node);

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);