Class AFunction
This is a C# user-defined function with parameters. Several parameters can have the same name.
Inheritance
AFunction
Inherited Members
Namespace: Xareus.Scenarios
Assembly: Xareus.Scenarios.dll
Syntax
public abstract class AFunction
Constructors
AFunction()
Empty constructor
Declaration
protected AFunction()
AFunction(Dictionary<string, List<string>>)
Declaration
protected AFunction(Dictionary<string, List<string>> nameValueListMap)
Parameters
Type | Name | Description |
---|---|---|
Dictionary<string, List<string>> | nameValueListMap |
AFunction(Dictionary<string, Parameter>, ContextHolder)
Declaration
protected AFunction(Dictionary<string, Parameter> parameters, ContextHolder contexts = null)
Parameters
Type | Name | Description |
---|---|---|
Dictionary<string, Parameter> | parameters | |
ContextHolder | contexts |
Properties
Contexts
The contexts of the function
Declaration
protected ContextHolder Contexts { get; }
Property Value
Type | Description |
---|---|
ContextHolder |
Parameters
The values indexed by key
Declaration
protected Dictionary<string, Parameter> Parameters { get; }
Property Value
Type | Description |
---|---|
Dictionary<string, Parameter> |
Methods
FillParameters()
Fill the parameters of the function using SetFunctionParameters(AFunction, IDictionary<string, Parameter>, IContext, IContext, IContext, IContext)
Declaration
public virtual void FillParameters()
Reset()
Initilizes the function. This method can be called when a function is created and when it is reset to be used again
Declaration
public virtual void Reset()
UpdateContexts(ContextHolder)
Sets/Updates the contexts of the function. If a context is not provided (null), the previous one is kept.
Declaration
public virtual void UpdateContexts(ContextHolder contexts)
Parameters
Type | Name | Description |
---|---|---|
ContextHolder | contexts |