Node Enums

Provides general enumerations for describing the behavior, properties, and metadata of nodes within a NodeMap. More...

Enumerations
enum class	peak::core::nodes::NodeCacheUsePolicy {   peak::core::nodes::NodeCacheUsePolicy::UseCache ,   peak::core::nodes::NodeCacheUsePolicy::IgnoreCache }
	Defines how node value access should interact with the internal cache. More...
enum class	peak::core::nodes::NodeIncrementType {   peak::core::nodes::NodeIncrementType::NoIncrement ,   peak::core::nodes::NodeIncrementType::FixedIncrement ,   peak::core::nodes::NodeIncrementType::ListIncrement }
enum class	peak::core::nodes::NodeRepresentation {   peak::core::nodes::NodeRepresentation::Linear ,   peak::core::nodes::NodeRepresentation::Logarithmic ,   peak::core::nodes::NodeRepresentation::Boolean ,   peak::core::nodes::NodeRepresentation::PureNumber ,   peak::core::nodes::NodeRepresentation::HexNumber ,   peak::core::nodes::NodeRepresentation::IP4Address ,   peak::core::nodes::NodeRepresentation::MACAddress }
enum class	peak::core::nodes::NodeDisplayNotation {   peak::core::nodes::NodeDisplayNotation::Automatic ,   peak::core::nodes::NodeDisplayNotation::Fixed ,   peak::core::nodes::NodeDisplayNotation::Scientific }
	Display notation for numbers in FloatNode. More...
enum class	peak::core::nodes::NodeAccessStatus {   peak::core::nodes::NodeAccessStatus::NotImplemented ,   peak::core::nodes::NodeAccessStatus::NotAvailable ,   peak::core::nodes::NodeAccessStatus::WriteOnly ,   peak::core::nodes::NodeAccessStatus::ReadOnly ,   peak::core::nodes::NodeAccessStatus::ReadWrite }
enum class	peak::core::nodes::NodeCachingMode {   peak::core::nodes::NodeCachingMode::NoCache ,   peak::core::nodes::NodeCachingMode::WriteThrough ,   peak::core::nodes::NodeCachingMode::WriteAround }
enum class	peak::core::nodes::NodeNamespace {   peak::core::nodes::NodeNamespace::Custom ,   peak::core::nodes::NodeNamespace::Standard }
enum class	peak::core::nodes::NodeType {   peak::core::nodes::NodeType::Integer ,   peak::core::nodes::NodeType::Boolean ,   peak::core::nodes::NodeType::Command ,   peak::core::nodes::NodeType::Float ,   peak::core::nodes::NodeType::String ,   peak::core::nodes::NodeType::Register ,   peak::core::nodes::NodeType::Category ,   peak::core::nodes::NodeType::Enumeration ,   peak::core::nodes::NodeType::EnumerationEntry }
enum class	peak::core::nodes::NodeVisibility {   peak::core::nodes::NodeVisibility::Beginner ,   peak::core::nodes::NodeVisibility::Expert ,   peak::core::nodes::NodeVisibility::Guru ,   peak::core::nodes::NodeVisibility::Invisible }

Detailed Description

Provides general enumerations for describing the behavior, properties, and metadata of nodes within a NodeMap.

Enumeration Type Documentation

NodeAccessStatus

enum class peak::core::nodes::NodeAccessStatus

strong

The node's current access status, i.e. the <AccessMode> element. See GenAPI Access Mode.

Enumerator
NotImplemented
NotAvailable
WriteOnly
ReadOnly
ReadWrite

NodeCacheUsePolicy

enum class peak::core::nodes::NodeCacheUsePolicy

strong

Defines how node value access should interact with the internal cache.

See Node Caching and Polling Concepts.

This policy is used by read accessors such as FloatNode::Value, IntegerNode::Value, StringNode::Value, EnumerationNode::CurrentEntry, and RegisterNode::Read. It does not change whether a node is generally cacheable; it only controls how one specific read operation is executed.

Enumerator
UseCache	Use cache according to cache and invalidation rules.
IgnoreCache	Ignore cache for this read and request fresh data from the device.

NodeCachingMode

enum class peak::core::nodes::NodeCachingMode

strong

The node's caching mode, i.e. the <Cacheable> element. See GenAPI Caching.

Enumerator
NoCache	NoCache means all values are read directly from the device.
WriteThrough	WriteThrough means that a value written to the camera is written to the cache as well.
WriteAround	WriteAround means that only read values are written to the cache.

NodeDisplayNotation

enum class peak::core::nodes::NodeDisplayNotation

strong

Display notation for numbers in FloatNode.

Enumerator
Automatic
Fixed
Scientific

NodeIncrementType

enum class peak::core::nodes::NodeIncrementType

strong

Possible node increment types for number nodes (float, integer).

Enumerator
NoIncrement
FixedIncrement
ListIncrement

NodeNamespace

enum class peak::core::nodes::NodeNamespace

strong

The node's namespace, i.e. the <node NameSpace=""> attribute. See GenAPI Node.

Enumerator
Custom
Standard

NodeRepresentation

enum class peak::core::nodes::NodeRepresentation

strong

Possible node representations for number nodes (float, integer).

Enumerator
Linear
Logarithmic
Boolean
PureNumber
HexNumber
IP4Address
MACAddress

NodeType

enum class peak::core::nodes::NodeType

strong

Different node types

Enumerator
Integer
Boolean
Command
Float
String
Register
Category
Enumeration
EnumerationEntry

NodeVisibility

enum class peak::core::nodes::NodeVisibility

strong

Visibility of the node

Enumerator
Beginner
Expert
Guru
Invisible