Aravis.GcFeatureNode

Subclasses:

Aravis.GcBoolean, Aravis.GcCategory, Aravis.GcCommand, Aravis.GcConverter, Aravis.GcEnumEntry, Aravis.GcEnumeration, Aravis.GcFloatNode, Aravis.GcGroupNode, Aravis.GcIntegerNode, Aravis.GcPort, Aravis.GcRegisterDescriptionNode, Aravis.GcRegisterNode, Aravis.GcStringNode, Aravis.GcStructEntryNode, Aravis.GcSwissKnife

Methods

Inherited:

Aravis.GcNode (1), Aravis.DomElement (3), Aravis.DomNode (17), GObject.Object (37)

Structs:

GObject.ObjectClass (5)

	get_actual_access_mode ()
	get_description ()
	get_display_name ()
	get_imposed_access_mode ()
	get_name ()
	get_name_space ()
	get_tooltip ()
	get_value_as_string ()
	get_visibility ()
	is_available ()
	is_implemented ()
	is_locked ()
	set_value_from_string (string)

Virtual Methods

Inherited:

Aravis.DomElement (2), Aravis.DomNode (9), GObject.Object (7)

do_get_access_mode ()

Properties

None

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Name	Type	Access	Description
parent_instance	Aravis.GcNode	r

Class Details

class Aravis.GcFeatureNode(**kwargs)

Bases:

Aravis.GcNode

Abstract:

Yes

Structure:

Aravis.GcFeatureNodeClass

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

get_actual_access_mode()

Returns:

Access mode as Aravis.GcAccessMode

Return type:

Aravis.GcAccessMode

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

New in version 0.8.0.

get_description()

Return type:

str

get_display_name()

Return type:

str

get_imposed_access_mode()

Returns:

Access mode as Aravis.GcAccessMode

Return type:

Aravis.GcAccessMode

Gets feature node imposed access mode property.

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

New in version 0.8.0.

get_name()

Return type:

str

get_name_space()

Returns:

Name space value as Aravis.GcNameSpace.

Return type:

Aravis.GcNameSpace

Get feature name space.

New in version 0.8.0.

get_tooltip()

Return type:

str

get_value_as_string()

Raises:

GLib.Error

Returns:

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

Return type:

str

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.

get_visibility()

Return type:

Aravis.GcVisibility

is_available()

Raises:

GLib.Error

Return type:

bool

is_implemented()

Raises:

GLib.Error

Return type:

bool

is_locked()

Raises:

GLib.Error

Return type:

bool

set_value_from_string(string)

Parameters:

string (str) – new node value, as string

Raises:

GLib.Error

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

do_get_access_mode() virtual

Return type:

Aravis.GcAccessMode