dai::node::XLinkIn Class Reference

XLinkIn node. Receives messages over XLink. More...

#include <XLinkIn.hpp>

Inheritance diagram for dai::node::XLinkIn:

Public Member Functions
std::uint32_t	getMaxDataSize () const
	Get maximum messages size in bytes. More...
std::uint32_t	getNumFrames () const
	Get number of frames in pool. More...
std::string	getStreamName () const
	Get stream name. More...
void	setMaxDataSize (std::uint32_t maxDataSize)
void	setNumFrames (std::uint32_t numFrames)
void	setStreamName (const std::string &name)
	XLinkIn (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
	XLinkIn (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
Public Member Functions inherited from dai::NodeCRTP< Node, XLinkIn, XLinkInProperties >
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
Output	out {*this, "out", Output::Type::MSender, {{DatatypeEnum::Buffer, true}}}
Public Attributes inherited from dai::NodeCRTP< Node, XLinkIn, XLinkInProperties >
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 = "XLinkIn"

Additional Inherited Members
Public Types inherited from dai::NodeCRTP< Node, XLinkIn, XLinkInProperties >
using	Properties = XLinkInProperties
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

XLinkIn node. Receives messages over XLink.

Definition at line 14 of file XLinkIn.hpp.

Constructor & Destructor Documentation

XLinkIn() [1/2]

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

Definition at line 6 of file XLinkIn.cpp.

XLinkIn() [2/2]

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

Definition at line 7 of file XLinkIn.cpp.

Member Function Documentation

getMaxDataSize()

std::uint32_t dai::node::XLinkIn::getMaxDataSize

(

)

const

Get maximum messages size in bytes.

Definition at line 28 of file XLinkIn.cpp.

getNumFrames()

std::uint32_t dai::node::XLinkIn::getNumFrames

(

)

const

Get number of frames in pool.

Definition at line 32 of file XLinkIn.cpp.

getStreamName()

std::string dai::node::XLinkIn::getStreamName

(

)

const

Get stream name.

Definition at line 24 of file XLinkIn.cpp.

setMaxDataSize()

void dai::node::XLinkIn::setMaxDataSize

(

std::uint32_t

maxDataSize

)

Set maximum message size it can receive

Parameters

maxDataSize

Maximum size in bytes

Definition at line 16 of file XLinkIn.cpp.

setNumFrames()

void dai::node::XLinkIn::setNumFrames

(

std::uint32_t

numFrames

)

Set number of frames in pool for sending messages forward

Parameters

numFrames

Maximum number of frames in pool

Definition at line 20 of file XLinkIn.cpp.

setStreamName()

void dai::node::XLinkIn::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 12 of file XLinkIn.cpp.

Member Data Documentation

NAME

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

staticconstexpr

Definition at line 16 of file XLinkIn.hpp.

out

Output dai::node::XLinkIn::out {*this, "out", Output::Type::MSender, {{DatatypeEnum::Buffer, true}}}

Outputs message of same type as send from host.

Definition at line 25 of file XLinkIn.hpp.

---

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

• XLinkIn.hpp
• XLinkIn.cpp