TemplatedExpressionParser Class

Represents a template based token substitution parser that supports binary and advanced expressions.

Inheritance Hierarchy

SystemObject
GSF.ParsingTemplatedExpressionParser

Namespace: GSF.Parsing
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.218-beta+101eee949414e414795e55a6e73d88938f0177b8

Syntax

C++

JavaScript

Copy

public class TemplatedExpressionParser

Public Class TemplatedExpressionParser

public ref class TemplatedExpressionParser

type TemplatedExpressionParser = class end

GSF.Parsing.TemplatedExpressionParser = function();

Type.createClass(
	'GSF.Parsing.TemplatedExpressionParser');

View Source

The TemplatedExpressionParser type exposes the following members.

Constructors

	Name	Description
	TemplatedExpressionParser	Creates a new TemplatedExpressionParser.
	TemplatedExpressionParser(Char, Char, Char, Char)	Creates a new TemplatedExpressionParser with desired delimiters.

Top

Properties

	Name	Description
	EndExpressionDelimiter	Gets the character that identifies the end of an expression.
	EndTokenDelimiter	Gets the character that identifies the end of a token.
	ReservedSymbols	Gets the reserved symbols - this includes all delimiters and expression operators.
	StartExpressionDelimiter	Gets the character that identifies the start of an expression.
	StartTokenDelimiter	Gets the character that identifies the beginning of a token.
	TemplatedExpression	Gets or sets the templated expression to use.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Execute	Executes replacements using provided substitutions dictionary on the currently defined TemplatedExpression value and optionally evaluates any expressions.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

As an example, this parser can use a templated expression of the form:

Copy

{CompanyAcronym}_{DeviceAcronym}[?{SignalType.Source}=Phasor[-{SignalType.Suffix}{SignalIndex}]]:{Signal.Acronymn}

then replace the tokens with actual values and properly evaluate the expressions. Example results could look like: GPA_SHELBY-PA1:IPHA and GPA_SHELBY:FREQ

Parser also supports more complex C# style expressions using the "eval{}" function, e.g.:

Copy

eval{'{CompanyAcronym}'.Substring(0,3)}_{DeviceAcronym}eval{'[?{SignalType.Source}=Phasor[-{SignalType.Suffix}]]'.Length}

Reference

GSF.Parsing Namespace