Class NotifyExpression<T>
The common base class for incremental expressions
Implements
Inherited Members
Namespace: NMF.Expressions
Assembly: NMF.Expressions.dll
Syntax
public abstract class NotifyExpression<T> : NotifyExpressionBase, INotifyExpression<T>, INotifyValue<T>, INotifyExpression, INotifiable, IDisposable, IValueChangedNotificationResult<T>, IValueChangedNotificationResult, INotificationResult, ISuccessorListType Parameters
| Name | Description |
|---|---|
| T | The element type of the expression |
Constructors
| Edit this page View SourceNotifyExpression()
Creates a new instance
Declaration
protected NotifyExpression()NotifyExpression(T)
Creates a new incremental expression with the given initial value
Declaration
protected NotifyExpression(T value)Parameters
| Type | Name | Description |
|---|---|---|
| T | value | The initial value |
Properties
| Edit this page View SourceAllSuccessors
Declaration
public IEnumerable<INotifiable> AllSuccessors { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<INotifiable> |
CanBeConstant
Returns whether the current expression can be constant
Declaration
public virtual bool CanBeConstant { get; }Property Value
| Type | Description |
|---|---|
| bool |
CanReduce
Determines whether this expression can be reduced
Declaration
public override bool CanReduce { get; }Property Value
| Type | Description |
|---|---|
| bool |
Overrides
| Edit this page View SourceCount
The number of elements
Declaration
public int Count { get; }Property Value
| Type | Description |
|---|---|
| int |
Dependencies
Nodes that notify this node.
Declaration
public abstract IEnumerable<INotifiable> Dependencies { get; }Property Value
| Type | Description |
|---|---|
| IEnumerable<INotifiable> |
ExecutionMetaData
Used by the execution engine during incremental execution.
Declaration
public ExecutionMetaData ExecutionMetaData { get; }Property Value
| Type | Description |
|---|---|
| ExecutionMetaData |
HasSuccessors
True, if there is any successor, otherwise False
Declaration
public bool HasSuccessors { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsAttached
True, if successors are attached, otherwise False
Declaration
public bool IsAttached { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsConstant
Returns whether this expression is a constant value
Declaration
public virtual bool IsConstant { get; }Property Value
| Type | Description |
|---|---|
| bool |
IsParameterFree
Returns whether this expression is parameter free
Declaration
public abstract bool IsParameterFree { get; }Property Value
| Type | Description |
|---|---|
| bool |
Successors
The nodes that will get notified by this node.
Declaration
public ISuccessorList Successors { get; }Property Value
| Type | Description |
|---|---|
| ISuccessorList |
Type
Gets the type of this incremental expression
Declaration
public override sealed Type Type { get; }Property Value
| Type | Description |
|---|---|
| Type |
Overrides
| Edit this page View SourceValue
Gets the current value of this expression
Declaration
public T Value { get; }Property Value
| Type | Description |
|---|---|
| T |
ValueObject
Gets the current value as object
Declaration
public object ValueObject { get; }Property Value
| Type | Description |
|---|---|
| object |
Methods
| Edit this page View SourceApplyParameters(IDictionary<string, object>, IDictionary<INotifiable, INotifiable>)
Applies the given set of parameters to the expression
Declaration
public INotifyExpression<T> ApplyParameters(IDictionary<string, object> parameters, IDictionary<INotifiable, INotifiable> trace)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<string, object> | parameters | A set of parameter values |
| IDictionary<INotifiable, INotifiable> | trace | A trace to make sure parameters are only applied once for every DDG node |
Returns
| Type | Description |
|---|---|
| INotifyExpression<T> | A new expression with all parameter placeholders replaced with the parameter values |
Remarks
In case that the current expression is parameter free, it simply returns itself
ApplyParametersCore(IDictionary<string, object>, IDictionary<INotifiable, INotifiable>)
Applies the given set of parameters to the expression
Declaration
protected abstract INotifyExpression<T> ApplyParametersCore(IDictionary<string, object> parameters, IDictionary<INotifiable, INotifiable> trace)Parameters
| Type | Name | Description |
|---|---|---|
| IDictionary<string, object> | parameters | A set of parameter values |
| IDictionary<INotifiable, INotifiable> | trace | A trace to make sure parameters are only applied once for every DDG node |
Returns
| Type | Description |
|---|---|
| INotifyExpression<T> | A new expression with all parameter placeholders replaced with the parameter values |
Remarks
In case that the current expression is parameter free, it simply returns itself
BaseReduce()
Simplifies the current expression
Declaration
protected override sealed Expression BaseReduce()Returns
| Type | Description |
|---|---|
| Expression | A simpler expression representing the same incremental value (e.g. a constant if this expression can be constant), otherwise itself |
Overrides
| Edit this page View SourceDispose()
Declaration
public void Dispose()GetSuccessor(int)
Gets the successor at the given index
Declaration
public INotifiable GetSuccessor(int index)Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index |
Returns
| Type | Description |
|---|---|
| INotifiable | The DDG node with the given index |
GetValue()
Gets the value of the current incremental expression
Declaration
protected abstract T GetValue()Returns
| Type | Description |
|---|---|
| T | The current value |
Notify(IList<INotificationResult>)
Refreshes the current value
Declaration
public virtual INotificationResult Notify(IList<INotificationResult> sources)Parameters
| Type | Name | Description |
|---|---|---|
| IList<INotificationResult> | sources |
Returns
| Type | Description |
|---|---|
| INotificationResult |
OnAttach()
Occurs when this node gets (re)attached to another node for the first time
Declaration
protected virtual void OnAttach()OnDetach()
Occurs when the last successor of this node gets removed
Declaration
protected virtual void OnDetach()OnValueChanged(T, T)
Gets called when the value of the current expression changes
Declaration
protected void OnValueChanged(T oldVal, T newVal)Parameters
| Type | Name | Description |
|---|---|---|
| T | oldVal | The old value |
| T | newVal | The new value |
Reduce()
Simplifies the current expression
Declaration
public virtual INotifyExpression<T> Reduce()Returns
| Type | Description |
|---|---|
| INotifyExpression<T> | A simpler expression representing the same incremental value (e.g. a constant if this expression can be constant), otherwise itself |
Set(INotifiable)
Add the given DDG node to the list
Declaration
public void Set(INotifiable node)Parameters
| Type | Name | Description |
|---|---|---|
| INotifiable | node | The DDG node to add |
SetDummy()
Sets a dummy
Declaration
public void SetDummy()ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string |
Overrides
| Edit this page View SourceUnset(INotifiable, bool)
Unset the given DDG node as successor
Declaration
public void Unset(INotifiable node, bool leaveDummy = false)Parameters
| Type | Name | Description |
|---|---|---|
| INotifiable | node | the DDG node |
| bool | leaveDummy | True, to leave the dummy in operation, otherwise False |
UnsetAll()
Clear the list
Declaration
public void UnsetAll()Events
| Edit this page View SourceValueChanged
Gets fired when the value changed
Declaration
public event EventHandler<ValueChangedEventArgs> ValueChangedEvent Type
| Type | Description |
|---|---|
| EventHandler<ValueChangedEventArgs> |