Public Types | Public Member Functions | Public Attributes | Private Attributes | List of all members
dai::Node::Output Class Reference

#include <Node.hpp>

Public Types

enum  Type { Type::MSender, Type::SSender }
 

Public Member Functions

bool canConnect (const Input &in)
 
std::vector< ConnectiongetConnections ()
 
NodegetParent ()
 
const NodegetParent () const
 
bool isSamePipeline (const Input &in)
 
void link (const Input &in)
 
 Output (Node &par, std::string group, std::string n, Type t, std::vector< DatatypeHierarchy > types)
 
 Output (Node &par, std::string n, Type t, std::vector< DatatypeHierarchy > types)
 
std::string toString () const
 Output to string representation. More...
 
void unlink (const Input &in)
 

Public Attributes

std::string group = ""
 
std::string name
 
std::vector< DatatypeHierarchypossibleDatatypes
 
Type type
 

Private Attributes

Nodeparent
 

Detailed Description

Definition at line 67 of file Node.hpp.

Member Enumeration Documentation

◆ Type

Enumerator
MSender 
SSender 

Definition at line 71 of file Node.hpp.

Constructor & Destructor Documentation

◆ Output() [1/2]

dai::Node::Output::Output ( Node par,
std::string  n,
Type  t,
std::vector< DatatypeHierarchy types 
)
inline

Definition at line 77 of file Node.hpp.

◆ Output() [2/2]

dai::Node::Output::Output ( Node par,
std::string  group,
std::string  n,
Type  t,
std::vector< DatatypeHierarchy types 
)
inline

Definition at line 79 of file Node.hpp.

Member Function Documentation

◆ canConnect()

bool dai::Node::Output::canConnect ( const Input in)

Check if connection is possible

Parameters
inInput to connect to
Returns
True if connection is possible, false otherwise

Definition at line 80 of file Node.cpp.

◆ getConnections()

std::vector< Node::Connection > dai::Node::Output::getConnections ( )

Retrieve all connections from this output

Returns
Vector of connections

Definition at line 59 of file Node.cpp.

◆ getParent() [1/2]

Node& dai::Node::Output::getParent ( )
inline

Definition at line 82 of file Node.hpp.

◆ getParent() [2/2]

const Node& dai::Node::Output::getParent ( ) const
inline

Definition at line 85 of file Node.hpp.

◆ isSamePipeline()

bool dai::Node::Output::isSamePipeline ( const Input in)

Check if this output and given input are on the same pipeline.

See also
canConnect for checking if connection is possible
Returns
True if output and input are on the same pipeline

Definition at line 70 of file Node.cpp.

◆ link()

void dai::Node::Output::link ( const Input in)

Link current output to input.

Throws an error if this output cannot be linked to given input, or if they are already linked

Parameters
inInput to link to

Definition at line 84 of file Node.cpp.

◆ toString()

std::string dai::Node::Output::toString ( ) const

Output to string representation.

Definition at line 43 of file Node.cpp.

◆ unlink()

void dai::Node::Output::unlink ( const Input in)

Unlink a previously linked connection

Throws an error if not linked.

Parameters
inInput from which to unlink from

Definition at line 89 of file Node.cpp.

Member Data Documentation

◆ group

std::string dai::Node::Output::group = ""

Definition at line 72 of file Node.hpp.

◆ name

std::string dai::Node::Output::name

Definition at line 73 of file Node.hpp.

◆ parent

Node& dai::Node::Output::parent
private

Definition at line 68 of file Node.hpp.

◆ possibleDatatypes

std::vector<DatatypeHierarchy> dai::Node::Output::possibleDatatypes

Definition at line 76 of file Node.hpp.

◆ type

Type dai::Node::Output::type

Definition at line 74 of file Node.hpp.


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


depthai
Author(s): Martin Peterlin
autogenerated on Sat Jun 1 2024 02:57:08