Class Node

Note

You have to include the header Node.h.

class Node

This class represents a graph Node in Instant Terra.

Throws
// Get the first node of a graph
InstantTerra instantTerra = CreateInstantTerra();
Project project = instantTerra.GetProject();
Graph graph = project.GetGraph();

Node firstNode = graph.GetNode(0);

int Node::GetNodeCount()

Returns the number of nodes on the Graph

size_t Node::GetNameLength()

Returns the name length

void Node::GetName(wchar_t *buffer, size_t bufferLength)

Fill the buffer with the node name

size_t Node::GetCommentLength()

Returns the comment length

void Node::GetComment(wchar_t *buffer, size_t bufferLength)

Fill the buffer with the node comment

bool Node::HasParameter(const wchar_t *parameterName)

Returns true if the parameter exist

int Node::GetParameterCount()

Returns the number of node parameters

size_t Node::GetParameterNameLength(int parameterIndex)

Returns the parameter name length

Throws

Error If the parameterIndex is out of bound, the following error code will be reported ErrorCode::ParameterIndexOutOfBound.

void Node::GetParameterName(int parameterIndex, wchar_t *buffer, size_t bufferLength)

Fill the buffer witht the parameter name

Throws

Error If the parameterIndex is out of bound, the following error code will be reported ErrorCode::ParameterIndexOutOfBound.

size_t Node::GetParameterValueLength(const wchar_t *parameterName)

Returns the parameter value length

Throws

Error If the parameter is not found, the following error code will be reported ErrorCode::ParameterDoesNotExist.

void Node::GetParameterValue(const wchar_t *parameterName, wchar_t *buffer, size_t bufferLength)

Fill the buffer witht the parameter value

Throws

Error If the parameter is not found, the following error code will be reported ErrorCode::ParameterDoesNotExist.

NodeModel Node::GetNodeModel()

Returns the node model

int Node::GetConnectorCount()

Returns the number of connectors

Connector Node::GetConnector(int connectorIndex)

Returns the connector at the index

Throws

Error If the connectorIndex is out of bound, the following error code will be reported ErrorCode::ConnectorIndexOutOfBound.

Data Node::GetData(Connector &connector)

Returns data

bool Node::DoesNodeExist()

Returns if the node still exist or not


Copyright © 2020 · All Rights Reserved · Wysilab