peak::core::nodes Namespace Reference

The "nodes" namespace contains all GenAPI node types. More...

Classes
class	BooleanNode
	Represents a GenAPI boolean node. More...
class	CategoryNode
	Represents a GenAPI category node. More...
class	CommandNode
	Represents a GenAPI command node. More...
class	EnumerationEntryNode
	Represents a GenAPI enumeration entry node. More...
class	EnumerationNode
	Represents a GenAPI enumeration node. More...
class	FloatNode
	Represents a GenAPI float node. More...
class	IntegerNode
	Represents a GenAPI integer node. More...
class	Node
	Represents a GenAPI node. More...
class	RegisterNode
	Represents a GenAPI register node. More...
class	StringNode
	Represents a GenAPI string node. More...

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

Functions
std::string	ToString (NodeCacheUsePolicy entry)
std::string	ToString (NodeIncrementType entry)
std::string	ToString (NodeRepresentation entry)
std::string	ToString (NodeDisplayNotation entry)
std::string	GetNodeName (PEAK_NODE_HANDLE nodeHandle)
std::string	ToString (NodeAccessStatus entry)
std::string	ToString (NodeCachingMode entry)
std::string	ToString (NodeNamespace entry)
std::string	ToString (NodeType entry)
std::string	ToString (NodeVisibility entry)

Detailed Description

The "nodes" namespace contains all GenAPI node types.

Enumeration Type Documentation

NodeAccessStatus

enum 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 peak::core::nodes::NodeCacheUsePolicy

strong

The enum holding the possible use policies of node cache .

Enumerator
UseCache
IgnoreCache

NodeCachingMode

enum 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 peak::core::nodes::NodeDisplayNotation

strong

Display notation for numbers in FloatNode.

Enumerator
Automatic
Fixed
Scientific

NodeIncrementType

enum peak::core::nodes::NodeIncrementType

strong

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

Enumerator
NoIncrement
FixedIncrement
ListIncrement

NodeNamespace

enum peak::core::nodes::NodeNamespace

strong

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

Enumerator
Custom
Standard

NodeRepresentation

enum peak::core::nodes::NodeRepresentation

strong

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

Enumerator
Linear
Logarithmic
Boolean
PureNumber
HexNumber
IP4Address
MACAddress

NodeType

enum peak::core::nodes::NodeType

strong

Different node types

Enumerator
Integer
Boolean
Command
Float
String
Register
Category
Enumeration
EnumerationEntry

NodeVisibility

enum peak::core::nodes::NodeVisibility

strong

Visibility of the node

Enumerator
Beginner
Expert
Guru
Invisible

Function Documentation

GetNodeName()

std::string peak::core::nodes::GetNodeName ( PEAK_NODE_HANDLE  nodeHandle )

inline

ToString() [1/9]

std::string peak::core::nodes::ToString ( NodeCacheUsePolicy  entry )

inline

ToString() [2/9]

std::string peak::core::nodes::ToString ( NodeIncrementType  entry )

inline

ToString() [3/9]

std::string peak::core::nodes::ToString ( NodeRepresentation  entry )

inline

ToString() [4/9]

std::string peak::core::nodes::ToString ( NodeDisplayNotation  entry )

inline

ToString() [5/9]

std::string peak::core::nodes::ToString ( NodeAccessStatus  entry )

inline

ToString() [6/9]

std::string peak::core::nodes::ToString ( NodeCachingMode  entry )

inline

ToString() [7/9]

std::string peak::core::nodes::ToString ( NodeNamespace  entry )

inline

ToString() [8/9]

std::string peak::core::nodes::ToString ( NodeType  entry )

inline

ToString() [9/9]

std::string peak::core::nodes::ToString ( NodeVisibility  entry )

inline