Open 3D Engine ExpressionEvaluation Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
ExpressionEvaluation::ExpressionEvaluationRequests Class Referenceabstract

Inherits AZ::EBusTraits.

Public Member Functions

virtual ParseOutcome ParseExpression (AZStd::string_view expressionString) const =0
 
virtual ParseInPlaceOutcome ParseExpressionInPlace (AZStd::string_view expressionString, ExpressionTree &expressionTree) const =0
 
virtual ParseOutcome ParseRestrictedExpression (const AZStd::unordered_set< ExpressionParserId > &availableParsers, AZStd::string_view expressionString) const =0
 
virtual ParseInPlaceOutcome ParseRestrictedExpressionInPlace (const AZStd::unordered_set< ExpressionParserId > &availableParsers, AZStd::string_view expressionString, ExpressionTree &expressionTree) const =0
 
virtual EvaluateStringOutcome EvaluateExpression (AZStd::string_view expression) const =0
 
virtual ExpressionResult Evaluate (const ExpressionTree &expressionTree) const =0
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 
static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::Single
 

Member Function Documentation

◆ Evaluate()

virtual ExpressionResult ExpressionEvaluation::ExpressionEvaluationRequests::Evaluate ( const ExpressionTree expressionTree) const
pure virtual

Evalutes the specified ExpressionTree /param expressionTree The ExpressionTree to be evaluated /return Returns the result of the expression evaluation.

◆ EvaluateExpression()

virtual EvaluateStringOutcome ExpressionEvaluation::ExpressionEvaluationRequests::EvaluateExpression ( AZStd::string_view  expression) const
pure virtual

Parses then Evaluates the specified Expression, and returns the result or parse error. /param expressionString The string to parse/evaluate /return Returns the result of the expression evaluation, or a Parsing Error.

◆ ParseExpression()

virtual ParseOutcome ExpressionEvaluation::ExpressionEvaluationRequests::ParseExpression ( AZStd::string_view  expressionString) const
pure virtual

Parses the expression into the returned ExpressionTree. /param expressionString The string to parse. /return Returns an Expression Tree, or a Parsing Error.

◆ ParseExpressionInPlace()

virtual ParseInPlaceOutcome ExpressionEvaluation::ExpressionEvaluationRequests::ParseExpressionInPlace ( AZStd::string_view  expressionString,
ExpressionTree expressionTree 
) const
pure virtual

Parses the expression into the supplied ExpressionTree. /param expressionString The string to parse. /param expressionTree The ExpressionTree that will contain the parsed tree on Success. /return Returns Success or a Parsing Error.

◆ ParseRestrictedExpression()

virtual ParseOutcome ExpressionEvaluation::ExpressionEvaluationRequests::ParseRestrictedExpression ( const AZStd::unordered_set< ExpressionParserId > &  availableParsers,
AZStd::string_view  expressionString 
) const
pure virtual

Parses the expression into the returned ExpressionTree using the specified list of parsers. /param availableParsers The list of parsers to use when parsing the expression. /param expressionString The string to parse. /return Returns an Expression Tree, or a Parsing Error.

◆ ParseRestrictedExpressionInPlace()

virtual ParseInPlaceOutcome ExpressionEvaluation::ExpressionEvaluationRequests::ParseRestrictedExpressionInPlace ( const AZStd::unordered_set< ExpressionParserId > &  availableParsers,
AZStd::string_view  expressionString,
ExpressionTree expressionTree 
) const
pure virtual

Parses the expression into the supplied ExpressionTree using the specified list of parsers. /param availableParsers The list of parsers to use when parsing the expression. /param expressionString The string to parse. /param expressionTree The ExpressionTree that will contain the parsed tree on Success. /return Returns Success, or a Parsing Error.


The documentation for this class was generated from the following file: