IExpressionValet InterfaceµStrata MathDaemon™ WCF
An interface to gain an access to ExpressionEngine capabilities via WCF and REST

Namespace: uStrata.MathDaemon.Wcf.Contracts
Assembly: uStrata.MathDaemon.Wcf.Contracts.Expression (in uStrata.MathDaemon.Wcf.Contracts.Expression.dll) Version: 1.1.5779.28282
Syntax

public interface IExpressionValet : IConnectValet

The IExpressionValet type exposes the following members.

Methods

  NameDescription
Public methodAdd
Add new ExpressionEngine object to the pool
Public methodCalculationResultDbAdd
Save result of calculation to the database
Public methodCalculationResultDbRemove
Removes specified result from the database.

The customer must own the result

Public methodCheckSyntaxAll
Check syntax for all expressions (including ternary)
Public methodCheckSyntaxExpression
Check syntax for specified expression
Public methodClean
Completely removes all instance content
Public methodCleanExpressions
Removes all compiled objects.
Public methodCompile
Compiles all expressions (including ternary) within the instance
Public methodConditionAdd
Add new condition to the engine
Public methodConditionEdit
Edit condition properties by its name
Public methodConditionEditName
Rename specified condition. All dependent formulas will be updated.
Public methodConditionExists
Check if specified condition exists in the list
Public methodConditionRemove
Removes specified condition from the collection. There are no dependencies search for the operation.
Public methodConditionUpdate
Updates conditions collection with passed list
Public methodContentAdd
Add new ExpressionEngine object to the pool with all objects
Public methodContentUpdate
Update expression content with passed data. If the token not exists in the list, it added, otherwise updated.
Public methodEdit
Edit AngleMode and Estimate value
Public methodEditAngle
Edit AngleMode value
Public methodEditEstimate
Edit Estimate value
Public methodExecute
Evaluates an expression by its name
Public methodExecuteAll
Evaluates all expressions (including ternary) within the instance
Public methodExecuteAllWithValues
Evaluates all expressions (including ternary) using passed values within the instance
Public methodExecuteConditions
Evaluates conditions only within the instance
Public methodExecuteConditionsWithValues
Evaluates conditions only using passed values within the instance
Public methodExecuteExpressions
Evaluates expressions only within the instance
Public methodExecuteExpressionsWithValues
Evaluates expressions only using passed values within the instance
Public methodExecuteWithValues
Evaluates an expression by its name using passed parameter values
Public methodExpressionAdd
Add new expression to the engine
Public methodExpressionEditFormula
Change expression formula by its name
Public methodExpressionEditName
Rename specified expression. All dependent formulas will be updated.
Public methodExpressionExists
Check if specified expression exists in the list
Public methodExpressionRemove
Removes specified expression from the collection. There are no dependencies search for the operation.
Public methodExpressionUpdate
Updates expressions collection with passed list
Public methodFindCircularReferences
Search for circular references across all expressions (including ternary) within the instance
Public methodGetCondition
Get condition structure by its name
Public methodGetConditionCount
Retrieve a number of conditions stored within the instance
Public methodGetConditionList
Retrieve a collection of conditions
Public methodGetConstantCount
Retrieve a number of physical constants
Public methodGetConstantList
Retrieve a collection of built-in physical constants
Public methodGetContent
Retrieve a content of specific engine
Public methodGetContentList
Retrieve a collection of all engines belongs to the session
Public methodGetErrorDescription
Retrieve a last error occurred within the instance
Public methodGetExpression
Get a formula of expression by its name
Public methodGetExpressionCount
Retrieve a number of expressions stored within the instance
Public methodGetExpressionList
Retrieve a collection of expressions
Public methodGetFunctionCount
Retrieve a number of built-in mathematical routines
Public methodGetFunctionList
Retrieve a collection of built-in mathematical routines
Public methodGetInstanceCount
Retrieve a number of engine instances belongs to the session
Public methodGetInstanceStructureListBelongsToCustomer
Retrieve all instances stored in the database that belongs to the customer

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodGetInstanceStructureListWithAllDerivedInstancesBelongsToCustomer
Retrieve all instances stored in the database that belongs to the customer with all derived instances regardless their ownership

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodGetParameterCount
Retrieve a number of parameters stored within the instance
Public methodGetParameterList
Retrieve a collection of parameters
Public methodGetParameterValue
Get a value of parameter by its name
Public methodGetResultById
Retrieve a result by identifier.

The result belongs to customer or the customer has an ownership on the instance

Public methodGetResultByName
Retrieve a result by identifier.

The result belongs to customer or the customer has an ownership on the instance

Public methodGetResultListForInstance
Retrieve full list of results performed for the instance regardless their ownership. The customer must own the instance.
Public methodGetResultListForInstanceBelongsToCustomer
Retrieve full list of results performed for the instance and belongs to the customer.
Public methodGetResultListForInstanceBelongsToCustomerPeriod
Retrieve full list of results performed for the instance and belongs to the customer. Each result is located within specified period. Boundaries are included in both sides.
Public methodGetResultListForInstancePeriod
Retrieve full list of results performed for the instance regardless their ownership. Each result is located within specified period. Boundaries are included in both sides. The customer must own the instance.
Public methodGetRootInstanceStructureListBelongsToCustomer
Retrieve all instances stored in the database that belongs to the customer and are on Root level

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodGetSpecificInstanceStructureBelongsToCustomer
Get specific instance stored in the database that belongs to the customer

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodGetSpecificInstanceStructureBelongsToCustomerOrDerivedFrom
Get specific instance stored in the database that belongs to the customer or derived from any instance belongs to him

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodGetSpecificInstanceStructureWithAllDerivedInstancesBelongsToCustomer
Get specific instance stored in the database that belongs to the customer with all descendants regardless their ownership

The data will be retrieved directly from the database. It means that if any instance uploaded to the cache and edit, the changes are not reflected until the instance will be stored in the database.

Public methodInstanceDbAdd
Save the instance to database

The method does not affects the cache

Public methodInstanceDbAddClone
Save the instance to database as clone of already saved instance.

The method does not affects the cache

Public methodInstanceDbEdit
Save instance changes to the database

If the instance already has calculations, it cannot be edited. Use AddClone instead.

Database updated with passed instance properties.

The method does not affects the cache

Public methodInstanceDbGrantAccess
Add permissions to passed customer to access the instance.

Granted customer can edit of the instance and perform calculations, but does not granted to remove the instance

Public methodInstanceDbRemove
Removes specified instance from database

If the instance has clones, all clones will be moved up one level

The instance cannot be removed if any other customer performs a calculations on the instance.

The method does not affects the cache

Public methodParameterAdd
Add new parameter to the instance
Public methodParameterEditName
Rename specified parameter. All dependent formulas will be updated.
Public methodParameterEditValue
Assign new value to specified parameter
Public methodParameterExists
Check if specified parameter exists in the list
Public methodParameterRemove
Remove specified parameter from the collection. There are no dependencies search for the operation.
Public methodParameterSetValues
Set values for several parameters
Public methodParameterUpdate
Updates parameters collection with passed list
Public methodRemove
Removes specified instance from the pool
Top
See Also