Base class for nodes that will store the result of a computation graph. More...

#include <Dataflow/Core/Sinks/SinkNode.hpp>

Inheritance diagram for Ra::Dataflow::Core::Sinks::SinkNode< T >:

Collaboration diagram for Ra::Dataflow::Core::Sinks::SinkNode< T >:

Public Member Functions
	SinkNode (const std::string &name)

void	init () override
	initialize the interface port data pointer

bool	execute () override
	Executes the node.

T	data () const

const T &	data_reference () const

Public Member Functions inherited from Ra::Dataflow::Core::Node
virtual	~Node ()=default
	make Node a base abstract class

bool	operator== (const Node &node)
	Two nodes are considered equal if there model and instance names are the same.

void	add_metadata (const nlohmann::json &data)
	Add a metadata to the node to store application specific information.

const nlohmann::json &	metadata ()
	Give access to extra json data stored on the node.

bool	is_initialized () const

Ra::Core::VariableSet &	parameters ()
	Return node's parameters.

Ra::Core::VariableSet &	input_variables ()
	Return a variable set of input ports default value reference, if any.

bool	is_output ()
	Node is output if none of the output ports is linked.

bool	is_input ()
	Node is input if all input ports have default values and not linked.

	Node (const Node &)=delete

Node &	operator= (const Node &)=delete

virtual bool	compile ()
	Compile the node to check its validity.

virtual void	destroy ()
	Delete the node's content.

auto	port_by_name (const std::string &type, const std::string &name) const -> IndexAndPort< PortBaseRawPtr >
	Get a port by its name.

auto	input_by_name (const std::string &name) const -> IndexAndPort< PortBaseInRawPtr >
	Convenience alias to port_by_name("in", name)

auto	output_by_name (const std::string &name) const -> IndexAndPort< PortBaseOutRawPtr >
	Convenience alias to port_by_name("out", name)

PortBaseRawPtr	port_by_index (const std::string &type, PortIndex index) const
	Get a port by its index.

auto	input_by_index (PortIndex index) const
	Convenience alias to port_by_index("in", index)

auto	output_by_index (PortIndex index) const
	Convenience alias to port_by_index("out", index)

template<typename T >
auto	input_by_index (PortIndex index) const
	Convenience alias with typed port.

template<typename T >
auto	output_by_index (PortIndex index) const
	Convenience alias with typed port.

const PortBaseInCollection &	inputs () const
	Gets the in ports of the node.

const PortBaseOutCollection &	outputs () const
	Gets the out ports of the node.

const std::string &	model_name () const
	Gets the model (type/class) name of the node.

const std::string &	display_name () const
	Gets the display name of the node (e.g. for gui), no need to be unique in a graph.

void	set_display_name (const std::string &name)
	Set the display name.

const std::string &	instance_name () const
	Gets the instance name of the node.

void	set_instance_name (const std::string &name)
	Sets the instance name the node (unused?) instance name must be unique in a graph.

void	toJson (nlohmann::json &data) const
	Serialize the content of the node.

bool	fromJson (const nlohmann::json &data)
	Unserialized the content of the node.

Static Public Member Functions
static const std::string &	node_typename ()

Protected Member Functions
	SinkNode (const std::string &instanceName, const std::string &typeName)

void	toJsonInternal (nlohmann::json &data) const override
	Internal json representation of the Node.

bool	fromJsonInternal (const nlohmann::json &data) override
	Internal json representation of the Node.

Protected Member Functions inherited from Ra::Dataflow::Core::Node
	Node (const std::string &instance, const std::string &typeName)
	Construct the base node given its name and type.

template<typename PortType >
auto	port_by_name (const PortCollection< PortPtr< PortType > > &ports, const std::string &name) const -> IndexAndPort< PortRawPtr< PortType > >
	Gets the Port By Name.

template<typename PortType >
auto	port_base (const PortCollection< PortPtr< PortType > > &ports, PortIndex idx) const -> PortRawPtr< PortType >
	Gets the PortBase In or Out by its index.

template<typename T , typename PortType >
auto	port (const PortCollection< PortPtr< PortType > > &ports, PortIndex index) const
	Gets a port in a collection by its index.

template<typename PortType >
PortIndex	add_port (PortCollection< PortPtr< PortType > > &, PortPtr< PortType > port)
	Adds a port to port collection.

PortIndex	add_input (PortBaseInPtr in)
	Convenience alias to add_port(inputs(), in)

PortIndex	add_output (PortBaseOutPtr out)
	Convenience alias to add_port(outputs(), out)

template<typename T , typename... U>
auto	add_input (U &&... u)
	Adds a typed input port.

template<typename T , typename... U>
auto	add_output (U &&... u)
	Adds a typed output port.

template<typename T >
auto	input_port (PortIndex index)
	Gets a typed (input/output) port.

template<typename T >
auto	output_port (PortIndex index)
	Gets a typed (input/output) port.

void	remove_input (PortIndex index)
	Remove the given port from the managed (input/output) ports.

void	remove_output (PortIndex index)
	Remove the given port from the managed (input/output) ports.

template<typename T >
auto	add_parameter (const std::string &name, const T &value)

template<typename T >
bool	remove_parameter (const std::string &name)

template<typename T >
bool	remove_parameter (ParamHandle< T > &handle)

Additional Inherited Members
Public Types inherited from Ra::Dataflow::Core::Node
using	PortIndex = Ra::Core::Utils::Index

template<typename Port >
using	PortCollection = std::vector<Port>

template<typename Port >
using	PortPtr = std::shared_ptr<Port>

template<typename Port >
using	PortRawPtr = Port*

template<typename Type >
using	PortInPtr = PortPtr<PortIn<Type>>

template<typename Type >
using	PortInRawPtr = PortIn<Type>*

template<typename Type >
using	PortOutPtr = PortPtr<PortOut<Type>>

template<typename Type >
using	PortOutRawPtr = PortOut<Type>*

using	PortBasePtr = PortPtr<PortBase>

using	PortBaseRawPtr = PortRawPtr<PortBase>

using	PortBaseCollection = PortCollection<PortBasePtr>

using	PortBaseInPtr = PortPtr<PortBaseIn>

using	PortBaseInRawPtr = PortRawPtr<PortBaseIn>

using	PortBaseInCollection = PortCollection<PortBaseInPtr>

using	PortBaseOutPtr = PortPtr<PortBaseOut>

using	PortBaseOutRawPtr = PortRawPtr<PortBaseOut>

using	PortBaseOutCollection = PortCollection<PortBaseOutPtr>

template<typename Port >
using	IndexAndPort = std::pair<PortIndex, Port>

template<typename T >
using	ParamHandle = Ra::Core::VariableSet::VariableHandle<T>

Protected Attributes inherited from Ra::Dataflow::Core::Node
bool	m_initialized { false }
	Flag that checks if the node is already initialized.

std::string	m_model_name
	The type name of the node. Initialized once at construction.

std::string	m_instance_name
	The instance name of the node.

std::string	m_display_name { "" }
	Node's name if needed for display.

PortCollection< PortPtr< PortBaseIn > >	m_inputs
	The in ports of the node (own by the node)

PortCollection< PortPtr< PortBaseOut > >	m_outputs
	The out ports of the node (own by the node)

Ra::Core::VariableSet	m_parameters
	The editable parameters of the node.

Ra::Core::VariableSet	m_input_variables

nlohmann::json	m_metadata
	Additional data on the node, added by application or gui or ...

Detailed Description

template<typename T>
class Ra::Dataflow::Core::Sinks::SinkNode< T >

Base class for nodes that will store the result of a computation graph.

Template Parameters

T	The type of the data to serve.

Definition at line 16 of file SinkNode.hpp.

Constructor & Destructor Documentation

◆ SinkNode() [1/2]

template<typename T >

Ra::Dataflow::Core::Sinks::SinkNode< T >::SinkNode	(	const std::string &	instanceName,
		const std::string &	typeName )

protected

Definition at line 61 of file SinkNode.hpp.

◆ SinkNode() [2/2]

template<typename T >

Ra::Dataflow::Core::Sinks::SinkNode< T >::SinkNode ( const std::string & name )

inlineexplicit

Definition at line 22 of file SinkNode.hpp.

Member Function Documentation

◆ data()

template<typename T >

T Ra::Dataflow::Core::Sinks::SinkNode< T >::data ( ) const

Get the delivered data

Returns: a copy of the delivered data.

Definition at line 79 of file SinkNode.hpp.

◆ data_reference()

template<typename T >

const T & Ra::Dataflow::Core::Sinks::SinkNode< T >::data_reference ( ) const

Get the delivered data

Returns: a const ref to the delivered data.

Definition at line 85 of file SinkNode.hpp.

◆ execute()

template<typename T >

bool Ra::Dataflow::Core::Sinks::SinkNode< T >::execute ( )

overridevirtual

Executes the node.

Execute the node function on the input ports (to be fetched) and write the results to the output ports.

Returns: the execution status.

Implements Ra::Dataflow::Core::Node.

Definition at line 70 of file SinkNode.hpp.

◆ fromJsonInternal()

template<typename T >

bool Ra::Dataflow::Core::Sinks::SinkNode< T >::fromJsonInternal ( const nlohmann::json & data )

inlineoverrideprotectedvirtual

Internal json representation of the Node.

Default implementation warn about unsupported deserialization. Effective deserialzation must be implemented by inheriting classes. Be careful with template specialization and function member overriding in derived classes.

Reimplemented from Ra::Dataflow::Core::Node.

Definition at line 43 of file SinkNode.hpp.

Here is the call graph for this function:

◆ init()

template<typename T >

void Ra::Dataflow::Core::Sinks::SinkNode< T >::init ( )

overridevirtual

initialize the interface port data pointer

Reimplemented from Ra::Dataflow::Core::Node.

Definition at line 65 of file SinkNode.hpp.

Here is the call graph for this function:

◆ node_typename()

template<typename T >

const std::string & Ra::Dataflow::Core::Sinks::SinkNode< T >::node_typename ( )

static

Definition at line 91 of file SinkNode.hpp.

◆ toJsonInternal()

template<typename T >

void Ra::Dataflow::Core::Sinks::SinkNode< T >::toJsonInternal ( nlohmann::json & data ) const

inlineoverrideprotectedvirtual

Internal json representation of the Node.

Default implementation warn about unsupported deserialization. Effective deserialzation must be implemented by inheriting classes. Be careful with template specialization and function member overriding in derived classes.

Reimplemented from Ra::Dataflow::Core::Node.

Definition at line 42 of file SinkNode.hpp.

Here is the call graph for this function:

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

/home/runner/work/Radium-Engine/Radium-Engine/src/Radium-Engine/src/Dataflow/Core/Sinks/SinkNode.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ SinkNode() [1/2]

◆ SinkNode() [2/2]

Member Function Documentation

◆ data()

◆ data_reference()

◆ execute()

◆ fromJsonInternal()

◆ init()

◆ node_typename()

◆ toJsonInternal()