Loading [MathJax]/extensions/tex2jax.js
Radium Engine  1.5.28
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Ra::Dataflow::Core::PortOut< T > Class Template Reference

Forward PortOut classes used by getLink and reflect. More...

#include <Dataflow/Core/PortOut.hpp>

+ Collaboration diagram for Ra::Dataflow::Core::PortOut< T >:

Public Types

using DataType = T
 

Public Member Functions

T & data ()
 Gets a reference to the data this ports points to.
 
void set_data (T *data)
 
bool has_data () override
 Returns true if the pointer to the data is not null.
 
Constructors

delete default constructors.

 PortOut (const PortOut &)=delete
 
PortOutoperator= (const PortOut &)=delete
 
 PortOut (Node *node, const std::string &name)
 
 PortOut (Node *node, T *data, const std::string &name)
 

Detailed Description

template<typename T>
class Ra::Dataflow::Core::PortOut< T >

Forward PortOut classes used by getLink and reflect.

Output port delivering data of Type T. Output port stores a non-owning pointer to the data that will be made available on a connection.

Template Parameters
TThe type of the delivered data.

Definition at line 72 of file PortOut.hpp.

Member Typedef Documentation

◆ DataType

template<typename T >
using Ra::Dataflow::Core::PortOut< T >::DataType = T

Definition at line 75 of file PortOut.hpp.

Constructor & Destructor Documentation

◆ PortOut() [1/2]

template<typename T >
Ra::Dataflow::Core::PortOut< T >::PortOut ( Node * node,
const std::string & name )
inline

Constructor.

Parameters
nameThe name of the port.
nodeThe pointer to the node associated with the port.

Definition at line 87 of file PortOut.hpp.

◆ PortOut() [2/2]

template<typename T >
Ra::Dataflow::Core::PortOut< T >::PortOut ( Node * node,
T * data,
const std::string & name )
inline

Definition at line 91 of file PortOut.hpp.

Member Function Documentation

◆ data()

template<typename T >
T & Ra::Dataflow::Core::PortOut< T >::data ( )
inline

Gets a reference to the data this ports points to.

Definition at line 98 of file PortOut.hpp.

◆ has_data()

template<typename T >
bool Ra::Dataflow::Core::PortOut< T >::has_data ( )
inlineoverridevirtual

Returns true if the pointer to the data is not null.

Implements Ra::Dataflow::Core::PortBase.

Definition at line 103 of file PortOut.hpp.

◆ set_data()

template<typename T >
void Ra::Dataflow::Core::PortOut< T >::set_data ( T * data)
inline

Takes a pointer to the data this port will point to.

Parameters
dataThe pointer to the data.

Definition at line 101 of file PortOut.hpp.

+ Here is the call graph for this function:

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