DiagramElement

DiagramElement()

Initializes a new instance of the DiagramElement.

CanAutoName : bool

Use auto naming.

Category : string

The name of the group which includes a diagram element.

Connector : IConnector

Connector.

DebuggerSyncObject : DebuggerSyncObject

The synchronization object for the debugger.

Description : string

The diagram element description.

Dispatcher : IDispatcher

IDispatcher.

DocUrl : string

Help url.

FlushPriority : int

Is need flush state (FlushDisabled means No).

HasUndoManager : bool

Check if undo manager is defined

IconName : string

Icon resource name.

InputSockets : IReadOnlyCollection<DiagramSocket>

Incoming connections.

IsExternalCode : bool

Is the element contains external code.

IsUndoRedoing : bool

Whether undo/redo operation is in progress.

LogLevel : LogLevels

The level to perform this rule logging.

Name : string

Name.

OutputSockets : IReadOnlyCollection<DiagramSocket>

Outgoing connections.

Parameters : IEnumerable<IDiagramElementParam>

Diagram element settings.

ParentComposition : CompositionDiagramElement

Parent composition this element belongs to.

ProcessingLevel : int

Element processing level. How many times DiagramSocketValue) is reentered.

ProcessNullValues : bool

Process null values.

ShowParameters : bool

Show element parameters in higher order elements.

ShowSockets : bool

Show element sockets in higher order elements.

Strategy : DiagramStrategy

The strategy to which the element is attached.

TypeId : Guid

The unique identifier of the diagram element type.

WaitAllInput : bool

Wait all parameters before invoke method.

AddInput(StaticSocketIds, string, DiagramSocketType, Action<DiagramSocketValue>, int, int, bool?) : DiagramSocket

To add or get existing incoming connection. isDynamic is false by default.

id

The connection identifier.

name

The connection name.

type

Connection type.

linkableMax

The maximum number of connections.

process

The action is called at the processing of the new incoming value for socket.

index

Index in sockets list.

isDynamic

Socket will be saved with the element. Default is true for sockets with explicit id.

Возвращает: Connection.

AddInput(string, string, DiagramSocketType, Action<DiagramSocketValue>, int, int, bool?) : DiagramSocket

To add or get existing incoming connection. isDynamic is true by default.

id

The connection identifier.

name

The connection name.

type

Connection type.

linkableMax

The maximum number of connections.

process

The action is called at the processing of the new incoming value for socket.

index

Index in sockets list.

isDynamic

Socket will be saved with the element. Default is true for sockets with explicit id.

Возвращает: Connection.

AddOutput(StaticSocketIds, string, DiagramSocketType, int, int, bool) : DiagramSocket

To add or get an outgoing connection.

id

The connection identifier.

name

The connection name.

type

Connection type.

linkableMax

The maximum number of connections.

index

Index in sockets list.

isDynamic

Dynamic sockets are removed during Load().

Возвращает: Connection.

AddOutput(string, string, DiagramSocketType, int, int, bool) : DiagramSocket

To add or get an outgoing connection.

id

The connection identifier.

name

The connection name.

type

Connection type.

linkableMax

The maximum number of connections.

index

Index in sockets list.

isDynamic

Dynamic sockets are removed during Load().

Возвращает: Connection.

AddParam(IDiagramElementParam)

To add a parameter.

param

Parameter.

AddParam``1(string, T)

To add a parameter.

name

Name.

value

Value.

Возвращает: Parameter.

ClearSocketValues()

Clear socket values.

Clone(bool) : DiagramElement

Create a copy of DiagramElement.

cloneSockets

To create copies of connections.

Возвращает: Copy.

CreateCopy() : DiagramElement

Create a copy of DiagramElement.

Возвращает: DiagramElement copy.

CreateSocketInstance(DiagramSocketDirection, string) : DiagramSocket

Create new socket instance.

DisposeManaged()

Release resources.

Flush(DateTime)

Flush non trigger (root) elements.

GenerateSocketId(string) : string

Generate socket identifier.

suffix

Suffix.

Возвращает: Identifier.

GetCategory() : string

Get category.

Возвращает: Category.

GetConnectedSourceSockets(DiagramSocket) : DiagramSocket[]

Get connected source sockets.

targetInputSocket

GetDescription() : string

Get description.

Возвращает: Description.

GetDisplayName() : string

Get display name.

Возвращает: Name.

GetNumConnections(DiagramSocket) : int

Get connection count.

socket

Socket.

Возвращает: Count.

GetOrAddSocket(string, DiagramSocketDirection, string, DiagramSocketType, Action<DiagramSocketValue>, int, int, bool, bool) : ValueTuple<DiagramSocket, bool>

To add or get an outgoing connection.

socketId

The connection identifier.

dir

DiagramSocketDirection

name

The connection name.

type

Connection type.

process

The action is called at the processing of the new incoming value for socket.

linkableMax

The maximum number of connections.

index

Index in sockets list.

isDynamic

Dynamic sockets are removed during SettingsStorage).

allowGet

Return existing socket if it's already exist.

Возвращает: Connection.

Init(ILogSource)

To initialize the element.

parent

Parent composition or strategy.

InitializeCopy(DiagramElement)

Load(SettingsStorage)

Load settings.

storage

Settings storage.

OnInit()

The method is called at initialization of the diagram element.

OnPrepare()

To prepare for starting the diagram element algorithm.

OnProcess(DateTime, IDictionary<DiagramSocket, DiagramSocketValue>, DiagramSocketValue)

The method is called at the processing of the new incoming values.

time

Time.

values

Values.

source

Source value.

OnReseted()

The method is called at re-initialisation of the diagram element state.

OnSocketConnected(DiagramSocket, DiagramSocket)

The method is called at subscription to the processing of diagram element output values.

socket

The diagram element socket.

source

The source diagram element socket.

OnSocketDisconnected(DiagramSocket, DiagramSocket)

The method is called at unsubscription from the processing of diagram element output values.

socket

The diagram element socket.

source

The source diagram element socket.

OnStart(DateTime)

The method is called at the start of the diagram element algorithm.

OnStop()

The method is called at the stop of the diagram element algorithm.

OnUnInit()

The method is called at deinitialization of the diagram element.

Prepare()

To prepare for starting the diagram element algorithm.

Process(DiagramSocketValue)

To handle the incoming value.

value

Value.

RaiseParameterValueChanged(string)

To call the ParameterValueChanged event.

parameterName

Parameter name.

RaiseProcessOutput(DiagramSocket, DateTime, object, DiagramSocketValue, Subscription)

To call the event ProcessOutput.

socket

Output socket.

time

Time.

value

Value.

source

Source value.

subscription

Subscription.

RaisePropertiesChanged()

To call the PropertiesChanged event.

RaisePropertyChanged(string)

To call the PropertyChanged event.

propertyName

Property name.

RaisePropertyChanged(object, PropertyChangedEventArgs)

To call the PropertyChanged event.

sender

Sender.

args

Arguments.

RaisePropertyChanging(string)

To call the PropertyChanging event.

propertyName

Property name.

RaisePropertyChanging(object, PropertyChangingEventArgs)

To call the PropertyChanging event.

sender

Sender.

args

Arguments.

RaiseSocketChanged(DiagramSocket)

To call the event SocketChanged.

socket

Socket.

RemoveParam(IDiagramElementParam)

To remove a parameter.

param

Parameter.

RemoveSocket(DiagramSocket)

To remove a connection.

socket

Connection.

RemoveSockets(Func<DiagramSocket, bool>, bool)

To remove multiple sockets.

predicate

raiseSocketRemoved

Raise SocketRemoved event.

RemoveSockets(bool)

To remove all incoming and outgoing connections.

raiseSocketRemoved

Raise SocketRemoved event.

Reset()

To reinitialize the diagram element state.

ResetFlushPriority()

Reset FlushPriority.

Save(SettingsStorage)

Save settings.

storage

Settings storage.

SaveUndoState(object) : IDisposable

Save state to enable undo.

SetElementName(string)

Set element name.

name

Name.

Start(DateTime)

To start for start the diagram element algorithm.

Stop()

To stop the diagram element algorithm.

UnInit()

The deinitialization of the element.

CommittedUndoableOperation : Action<DiagramElement, IUndoableEdit>

Committed undoable operation.

ParameterValueChanged : Action<string>

The diagram element parameter value change event.

ProcessOutput : Action<DiagramSocketValue>

New data occurring event.

PropertiesChanged : Action

The available properties change event.

PropertyChanged : PropertyChangedEventHandler

The diagram element properties value change event.

PropertyChanging : PropertyChangingEventHandler

The diagram element properties value changing event.

SocketAdded : Action<DiagramSocket>

The diagram element connection added event.

SocketChanged : Action<DiagramSocket>

The diagram element connection changed event.

SocketRemoved : Action<DiagramSocket>

The diagram element connection removed event.

StartedUndoableOperation : Action

Started undoable operation.

FlushDisabled : int

Disabled value for FlushPriority.

FlushNormal : int

Normal value for FlushPriority.