Class AFixedContextVariable

Fixed context variables serves as a base class for variables that are tied to a specific context. This is mostly useful for defining variables that are always associated with a particular context due to the function that use them Example : TokenInit will always create SequenceContext variables.

Inheritance

object

AFixedContextVariable

ConfigurationVariablePath

EventVariablePath

ExternalContextVariablePath

ScenarioVariablePath

TokenVariablePath

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: Xareus.Scenarios.Variables

Assembly: Xareus.Scenarios.dll

Syntax

public abstract class AFixedContextVariable

Constructors

AFixedContextVariable()

Declaration

protected AFixedContextVariable()

AFixedContextVariable(string)

Declaration

protected AFixedContextVariable(string path)

Parameters

Type	Name	Description
string	path

Properties

Context

The context the Variable path refers to

Declaration

public abstract ContextType Context { get; }

Property Value

Type	Description
ContextType

Path

Path of the variable

Declaration

public VariablePath Path { get; set; }

Property Value

Type	Description
VariablePath

Methods

Equals(object)

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

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj	The object to compare with the current object.

Returns

Type	Description
bool	true if the specified object is equal to the current object; otherwise, false.

Overrides

object.Equals(object)

GetFullPath(bool)

Get the full path to the variable, including $() if needed

Declaration

public virtual string GetFullPath(bool asInputVariable = true)

Parameters

Type	Name	Description
bool	asInputVariable

Returns

Type	Description
string

GetHashCode()

Serves as the default hash function.

Declaration

public override int GetHashCode()

Returns

Type	Description
int	A hash code for the current object.

Overrides

object.GetHashCode()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Operators

implicit operator string(AFixedContextVariable)

Implicit conversion to string

Declaration

public static implicit operator string(AFixedContextVariable value)

Parameters

Type	Name	Description
AFixedContextVariable	value

Returns

Type	Description
string