XLinkOut node. Sends messages over XLink. More...

#include <XLinkOut.hpp>

Inheritance diagram for dai::node::XLinkOut:

Public Member Functions
float	getFpsLimit () const
	Get rate limit in messages per second. More...

bool	getMetadataOnly () const
	Get whether to transfer only messages attributes and not buffer data. More...

std::string	getStreamName () const
	Get stream name. More...

void	setFpsLimit (float fps)

void	setMetadataOnly (bool metadataOnly)

void	setStreamName (const std::string &name)

	XLinkOut (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)

	XLinkOut (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)

Public Member Functions inherited from dai::NodeCRTP< Node, XLinkOut, XLinkOutProperties >
std::unique_ptr< Node >	clone () const override

const char *	getName () const override

Public Member Functions inherited from dai::Node
virtual std::unique_ptr< Node >	clone () const =0
	Deep copy the node. More...

AssetManager &	getAssetManager ()
	Get node AssetManager as a reference. More...

const AssetManager &	getAssetManager () const
	Get node AssetManager as a const reference. More...

std::vector< Input * >	getInputRefs ()
	Retrieves reference to node inputs. More...

std::vector< const Input * >	getInputRefs () const
	Retrieves reference to node inputs. More...

std::vector< Input >	getInputs ()
	Retrieves all nodes inputs. More...

virtual const char *	getName () const =0
	Retrieves nodes name. More...

std::vector< Output * >	getOutputRefs ()
	Retrieves reference to node outputs. More...

std::vector< const Output * >	getOutputRefs () const
	Retrieves reference to node outputs. More...

std::vector< Output >	getOutputs ()
	Retrieves all nodes outputs. More...

Pipeline	getParentPipeline ()

const Pipeline	getParentPipeline () const

	Node (const std::shared_ptr< PipelineImpl > &p, Id nodeId, std::unique_ptr< Properties > props)
	Constructs Node. More...

virtual	~Node ()=default

Public Attributes
Input	input {*this, "in", Input::Type::SReceiver, true, 8, true, {{DatatypeEnum::Buffer, true}}}

Public Attributes inherited from dai::NodeCRTP< Node, XLinkOut, XLinkOutProperties >
Properties &	properties
	Underlying properties. More...

Public Attributes inherited from dai::Node
const Id	id
	Id of node. More...

Properties &	properties

Static Public Attributes
constexpr static const char *	NAME = "XLinkOut"

Additional Inherited Members
Public Types inherited from dai::NodeCRTP< Node, XLinkOut, XLinkOutProperties >
using	Properties = XLinkOutProperties

Public Types inherited from dai::Node
using	Id = std::int64_t
	Node identificator. Unique for every node on a single Pipeline. More...

Protected Member Functions inherited from dai::Node
virtual Properties &	getProperties ()

virtual tl::optional< OpenVINO::Version >	getRequiredOpenVINOVersion ()

void	setInputMapRefs (InputMap *inMapRef)

void	setInputMapRefs (std::initializer_list< InputMap * > l)

void	setInputRefs (Input *inRef)

void	setInputRefs (std::initializer_list< Input * > l)

void	setOutputMapRefs (OutputMap *outMapRef)

void	setOutputMapRefs (std::initializer_list< OutputMap * > l)

void	setOutputRefs (Output *outRef)

void	setOutputRefs (std::initializer_list< Output * > l)

Protected Attributes inherited from dai::Node
AssetManager	assetManager

std::unordered_map< std::string, InputMap * >	inputMapRefs

std::unordered_map< std::string, Input * >	inputRefs

std::unordered_map< std::string, OutputMap * >	outputMapRefs

std::unordered_map< std::string, Output * >	outputRefs

std::weak_ptr< PipelineImpl >	parent

copyable_unique_ptr< Properties >	propertiesHolder

Detailed Description

XLinkOut node. Sends messages over XLink.

Definition at line 14 of file XLinkOut.hpp.

Constructor & Destructor Documentation

◆ XLinkOut() [1/2]

dai::node::XLinkOut::XLinkOut	(	const std::shared_ptr< PipelineImpl > &	par,
		int64_t	nodeId
	)

Definition at line 6 of file XLinkOut.cpp.

◆ XLinkOut() [2/2]

dai::node::XLinkOut::XLinkOut	(	const std::shared_ptr< PipelineImpl > &	par,
		int64_t	nodeId,
		std::unique_ptr< Properties >	props
	)

Definition at line 7 of file XLinkOut.cpp.

Member Function Documentation

◆ getFpsLimit()

float dai::node::XLinkOut::getFpsLimit ( ) const

Get rate limit in messages per second.

Definition at line 29 of file XLinkOut.cpp.

◆ getMetadataOnly()

bool dai::node::XLinkOut::getMetadataOnly ( ) const

Get whether to transfer only messages attributes and not buffer data.

Definition at line 33 of file XLinkOut.cpp.

◆ getStreamName()

std::string dai::node::XLinkOut::getStreamName ( ) const

Get stream name.

Definition at line 25 of file XLinkOut.cpp.

◆ setFpsLimit()

void dai::node::XLinkOut::setFpsLimit ( float fps )

Specifies a message sending limit. It's approximated from specified rate.

Parameters

fps	Approximate rate limit in messages per second

Definition at line 17 of file XLinkOut.cpp.

◆ setMetadataOnly()

void dai::node::XLinkOut::setMetadataOnly ( bool metadataOnly )

Specify whether to transfer only messages attributes and not buffer data

Definition at line 21 of file XLinkOut.cpp.

◆ setStreamName()

void dai::node::XLinkOut::setStreamName ( const std::string & name )

Specifies XLink stream name to use.

The name should not start with double underscores '__', as those are reserved for internal use.

Parameters

name	Stream name

Definition at line 13 of file XLinkOut.cpp.

Member Data Documentation

◆ input

Input dai::node::XLinkOut::input {*this, "in", Input::Type::SReceiver, true, 8, true, {{DatatypeEnum::Buffer, true}}}

Input for any type of messages to be transferred over XLink stream

Default queue is blocking with size 8

Definition at line 27 of file XLinkOut.hpp.

◆ NAME

constexpr static const char* dai::node::XLinkOut::NAME = "XLinkOut"

staticconstexpr

Definition at line 16 of file XLinkOut.hpp.

The documentation for this class was generated from the following files:

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members