Class Node::Input

Nested Relationships

This class is a nested type of Class Node.

Class Documentation

class Input

Public Types

enum class Type

Values:

enumerator SReceiver
enumerator MReceiver

Public Functions

inline Input(Node &par, std::string n, Type t, std::vector<DatatypeHierarchy> types)

Constructs Input with default blocking and queueSize options.

inline Input(Node &par, std::string n, Type t, bool blocking, int queueSize, std::vector<DatatypeHierarchy> types)

Constructs Input with specified blocking and queueSize options.

inline Input(Node &par, std::string n, Type t, bool blocking, int queueSize, bool waitForMessage, std::vector<DatatypeHierarchy> types)

Constructs Input with specified blocking and queueSize as well as additional options.

inline Input(Node &par, std::string group, std::string n, Type t, bool blocking, int queueSize, bool waitForMessage, std::vector<DatatypeHierarchy> types)

Constructs Input with specified blocking and queueSize as well as additional options.

inline Node &getParent()
inline const Node &getParent() const
std::string toString() const

Input to string representation.

void setBlocking(bool blocking)

Overrides default input queue behavior.

Parameters:

blocking – True blocking, false overwriting

bool getBlocking() const

Get input queue behavior

Returns:

True blocking, false overwriting

void setQueueSize(int size)

Overrides default input queue size. If queue size fills up, behavior depends on blocking attribute

Parameters:

size – Maximum input queue size

int getQueueSize() const

Get input queue size.

Returns:

Maximum input queue size

void setWaitForMessage(bool waitForMessage)

Overrides default wait for message behavior. Applicable for nodes with multiple inputs. Specifies behavior whether to wait for this input when a Node processes certain data or not.

Parameters:

waitForMessage – Whether to wait for message to arrive to this input or not

bool getWaitForMessage() const

Get behavior whether to wait for this input when a Node processes certain data or not

Returns:

Whether to wait for message to arrive to this input or not

void setReusePreviousMessage(bool reusePreviousMessage)

Equivalent to setWaitForMessage but with inverted logic.

bool getReusePreviousMessage() const

Equivalent to getWaitForMessage but with inverted logic.

Public Members

std::string group = ""
std::string name
Type type
bool defaultBlocking = {true}
int defaultQueueSize = {8}
tl::optional<bool> blocking
tl::optional<int> queueSize
tl::optional<bool> waitForMessage
bool defaultWaitForMessage = {false}
std::vector<DatatypeHierarchy> possibleDatatypes

Friends

friend class Output