Public Member Functions | Public Attributes | Static Public Attributes | List of all members
dai::node::SPIOut Class Reference

SPIOut node. Sends messages over SPI. More...

#include <SPIOut.hpp>

Inheritance diagram for dai::node::SPIOut:
Inheritance graph
[legend]

Public Member Functions

void setBusId (int busId)
 
void setStreamName (std::string name)
 
 SPIOut (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId)
 
 SPIOut (const std::shared_ptr< PipelineImpl > &par, int64_t nodeId, std::unique_ptr< Properties > props)
 
- Public Member Functions inherited from dai::NodeCRTP< Node, SPIOut, SPIOutProperties >
std::unique_ptr< Nodeclone () const override
 
const char * getName () const override
 
- Public Member Functions inherited from dai::Node
virtual std::unique_ptr< Nodeclone () const =0
 Deep copy the node. More...
 
AssetManagergetAssetManager ()
 Get node AssetManager as a reference. More...
 
const AssetManagergetAssetManager () 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< InputgetInputs ()
 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< OutputgetOutputs ()
 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, SPIOut, SPIOutProperties >
Propertiesproperties
 Underlying properties. More...
 
- Public Attributes inherited from dai::Node
const Id id
 Id of node. More...
 
Propertiesproperties
 

Static Public Attributes

constexpr static const char * NAME = "SPIOut"
 

Additional Inherited Members

- Public Types inherited from dai::NodeCRTP< Node, SPIOut, SPIOutProperties >
using Properties = SPIOutProperties
 
- 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 PropertiesgetProperties ()
 
virtual tl::optional< OpenVINO::VersiongetRequiredOpenVINOVersion ()
 
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< PipelineImplparent
 
copyable_unique_ptr< PropertiespropertiesHolder
 

Detailed Description

SPIOut node. Sends messages over SPI.

Definition at line 14 of file SPIOut.hpp.

Constructor & Destructor Documentation

◆ SPIOut() [1/2]

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

Definition at line 18 of file SPIOut.hpp.

◆ SPIOut() [2/2]

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

Definition at line 24 of file SPIOut.hpp.

Member Function Documentation

◆ setBusId()

void dai::node::SPIOut::setBusId ( int  busId)
inline

Specifies SPI Bus number to use

Parameters
idSPI Bus id

Definition at line 46 of file SPIOut.hpp.

◆ setStreamName()

void dai::node::SPIOut::setStreamName ( std::string  name)
inline

Specifies stream name over which the node will send data

Parameters
nameStream name

Definition at line 38 of file SPIOut.hpp.

Member Data Documentation

◆ input

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

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

Default queue is blocking with size 8

Definition at line 31 of file SPIOut.hpp.

◆ NAME

constexpr static const char* dai::node::SPIOut::NAME = "SPIOut"
staticconstexpr

Definition at line 16 of file SPIOut.hpp.


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


depthai
Author(s): Martin Peterlin
autogenerated on Thu Nov 16 2023 03:56:19