PySpin.Node

class Node(*args, **kwargs)

class common to all nodes

DeregisterCallback(self, hCallback) → bool

Parameters

hCallback: Spinnaker::GenApi::CallbackHandleType

Spinnaker::GenApi::Node::DeregisterCallback De register change callback Destroys CNodeCallback object true if the callback handle was valid

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

Spinnaker::GenApi::Node::GetAccessMode Base interface overrides.

Get the access mode of the node

GetAlias(self) → INode

Spinnaker::GenApi::Node::GetAlias Retrieves the a node which describes the same feature in a different way

GetCachingMode(self) → Spinnaker::GenApi::ECachingMode

Spinnaker::GenApi::Node::GetCachingMode Get Caching Mode

GetCastAlias(self) → INode

Spinnaker::GenApi::Node::GetCastAlias 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

Spinnaker::GenApi::Node::GetChildren Get all nodes this node directly depends on.

param Children:

List of children nodes

param LinkType:

The link type

GetDescription(self) → gcstring

Spinnaker::GenApi::Node::GetDescription Get a long description of the node

GetDeviceName(self) → gcstring

Spinnaker::GenApi::Node::GetDeviceName Get a name of the device

GetDisplayName(self) → gcstring

Spinnaker::GenApi::Node::GetDisplayName Get a name string for display

GetDocuURL(self) → gcstring

Spinnaker::GenApi::Node::GetDocuURL Gets a URL pointing to the documentation of that feature

GetEventID(self) → gcstring

Spinnaker::GenApi::Node::GetEventID Get the EventId of the node

GetLockNodes(self)

Spinnaker::GenApi::Node::GetLockNodes Gets all nodes which can directly lock this node.

Parameters:

LockNodes – List of lock nodes.

GetName(self, FullQualified=False) → gcstring

Parameters

FullQualified: bool

Spinnaker::GenApi::Node::GetName Get node name

GetNameSpace(self) → Spinnaker::GenApi::ENameSpace

Spinnaker::GenApi::Node::GetNameSpace Get name space

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

Spinnaker::GenApi::Node::GetNodeHandle Get Node handle

GetNodeMap(self) → INodeMap

Spinnaker::GenApi::Node::GetNodeMap Retrieves the central node map

GetParents(self)

Spinnaker::GenApi::Node::GetParents Gets all nodes this node is directly depending on.

Parameters:

Parents – List of parent nodes

GetPollingTime(self) → int64_t

Spinnaker::GenApi::Node::GetPollingTime recommended polling time (for not cacheable nodes)

GetPrincipalInterfaceType(self) → Spinnaker::GenApi::EInterfaceType

Spinnaker::GenApi::Node::GetPrincipalInterfaceType 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 &

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

GetPropertyNames(self)

Spinnaker::GenApi::Node::GetPropertyNames Returns a list of the names all properties set during initialization

GetSelectedFeatures(self)

Spinnaker::GenApi::Node::GetSelectedFeatures retrieve the group of selected features

GetSelectingFeatures(self)

Spinnaker::GenApi::Node::GetSelectingFeatures retrieve the group of features selecting this node

GetToolTip(self) → gcstring

Spinnaker::GenApi::Node::GetToolTip Get a short description of the node

GetVisibility(self) → Spinnaker::GenApi::EVisibility

Spinnaker::GenApi::Node::GetVisibility Get the recommended visibility of the node

ImposeAccessMode(self, ImposedAccessMode)

Parameters

ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode

Spinnaker::GenApi::Node::ImposeAccessMode Imposes an access mode to the natural access mode of the node

ImposeVisibility(self, ImposedVisibility)

Parameters

ImposedVisibility: enum Spinnaker::GenApi::EVisibility

Spinnaker::GenApi::Node::ImposeVisibility Imposes a visibility to the natural visibility of the node

InvalidateNode(self)

Spinnaker::GenApi::Node::InvalidateNode Indicates that the node’s value may have changed. Fires the callback on this and all dependent nodes

IsAccessModeCacheable(self) → Spinnaker::GenApi::EYesNo

Spinnaker::GenApi::Node::IsAccessModeCacheable True if the AccessMode can be cached

IsCachable(self) → bool

Spinnaker::GenApi::Node::IsCachable Is the node value cacheable

IsDeprecated(self) → bool

Spinnaker::GenApi::Node::IsDeprecated True if the node should not be used any more

IsFeature(self) → bool

Spinnaker::GenApi::Node::IsFeature True if the node can be reached via category nodes from a category node named “Root”

IsSelector(self) → bool

Spinnaker::GenApi::Node::IsSelector Selector interface overrides.

true if this feature selects a group of features

IsStreamable(self) → bool

Spinnaker::GenApi::Node::IsStreamable True if the node is streamable

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

Parameters

pCallback: Spinnaker::GenApi::CNodeCallback *

Spinnaker::GenApi::Node::RegisterCallback Register change callback Takes ownership of the CNodeCallback object

SetNodeHandle(self, pNodeHandle)

Parameters

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

Spinnaker::GenApi::Node::SetNodeHandle Set Node handle

SetNodeMap(self, pNodeMap)

Parameters

pNodeMap: Spinnaker::GenApi::INodeMap *

Spinnaker::GenApi::Node::SetNodeMap

SetReference(self, pBase)

Parameters

pBase: Spinnaker::GenApi::INode *

SetReference(self, pBase)

Parameters

pBase: Spinnaker::GenApi::ISelector *

Spinnaker::GenApi::Node::SetReference