PySpin.CRegisterPtr

class CRegisterPtr(*args)

Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.

DeregisterCallback(self, hCallback) → bool

Parameters

hCallback: Spinnaker::GenApi::CallbackHandleType

FromString(self, ValueStr, Verify=True)

Parameters

ValueStr: Spinnaker::GenICam::gcstring const & Verify: bool

Get(self, pBuffer, Length, Verify=False, IgnoreCache=False)

Parameters

pBuffer: uint8_t * Length: int64_t Verify: bool IgnoreCache: bool

Get(self, size_read) -> std::vector< uint8_t >

Parameters

size_read: int64_t

Get(self, size_read, verify_range) -> std::vector< uint8_t >

Parameters

size_read: int64_t verify_range: bool

Get(self, size_read, verify_range, ignore_cache) -> std::vector< uint8_t >

Parameters

size_read: int64_t verify_range: bool ignore_cache: bool

Gets a NumPy array representing the contents of the register, as 8-bit unsigned ints.

Parameters:

pBuffer: The number of bytes to retrieve

Verify: Enables Range verification (default = false). The AccessMode is always checked

IgnoreCache: If true the value is read ignoring any caches (default = false)

GetAccessMode(self) → Spinnaker::GenApi::EAccessMode
GetAddress(self) → int64_t
GetAlias(self) → INode
GetCachingMode(self) → Spinnaker::GenApi::ECachingMode
GetCastAlias(self) → INode
GetChildren(self, LinkType=ctReadingChildren)

Parameters

LinkType: enum Spinnaker::GenApi::ELinkType

GetDescription(self) → gcstring
GetDeviceName(self) → gcstring
GetDisplayName(self) → gcstring
GetDocuURL(self) → gcstring
GetEventID(self) → gcstring
GetLength(self) → int64_t
GetLockNodes(self)
GetName(self, FullQualified=False) → gcstring

Parameters

FullQualified: bool

GetNameSpace(self) → Spinnaker::GenApi::ENameSpace
GetNode(self) → INode
GetNodeMap(self) → INodeMap
GetParents(self)
GetPollingTime(self) → int64_t
GetPrincipalInterfaceType(self) → Spinnaker::GenApi::EInterfaceType
GetProperty(self, PropertyName, ValueStr, AttributeStr) → bool

Parameters

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

GetPropertyNames(self)
GetSelectedFeatures(self)
GetSelectingFeatures(self)
GetToolTip(self) → gcstring
GetVisibility(self) → Spinnaker::GenApi::EVisibility
ImposeAccessMode(self, ImposedAccessMode)

Parameters

ImposedAccessMode: enum Spinnaker::GenApi::EAccessMode

ImposeVisibility(self, ImposedVisibility)

Parameters

ImposedVisibility: enum Spinnaker::GenApi::EVisibility

InvalidateNode(self)
IsAccessModeCacheable(self) → Spinnaker::GenApi::EYesNo
IsCachable(self) → bool
IsDeprecated(self) → bool
IsFeature(self) → bool
IsSelector(self) → bool
IsStreamable(self) → bool
IsValid(self) → bool

throw ()

true if the pointer is valid

IsValueCacheValid(self) → bool
IsValueUpdated(self) → bool
RegisterCallback(self, pCallback) → Spinnaker::GenApi::CallbackHandleType

Parameters

pCallback: Spinnaker::GenApi::CNodeCallback *

Set(self, pBuffer, Verify=True)

Parameters

pBuffer: uint8_t const * Verify: bool

Set the register’s contents with the contents (as 8-bit unsigned ints) of the given array.

Parameters:

pBuffer: The NumPy array containing the data to set

Verify: Enables AccessMode and Range verification (default = true)

SetReference(self, pBase)

Parameters

pBase: INode *

ToString(self, Verify=False, IgnoreCache=False) → gcstring

Parameters

Verify: bool IgnoreCache: bool