Interface INodeScript
Represents a node script
Namespace: Artemis.Core
Assembly: Artemis.Core.dll
Syntax
public interface INodeScript : IDisposable, IStorageModel
Properties
Context
Gets or sets the context of the node script, usually a Profile or ProfileConfiguration.
Declaration
object? Context { get; set; }
Property Value
Type | Description |
---|---|
object |
Description
Gets the description of the node script.
Declaration
string Description { get; }
Property Value
Type | Description |
---|---|
string |
Name
Gets the name of the node script.
Declaration
string Name { get; }
Property Value
Type | Description |
---|---|
string |
Nodes
Gets an enumerable of all the nodes on this script.
Declaration
IEnumerable<INode> Nodes { get; }
Property Value
Type | Description |
---|---|
IEnumerable<INode> |
ResultType
Gets the return type of the node script.
Declaration
Type ResultType { get; }
Property Value
Type | Description |
---|---|
Type |
Methods
AddNode(INode)
Adds a node to the script
Declaration
void AddNode(INode node)
Parameters
Type | Name | Description |
---|---|---|
INode | node | The node to add |
LoadConnections()
Loads missing connections between the nodes of this node script from storage
Declaration
void LoadConnections()
RemoveNode(INode)
Removes a node from the script
Note: If the node is IDisposable you must dispose it yourself, unless you plan to reuse the node.
Declaration
void RemoveNode(INode node)
Parameters
Type | Name | Description |
---|---|---|
INode | node | The node to remove |
Run()
Runs the script, evaluating nodes where needed
Declaration
void Run()
Events
NodeAdded
Occurs whenever a node was added to the script
Declaration
event EventHandler<SingleValueEventArgs<INode>>? NodeAdded
Event Type
Type | Description |
---|---|
EventHandler<SingleValueEventArgs<INode>> |
NodeRemoved
Occurs whenever a node was removed from the script
Declaration
event EventHandler<SingleValueEventArgs<INode>>? NodeRemoved
Event Type
Type | Description |
---|---|
EventHandler<SingleValueEventArgs<INode>> |