Base class for all job nodes. More...

Inheritance diagram for Waher.Jobs.JobNode:

Public Member Functions
	JobNode ()
	Base class for all job nodes. More...

override bool	Equals (object obj)
	Determines whether the specified object is equal to the current object. More...

override int	GetHashCode ()
	Serves as the default hash function. More...

override string	ToString ()

virtual Task	LogErrorAsync (string Body)
	Logs an error message on the node. More...

virtual Task	LogErrorAsync (string EventId, string Body)
	Logs an error message on the node. More...

virtual Task	LogWarningAsync (string Body)
	Logs an warning message on the node. More...

virtual Task	LogWarningAsync (string EventId, string Body)
	Logs an warning message on the node. More...

virtual Task	LogInformationAsync (string Body)
	Logs an informational message on the node. More...

virtual Task	LogInformationAsync (string EventId, string Body)
	Logs an informational message on the node. More...

virtual Task	LogMessageAsync (MessageType Type, string Body)
	Logs a message on the node. More...

virtual async Task	LogMessageAsync (MessageType Type, string EventId, string Body)
	Logs a message on the node. More...

virtual Task< bool >	RemoveErrorAsync ()
	Removes error messages with an empty event ID from the node. More...

virtual Task< bool >	RemoveErrorAsync (string EventId)
	Removes error messages with a given event ID from the node. More...

virtual Task< bool >	RemoveWarningAsync ()
	Removes warning messages with an empty event ID from the node. More...

virtual Task< bool >	RemoveWarningAsync (string EventId)
	Removes warning messages with a given event ID from the node. More...

virtual Task< bool >	RemoveInformationAsync ()
	Removes warning messages with an empty event ID from the node. More...

virtual Task< bool >	RemoveInformationAsync (string EventId)
	Removes an informational message on the node. More...

virtual Task< bool >	RemoveMessageAsync (MessageType Type)
	Removes messages with empty event IDs from the node. More...

virtual async Task< bool >	RemoveMessageAsync (MessageType Type, string EventId)
	Logs a message on the node. More...

abstract Task< string >	GetTypeNameAsync (Language Language)
	Gets the type name of the node. More...

async Task< INode >	GetParent ()
	Gets the parent of the node. More...

async Task< T >	GetAncestor< T > ()
	Tries to get an ancestor node of a given type, if one exists. More...

virtual Task< bool >	CanViewAsync (RequestOrigin Caller)
	If the node is visible to the caller. More...

virtual Task< bool >	CanEditAsync (RequestOrigin Caller)
	If the node can be edited by the caller. More...

virtual Task< bool >	CanAddAsync (RequestOrigin Caller)
	If the node can be added to by the caller. More...

virtual Task< bool >	CanDestroyAsync (RequestOrigin Caller)
	If the node can be destroyed to by the caller. More...

virtual async Task< IEnumerable< Parameter > >	GetDisplayableParametersAsync (Language Language, RequestOrigin Caller)
	Gets displayable parameters. More...

async Task< Parameter[]>	GetDisplayableParameterAraryAsync (Language Language, RequestOrigin Caller)
	Gets displayable parameters. More...

virtual async Task< IEnumerable< Message > >	GetMessagesAsync (RequestOrigin Caller)
	Gets messages logged on the node. More...

async Task< Message[]>	GetMessageArrayAsync (RequestOrigin Caller)
	Gets messages logged on the node. More...

virtual async Task< bool >	MoveUpAsync (RequestOrigin Caller)
	Tries to move the node up. More...

virtual async Task< bool >	MoveDownAsync (RequestOrigin Caller)
	Tries to move the node down. More...

virtual async Task< bool >	MoveUpAsync (JobNode Child, RequestOrigin Caller)
	Tries to move the child node up. More...

virtual async Task< bool >	MoveDownAsync (JobNode Child, RequestOrigin Caller)
	Tries to move the child node down. More...

abstract Task< bool >	AcceptsParentAsync (INode Parent)
	If the node accepts a presumptive parent, i.e. can be added to that parent (if that parent accepts the node as a child). More...

abstract Task< bool >	AcceptsChildAsync (INode Child)
	If the node accepts a presumptive child, i.e. can receive as a child (if that child accepts the node as a parent). More...

virtual async Task	AddAsync (INode Child)
	Adds a new child to the node. More...

virtual async Task	UpdateAsync ()
	Updates the node (in persisted storage). More...

virtual async Task< bool >	RemoveAsync (INode Child)
	Removes a child from the node. More...

virtual async Task	DestroyAsync ()
	Destroys the node. If it is a child to a parent node, it is removed from the parent first. More...

virtual Task	AddedToRoot (Root Root)
	Node has been added to the root node. More...

virtual Task	RemovedFromRoot (Root Root)
	Node has been removed from the root node. More...

Static Public Member Functions
static implicit	operator ThingReference (JobNode Node)
	Converts a JobNode to a ThingReference object. More...

static async Task< string >	GetUniqueJobId (string JobId)
	Gets a Job ID, based on JobId that is not already available in the database. More...

Protected Member Functions
virtual JobNode[]	SortChildrenAfterLoadLocked (List< JobNode > Children)
	Method that allows the node to sort its children, after they have been loaded. More...

virtual JobNode[]	CheckOrderLocked (List< JobNode > Children)
	Checks the ordering of children. More...

virtual async Task	NodeUpdated ()
	Persists changes to the node, and generates a node updated event. More...

Properties
Guid	ObjectId `[get, set]`
	Object ID in persistence layer. More...

Guid	ParentId `[get, set]`
	Object ID of parent node in persistence layer. More...

DateTime	Created `[get, set]`
	When node was created. More...

DateTime	Updated `[get, set]`
	When node was last updated. If it has not been updated, value will be DateTime.MinValue. More...

int	SiblingOrdinal `[get, set]`
	Sibling ordinal, used to order siblings when ordered. More...

string	NodeId `[get, set]`
	ID of node. More...

string	SourceId `[get]`
	Optional ID of source containing node. More...

string	Partition `[get]`
	Optional partition in which the Node ID is unique. More...

virtual string	LocalId `[get]`
	If provided, an ID for the node, but unique locally between siblings. Can be null, if Local ID equal to Node ID. More...

virtual string	LogId `[get]`
	If provided, an ID for the node, as it would appear or be used in system logs. Can be null, if Log ID equal to Node ID. More...

bool	HasChildren `[get]`
	If the source has any child sources. More...

virtual bool	ChildrenOrdered `[get]`
	If the children of the node have an intrinsic order (true), or if the order is not important (false). More...

virtual bool	IsReadable `[get]`
	If the node can be read. More...

virtual bool	IsControllable `[get]`
	If the node can be controlled. More...

virtual bool	HasCommands `[get]`
	If the node has registered commands or not. More...

INode	Parent `[get]`
	Parent Node, or null if a root node. More...

DateTime	LastChanged `[get]`
	When the node was last updated. More...

NodeState	State `[get, set]`
	Current overall state of the node. More...

Task< IEnumerable< INode > >	ChildNodes `[get]`
	Child nodes. If no child nodes are available, null is returned. More...

virtual Task< IEnumerable< ICommand > >	Commands `[get]`
	Available command objects. If no commands are available, null is returned. More...

Events
EventHandlerAsync	OnUpdate = null
	Event raised when node has been updated. More...

Detailed Description

Base class for all job nodes.

Definition at line 29 of file JobNode.cs.

Constructor & Destructor Documentation

◆ JobNode()

Waher.Jobs.JobNode.JobNode ( )

Base class for all job nodes.

Definition at line 48 of file JobNode.cs.

Member Function Documentation

◆ AcceptsChildAsync()

abstract Task< bool > Waher.Jobs.JobNode.AcceptsChildAsync ( INode Child )

pure virtual

If the node accepts a presumptive child, i.e. can receive as a child (if that child accepts the node as a parent).

Parameters

Child Presumptive child node.

Returns: If the child is acceptable.

Implements Waher.Things.INode.

Implemented in Waher.Jobs.Metering.NodeTypes.ReferenceNode, Waher.Jobs.Metering.NodeTypes.SensorDataReadoutTaskNode, Waher.Jobs.Script.NodeTypes.ScriptExecutionTaskNode, Waher.Jobs.NodeTypes.Job, and Waher.Jobs.NodeTypes.Root.

◆ AcceptsParentAsync()

abstract Task< bool > Waher.Jobs.JobNode.AcceptsParentAsync ( INode Parent )

pure virtual

If the node accepts a presumptive parent, i.e. can be added to that parent (if that parent accepts the node as a child).

Parameters

Parent Presumptive parent node.

Returns: If the parent is acceptable.

Implements Waher.Things.INode.

Implemented in Waher.Jobs.Metering.NodeTypes.ReferenceNode, Waher.Jobs.NodeTypes.Job, Waher.Jobs.NodeTypes.JobTaskNode, and Waher.Jobs.NodeTypes.Root.

◆ AddAsync()

virtual async Task Waher.Jobs.JobNode.AddAsync ( INode Child )

virtual

Adds a new child to the node.

Parameters

Child New child to add.

Implements Waher.Things.INode.

Reimplemented in Waher.Jobs.NodeTypes.Root.

Definition at line 1093 of file JobNode.cs.

◆ AddedToRoot()

virtual Task Waher.Jobs.JobNode.AddedToRoot ( Root Root )

virtual

Node has been added to the root node.

Parameters

Root	Root node.

Reimplemented in Waher.Jobs.NodeTypes.Job.

Definition at line 1355 of file JobNode.cs.

◆ CanAddAsync()

virtual Task< bool > Waher.Jobs.JobNode.CanAddAsync ( RequestOrigin Caller )

virtual

If the node can be added to by the caller.

Parameters

Caller Information about caller.

Returns: If the node can be added to by the caller.

Implements Waher.Things.INode.

Definition at line 834 of file JobNode.cs.

◆ CanDestroyAsync()

virtual Task< bool > Waher.Jobs.JobNode.CanDestroyAsync ( RequestOrigin Caller )

virtual

If the node can be destroyed to by the caller.

Parameters

Caller Information about caller.

Returns: If the node can be destroyed to by the caller.

Implements Waher.Things.INode.

Reimplemented in Waher.Jobs.NodeTypes.Root.

Definition at line 844 of file JobNode.cs.

◆ CanEditAsync()

virtual Task< bool > Waher.Jobs.JobNode.CanEditAsync ( RequestOrigin Caller )

virtual

If the node can be edited by the caller.

Parameters

Caller Information about caller.

Returns: If the node can be edited by the caller.

Implements Waher.Things.INode.

Reimplemented in Waher.Jobs.NodeTypes.Root.

Definition at line 824 of file JobNode.cs.

◆ CanViewAsync()

virtual Task< bool > Waher.Jobs.JobNode.CanViewAsync ( RequestOrigin Caller )

virtual

If the node is visible to the caller.

Parameters

Caller Information about caller.

Returns: If the node is visible to the caller.

Implements Waher.Things.INode.

Definition at line 814 of file JobNode.cs.

◆ CheckOrderLocked()

virtual JobNode[] Waher.Jobs.JobNode.CheckOrderLocked ( List< JobNode > Children )

protectedvirtual

Checks the ordering of children.

Parameters

Children Child nodes.

Returns: Child nodes that need to be updated, or null if no such nodes.

Definition at line 771 of file JobNode.cs.

◆ DestroyAsync()

virtual async Task Waher.Jobs.JobNode.DestroyAsync ( )

virtual

Destroys the node. If it is a child to a parent node, it is removed from the parent first.

Implements Waher.Things.INode.

Definition at line 1278 of file JobNode.cs.

◆ Equals()

override bool Waher.Jobs.JobNode.Equals ( object obj )

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: true if the specified object is equal to the current object; otherwise, false.

Definition at line 68 of file JobNode.cs.

◆ GetAncestor< T >()

async Task< T > Waher.Jobs.JobNode.GetAncestor< T > ( )

Tries to get an ancestor node of a given type, if one exists.

Returns: Ancestor Node of given type, if found, null otherwise.

Type Constraints

T

:

INode

Definition at line 647 of file JobNode.cs.

◆ GetDisplayableParameterAraryAsync()

async Task< Parameter[]> Waher.Jobs.JobNode.GetDisplayableParameterAraryAsync	(	Language	Language,
		RequestOrigin	Caller
	)

Gets displayable parameters.

Parameters

Language	Language to use.
Caller	Information about caller.

Returns: Set of displayable parameters.

Definition at line 909 of file JobNode.cs.

◆ GetDisplayableParametersAsync()

virtual async Task< IEnumerable< Parameter > > Waher.Jobs.JobNode.GetDisplayableParametersAsync	(	Language	Language,
		RequestOrigin	Caller
	)

virtual

Gets displayable parameters.

Parameters

Language	Language to use.
Caller	Information about caller.

Returns: Set of displayable parameters.

Implements Waher.Things.INode.

Reimplemented in Waher.Jobs.NodeTypes.Job.

Definition at line 855 of file JobNode.cs.

◆ GetHashCode()

override int Waher.Jobs.JobNode.GetHashCode ( )

Serves as the default hash function.

Returns: A hash code for the current object.

Definition at line 80 of file JobNode.cs.

◆ GetMessageArrayAsync()

async Task< Message[]> Waher.Jobs.JobNode.GetMessageArrayAsync ( RequestOrigin Caller )

Gets messages logged on the node.

Returns: Array of messages.

Definition at line 936 of file JobNode.cs.

◆ GetMessagesAsync()

virtual async Task< IEnumerable< Message > > Waher.Jobs.JobNode.GetMessagesAsync ( RequestOrigin Caller )

virtual

Gets messages logged on the node.

Returns: Set of messages.

Implements Waher.Things.INode.

Definition at line 920 of file JobNode.cs.

◆ GetParent()

async Task< INode > Waher.Jobs.JobNode.GetParent ( )

Gets the parent of the node.

Returns: Parent instance.

Exceptions

Exception If parent is not found.

Implements Waher.Jobs.IJobNode.

Definition at line 628 of file JobNode.cs.

◆ GetTypeNameAsync()

abstract Task< string > Waher.Jobs.JobNode.GetTypeNameAsync ( Language Language )

pure virtual

Gets the type name of the node.

Parameters

Language Language to use.

Returns: Localized type node.

Implements Waher.Things.INode.

Implemented in Waher.Jobs.Metering.NodeTypes.GroupReference, Waher.Jobs.Metering.NodeTypes.MeteringNodeReference, Waher.Jobs.Metering.NodeTypes.OutputReference, Waher.Jobs.Metering.NodeTypes.ProcessorReference, Waher.Jobs.Metering.NodeTypes.SensorDataReadoutTaskNode, Waher.Jobs.Script.NodeTypes.ScriptExecutionTaskNode, Waher.Jobs.NodeTypes.Job, and Waher.Jobs.NodeTypes.Root.

◆ GetUniqueJobId()

static async Task< string > Waher.Jobs.JobNode.GetUniqueJobId ( string JobId )

static

Gets a Job ID, based on JobId that is not already available in the database.

Parameters

JobId Desired Job ID

Returns: A Job ID that does not exist in the database.

Definition at line 537 of file JobNode.cs.

◆ LogErrorAsync() [1/2]

virtual Task Waher.Jobs.JobNode.LogErrorAsync ( string Body )

virtual

Logs an error message on the node.

Parameters

Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 193 of file JobNode.cs.

◆ LogErrorAsync() [2/2]

virtual Task Waher.Jobs.JobNode.LogErrorAsync	(	string	EventId,
		string	Body
	)

virtual

Logs an error message on the node.

Parameters

EventId	Optional Event ID.
Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 203 of file JobNode.cs.

◆ LogInformationAsync() [1/2]

virtual Task Waher.Jobs.JobNode.LogInformationAsync ( string Body )

virtual

Logs an informational message on the node.

Parameters

Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 231 of file JobNode.cs.

◆ LogInformationAsync() [2/2]

virtual Task Waher.Jobs.JobNode.LogInformationAsync	(	string	EventId,
		string	Body
	)

virtual

Logs an informational message on the node.

Parameters

EventId	Optional Event ID.
Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 241 of file JobNode.cs.

◆ LogMessageAsync() [1/2]

virtual Task Waher.Jobs.JobNode.LogMessageAsync	(	MessageType	Type,
		string	Body
	)

virtual

Logs a message on the node.

Parameters

Type	Type of message.
Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 251 of file JobNode.cs.

◆ LogMessageAsync() [2/2]

virtual async Task Waher.Jobs.JobNode.LogMessageAsync	(	MessageType	Type,
		string	EventId,
		string	Body
	)

virtual

Logs a message on the node.

Parameters

Type	Type of message.
EventId	Optional Event ID.
Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 262 of file JobNode.cs.

◆ LogWarningAsync() [1/2]

virtual Task Waher.Jobs.JobNode.LogWarningAsync ( string Body )

virtual

Logs an warning message on the node.

Parameters

Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 212 of file JobNode.cs.

◆ LogWarningAsync() [2/2]

virtual Task Waher.Jobs.JobNode.LogWarningAsync	(	string	EventId,
		string	Body
	)

virtual

Logs an warning message on the node.

Parameters

EventId	Optional Event ID.
Body	Message body.

Implements Waher.Jobs.IJobNode.

Definition at line 222 of file JobNode.cs.

◆ MoveDownAsync() [1/2]

virtual async Task< bool > Waher.Jobs.JobNode.MoveDownAsync	(	JobNode	Child,
		RequestOrigin	Caller
	)

virtual

Tries to move the child node down.

Parameters

Child	Child node to move.
Caller	Information about caller.

Returns: If the child node was moved down.

Definition at line 1029 of file JobNode.cs.

◆ MoveDownAsync() [2/2]

virtual async Task< bool > Waher.Jobs.JobNode.MoveDownAsync ( RequestOrigin Caller )

virtual

Tries to move the node down.

Parameters

Caller Information about caller.

Returns: If the node was moved down.

Implements Waher.Things.INode.

Definition at line 964 of file JobNode.cs.

◆ MoveUpAsync() [1/2]

virtual async Task< bool > Waher.Jobs.JobNode.MoveUpAsync	(	JobNode	Child,
		RequestOrigin	Caller
	)

virtual

Tries to move the child node up.

Parameters

Child	Child node to move.
Caller	Information about caller.

Returns: If the child node was moved up.

Definition at line 978 of file JobNode.cs.

◆ MoveUpAsync() [2/2]

virtual async Task< bool > Waher.Jobs.JobNode.MoveUpAsync ( RequestOrigin Caller )

virtual

Tries to move the node up.

Parameters

Caller Information about caller.

Returns: If the node was moved up.

Implements Waher.Things.INode.

Definition at line 951 of file JobNode.cs.

◆ NodeUpdated()

virtual async Task Waher.Jobs.JobNode.NodeUpdated ( )

protectedvirtual

Persists changes to the node, and generates a node updated event.

Reimplemented in Waher.Jobs.NodeTypes.Job.

Definition at line 1174 of file JobNode.cs.

◆ operator ThingReference()

static implicit Waher.Jobs.JobNode.operator ThingReference ( JobNode Node )

static

Converts a JobNode to a ThingReference object.

Parameters

Node	Metering node.

Definition at line 56 of file JobNode.cs.

◆ RemoveAsync()

virtual async Task< bool > Waher.Jobs.JobNode.RemoveAsync ( INode Child )

virtual

Removes a child from the node.

Parameters

Child Child to remove.

Returns: If the Child node was found and removed.

Implements Waher.Things.INode.

Reimplemented in Waher.Jobs.NodeTypes.Root.

Definition at line 1223 of file JobNode.cs.

◆ RemovedFromRoot()

virtual Task Waher.Jobs.JobNode.RemovedFromRoot ( Root Root )

virtual

Node has been removed from the root node.

Parameters

Root	Root node.

Reimplemented in Waher.Jobs.NodeTypes.Job.

Definition at line 1364 of file JobNode.cs.

◆ RemoveErrorAsync() [1/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveErrorAsync ( )

virtual

Removes error messages with an empty event ID from the node.

Implements Waher.Jobs.IJobNode.

Definition at line 358 of file JobNode.cs.

◆ RemoveErrorAsync() [2/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveErrorAsync ( string EventId )

virtual

Removes error messages with a given event ID from the node.

Parameters

EventId Optional Event ID.

Implements Waher.Jobs.IJobNode.

Definition at line 367 of file JobNode.cs.

◆ RemoveInformationAsync() [1/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveInformationAsync ( )

virtual

Removes warning messages with an empty event ID from the node.

Implements Waher.Jobs.IJobNode.

Definition at line 392 of file JobNode.cs.

◆ RemoveInformationAsync() [2/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveInformationAsync ( string EventId )

virtual

Removes an informational message on the node.

Parameters

EventId Optional Event ID.

Implements Waher.Jobs.IJobNode.

Definition at line 401 of file JobNode.cs.

◆ RemoveMessageAsync() [1/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveMessageAsync ( MessageType Type )

virtual

Removes messages with empty event IDs from the node.

Parameters

Type	Type of message.

Implements Waher.Jobs.IJobNode.

Definition at line 410 of file JobNode.cs.

◆ RemoveMessageAsync() [2/2]

virtual async Task< bool > Waher.Jobs.JobNode.RemoveMessageAsync	(	MessageType	Type,
		string	EventId
	)

virtual

Logs a message on the node.

Parameters

Type	Type of message.
EventId	Optional Event ID.

Implements Waher.Jobs.IJobNode.

Definition at line 420 of file JobNode.cs.

◆ RemoveWarningAsync() [1/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveWarningAsync ( )

virtual

Removes warning messages with an empty event ID from the node.

Implements Waher.Jobs.IJobNode.

Definition at line 375 of file JobNode.cs.

◆ RemoveWarningAsync() [2/2]

virtual Task< bool > Waher.Jobs.JobNode.RemoveWarningAsync ( string EventId )

virtual

Removes warning messages with a given event ID from the node.

Parameters

EventId Optional Event ID.

Implements Waher.Jobs.IJobNode.

Definition at line 384 of file JobNode.cs.

◆ SortChildrenAfterLoadLocked()

virtual JobNode[] Waher.Jobs.JobNode.SortChildrenAfterLoadLocked ( List< JobNode > Children )

protectedvirtual

Method that allows the node to sort its children, after they have been loaded.

Parameters

Children Loaded children.

Returns: Child nodes that need to be updated, or null if no such nodes.

Definition at line 752 of file JobNode.cs.

◆ ToString()

override string Waher.Jobs.JobNode.ToString ( )

Definition at line 168 of file JobNode.cs.

◆ UpdateAsync()

virtual async Task Waher.Jobs.JobNode.UpdateAsync ( )

virtual

Updates the node (in persisted storage).

Implements Waher.Things.INode.

Definition at line 1210 of file JobNode.cs.

Property Documentation

◆ ChildNodes

Task<IEnumerable<INode> > Waher.Jobs.JobNode.ChildNodes

get

Child nodes. If no child nodes are available, null is returned.

Implements Waher.Things.INode.

Definition at line 694 of file JobNode.cs.

◆ ChildrenOrdered

virtual bool Waher.Jobs.JobNode.ChildrenOrdered

get

If the children of the node have an intrinsic order (true), or if the order is not important (false).

Implements Waher.Things.INode.

Definition at line 596 of file JobNode.cs.

◆ Commands

virtual Task<IEnumerable<ICommand> > Waher.Jobs.JobNode.Commands

get

Available command objects. If no commands are available, null is returned.

Implements Waher.Things.INode.

Definition at line 1337 of file JobNode.cs.

◆ Created

DateTime Waher.Jobs.JobNode.Created

getset

When node was created.

Definition at line 109 of file JobNode.cs.

◆ HasChildren

bool Waher.Jobs.JobNode.HasChildren

get

If the source has any child sources.

Implements Waher.Things.INode.

Definition at line 582 of file JobNode.cs.

◆ HasCommands

virtual bool Waher.Jobs.JobNode.HasCommands

get

If the node has registered commands or not.

Implements Waher.Things.INode.

Definition at line 614 of file JobNode.cs.

◆ IsControllable

virtual bool Waher.Jobs.JobNode.IsControllable

get

If the node can be controlled.

Implements Waher.Things.INode.

Definition at line 608 of file JobNode.cs.

◆ IsReadable

virtual bool Waher.Jobs.JobNode.IsReadable

get

If the node can be read.

Implements Waher.Things.INode.

Definition at line 602 of file JobNode.cs.

◆ LastChanged

DateTime Waher.Jobs.JobNode.LastChanged

get

When the node was last updated.

Implements Waher.Things.INode.

Definition at line 669 of file JobNode.cs.

◆ LocalId

virtual string Waher.Jobs.JobNode.LocalId

get

If provided, an ID for the node, but unique locally between siblings. Can be null, if Local ID equal to Node ID.

Implements Waher.Things.INode.

Definition at line 563 of file JobNode.cs.

◆ LogId

virtual string Waher.Jobs.JobNode.LogId

get

If provided, an ID for the node, as it would appear or be used in system logs. Can be null, if Log ID equal to Node ID.

Implements Waher.Things.INode.

Definition at line 569 of file JobNode.cs.

◆ NodeId

string Waher.Jobs.JobNode.NodeId

getset

ID of node.

Implements Waher.Jobs.IJobNode.

Definition at line 142 of file JobNode.cs.

◆ ObjectId

Guid Waher.Jobs.JobNode.ObjectId

getset

Object ID in persistence layer.

Definition at line 91 of file JobNode.cs.

◆ Parent

INode Waher.Jobs.JobNode.Parent

get

Parent Node, or null if a root node.

Implements Waher.Things.INode.

Definition at line 621 of file JobNode.cs.

◆ ParentId

Guid Waher.Jobs.JobNode.ParentId

getset

Object ID of parent node in persistence layer.

Definition at line 100 of file JobNode.cs.

◆ Partition

string Waher.Jobs.JobNode.Partition

get

Optional partition in which the Node ID is unique.

Implements Waher.Things.IThingReference.

Definition at line 165 of file JobNode.cs.

◆ SiblingOrdinal

int Waher.Jobs.JobNode.SiblingOrdinal

getset

Sibling ordinal, used to order siblings when ordered.

Definition at line 129 of file JobNode.cs.

◆ SourceId

string Waher.Jobs.JobNode.SourceId

get

Optional ID of source containing node.

Implements Waher.Things.IThingReference.

Definition at line 159 of file JobNode.cs.

◆ State

NodeState Waher.Jobs.JobNode.State

getset

Current overall state of the node.

Implements Waher.Things.INode.

Definition at line 684 of file JobNode.cs.

◆ Updated

DateTime Waher.Jobs.JobNode.Updated

getset

When node was last updated. If it has not been updated, value will be DateTime.MinValue.

Definition at line 119 of file JobNode.cs.

Event Documentation

◆ OnUpdate

EventHandlerAsync Waher.Jobs.JobNode.OnUpdate = null

Event raised when node has been updated.

Definition at line 525 of file JobNode.cs.

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

C:/My Projects/IoTGateway/Jobs/Waher.Jobs/JobNode.cs

Public Member Functions

Static Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ JobNode()

Member Function Documentation

◆ AcceptsChildAsync()

◆ AcceptsParentAsync()

◆ AddAsync()

◆ AddedToRoot()

◆ CanAddAsync()

◆ CanDestroyAsync()

◆ CanEditAsync()

◆ CanViewAsync()

◆ CheckOrderLocked()

◆ DestroyAsync()

◆ Equals()

◆ GetAncestor< T >()

◆ GetDisplayableParameterAraryAsync()

◆ GetDisplayableParametersAsync()

◆ GetHashCode()

◆ GetMessageArrayAsync()

◆ GetMessagesAsync()

◆ GetParent()

◆ GetTypeNameAsync()

◆ GetUniqueJobId()

◆ LogErrorAsync() [1/2]

◆ LogErrorAsync() [2/2]

◆ LogInformationAsync() [1/2]

◆ LogInformationAsync() [2/2]

◆ LogMessageAsync() [1/2]

◆ LogMessageAsync() [2/2]

◆ LogWarningAsync() [1/2]

◆ LogWarningAsync() [2/2]

◆ MoveDownAsync() [1/2]

◆ MoveDownAsync() [2/2]

◆ MoveUpAsync() [1/2]

◆ MoveUpAsync() [2/2]

◆ NodeUpdated()

◆ operator ThingReference()

◆ RemoveAsync()

◆ RemovedFromRoot()

◆ RemoveErrorAsync() [1/2]

◆ RemoveErrorAsync() [2/2]

◆ RemoveInformationAsync() [1/2]

◆ RemoveInformationAsync() [2/2]

◆ RemoveMessageAsync() [1/2]

◆ RemoveMessageAsync() [2/2]

◆ RemoveWarningAsync() [1/2]

◆ RemoveWarningAsync() [2/2]

◆ SortChildrenAfterLoadLocked()

◆ ToString()

◆ UpdateAsync()

Property Documentation

◆ ChildNodes

◆ ChildrenOrdered

◆ Commands

◆ Created

◆ HasChildren

◆ HasCommands

◆ IsControllable

◆ IsReadable

◆ LastChanged

◆ LocalId

◆ LogId

◆ NodeId

◆ ObjectId

◆ Parent

◆ ParentId

◆ Partition

◆ SiblingOrdinal

◆ SourceId

◆ State

◆ Updated

Event Documentation

◆ OnUpdate