PySpin.Node¶

class Node(*args, **kwargs)¶

class common to all nodes

DeregisterCallback(self, hCallback) → bool¶: Parameters¶

hCallback: Spinnaker::GenApi::CallbackHandleType

De register change callback Destroys CNodeCallback object true if the callback handle was valid

GetAccessMode(self) → Spinnaker::GenApi::EAccessMode¶

Base interface overrides.

Get the access mode of the node

GetAlias(self) → INode¶: Retrieves the a node which describes the same feature in a different way

GetCachingMode(self) → Spinnaker::GenApi::ECachingMode¶: Get Caching Mode

GetCastAlias(self) → INode¶: Retrieves the a node which describes the same feature so that it can be casted

GetChildren(self, LinkType=ctReadingChildren)¶

Parameters¶

LinkType: enum Spinnaker::GenApi::ELinkType

Get all nodes this node directly depends on.

param Children:: List of children nodes
param LinkType:: The link type

GetDescription(self) → gcstring¶: Get a long description of the node

GetDeviceName(self) → gcstring¶: Get a name of the device

GetDisplayName(self) → gcstring¶: Get a name string for display

GetDocuURL(self) → gcstring¶: Gets a URL pointing to the documentation of that feature

GetEventID(self) → gcstring¶: Get the EventId of the node

GetLockNodes(self)¶

Gets all nodes which can directly lock this node.

Parameters:: LockNodes – List of lock nodes.

GetName(self, FullQualified=False) → gcstring¶: Parameters¶

FullQualified: bool

Get node name

GetNameSpace(self) → Spinnaker::GenApi::ENameSpace¶: Get name space

GetNodeHandle(self) → std::shared_ptr< Spinnaker::GenApi::Node::NodeImpl >¶: Get Node handle

GetNodeMap(self) → INodeMap¶: Retrieves the central node map

GetParents(self)¶

Gets all nodes this node is directly depending on.

Parameters:: Parents – List of parent nodes

GetPollingTime(self) → int64_t¶: recommended polling time (for not cacheable nodes)

GetPrincipalInterfaceType(self) → Spinnaker::GenApi::EInterfaceType¶: Get the type of the main interface of a node

GetProperty(self, PropertyName, ValueStr, AttributeStr) → bool¶: Parameters¶

PropertyName: Spinnaker::GenICam::gcstring const & ValueStr: Spinnaker::GenICam::gcstring & AttributeStr: Spinnaker::GenICam::gcstring &

Retrieves a property plus an additional attribute by name If a property has multiple values/attribute they come with Tabs as delimiters

GetPropertyNames(self)¶: Returns a list of the names all properties set during initialization

GetSelectedFeatures(self)¶: retrieve the group of selected features

GetSelectingFeatures(self)¶: retrieve the group of features selecting this node

GetToolTip(self) → gcstring¶: Get a short description of the node

GetVisibility(self) → Spinnaker::GenApi::EVisibility¶: Get the recommended visibility of the node

ImposeAccessMode(self, ImposedAccessMode)¶: Parameters¶

ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode

Imposes an access mode to the natural access mode of the node

ImposeVisibility(self, ImposedVisibility)¶: Parameters¶

ImposedVisibility: enum Spinnaker::GenApi::EVisibility

Imposes a visibility to the natural visibility of the node

InvalidateNode(self)¶: Indicates that the node’s value may have changed. Fires the callback on this and all dependent nodes

IsAccessModeCacheable(self) → Spinnaker::GenApi::EYesNo¶: True if the AccessMode can be cached

IsCachable(self) → bool¶: Is the node value cacheable

IsDeprecated(self) → bool¶: True if the node should not be used any more

IsFeature(self) → bool¶: True if the node can be reached via category nodes from a category node named “Root”

IsSelector(self) → bool¶

Selector interface overrides.

true if this feature selects a group of features

IsStreamable(self) → bool¶: True if the node is streamable

RegisterCallback(self, pCallback) → Spinnaker::GenApi::CallbackHandleType¶: Parameters¶

pCallback: Spinnaker::GenApi::CNodeCallback *

Register change callback Takes ownership of the CNodeCallback object

SetNodeHandle(self, pNodeHandle)¶: Parameters¶

pNodeHandle: std::shared_ptr< Spinnaker::GenApi::Node::NodeImpl >

Set Node handle

SetNodeMap(self, pNodeMap)¶: Parameters¶

pNodeMap: Spinnaker::GenApi::INodeMap *

SetReference(self, pBase)¶: Parameters¶

pBase: Spinnaker::GenApi::INode *

SetReference(self, pBase)

Parameters¶

pBase: Spinnaker::GenApi::ISelector *