API for Expectations¶

Part of the Object based program API.

class ExpectationApi¶

Returned by

PackageApi.ExpectationApi

CreateAgentImageExpectation()¶

Creates a prompt-based agent image expectation.

Returns:: The prompt-based agent image expectation
Return type:: AgentImageExpectation

CreateAudioExpectation()¶

Creates an audio expectation.

Returns:: The audio expectation
Return type:: AudioExpectation

CreateBinaryExpressionExpectation(expression)¶

Creates a binary expectation to be used in TsEdiabas.

Parameters:

expression : str¶: String expression

Returns:

The binary expression expectation

Return type:

BinaryExpressionExpectation

CreateBitStreamExpectation()¶

Creates a bit stream expectation.

Returns:: Bit stream expectation
Return type:: BitStreamExpectation

CreateBitStreamExpressionExpectation(expression)¶

Creates a bit stream expression expectation.

Parameters:

expression : str¶: The expression text

Returns:

The bit stream expectation

Return type:

BitStreamExpressionExpectation

CreateBooleanExpectation(truthValue)¶

Creates a boolean expectation.

Parameters:

truthValue : bool¶: The truth value of the expectation

Returns:

The boolean expression expectation

Return type:

BooleanExpectation

CreateByteStreamExpectation()¶

Creates a byte stream expectation.

Returns:: Byte stream expectation
Return type:: ByteStreamExpectation

CreateByteStreamExpressionExpectation(expression)¶

Creates a byte stream expression expectation.

Parameters:

expression : str¶: The expression text.

Returns:

The byte stream expectation

Return type:

ByteStreamExpressionExpectation

CreateCurveAllExpectation(expectationObject)¶

Creates a curve expectation. All values of the curve have to fulfill the given expectation.

Parameters:

expectationObject¶: The expectation object

Returns:

The curve expectation

Return type:

CurveAllExpectation

CreateCurveAllExpressionExpectation(expression)¶

Creates a curve expectation. All values of the curve have to fulfill the given expression.

Parameters:

expression : str¶: String expression

Returns:

The curve expression expectation

Return type:

CurveAllExpectation

CreateCurveSingleExpectation(dimension)¶

Creates a curve expectation.

Parameters:

dimension : int¶: Curve dimension

Returns:

The curve expectation

Return type:

CurveSingleExpectation

CreateDTCListExpectation()¶

Creates a DTC list expectation.

Returns:: DTC list expectation, initialized with default values
Return type:: DTCListExpectation

CreateExpressionExpectation(expression=None)¶

Creates an unspecific expression expectation.

Parameters:

expression : str¶: Optional. The expression text.

Returns:

The unspecific expression expectation

Return type:

ExpressionExpectation

CreateImageExpectation()¶

Creates an image expectation.

Returns:: The image expectation
Return type:: ImageExpectation

CreateMapAllExpectation(expectationObject)¶

Creates a map expectation. All values of the map have to fulfill the given expectation.

Parameters:

expectationObject¶: The expectation object

Returns:

The map expectation

Return type:

MapAllExpectation

CreateMapAllExpressionExpectation(expression)¶

Creates a map expectation. All values of the map have to fulfill the given expression.

Parameters:

expression : str¶: String expression

Returns:

The map expectation

Return type:

MapAllExpectation

CreateMapSingleExpectation(xDimension, yDimension)¶

Creates a map expectation.

Parameters:

xDimension : int¶: Map x-axis dimension
yDimension : int¶: Map y-axis dimension

Returns:

The map expectation

Return type:

MapSingleExpectation

CreateMatrixAllExpectation(expectationObject)¶

Creates a matrix expectation. All values of the matrix have to fulfill the given expectation.

Parameters:

expectationObject¶: The expectation object

Returns:

The matrix expectation

Return type:

MatrixAllExpectation

CreateMatrixAllExpressionExpectation(expression)¶

Creates a matrix expectation. All values of the matrix have to fulfill the given expression.

Parameters:

expression : str¶: String expression

Returns:

The matrix expression expectation

Return type:

MatrixAllExpectation

CreateMatrixSingleExpectation(xDimension, yDimension)¶

Creates a matrix expectation.

Parameters:

xDimension : int¶: Matrix x-axis dimension
yDimension : int¶: Matrix y-axis dimension

Returns:

The matrix expectation

Return type:

MatrixSingleExpectation

CreateNotPresentExpectation()¶

Creates a ~Not Present~ expectation.

Returns:: The NotPresent expectation
Return type:: NotPresentExpectation

CreateNumericExpectation()¶

Creates a numeric expectation.

Returns:: The numeric expectation
Return type:: NumericExpectation

CreateNumericExpressionExpectation(expression=None)¶

Creates a manual numeric expectation.

Parameters:

expression : str¶: Optional. The expression text.

Returns:

The numeric expectation

Return type:

NumericExpressionExpectation

CreatePresentExpectation()¶

Creates a ~Present~ expectation.

Returns:: The Present expectation
Return type:: PresentExpectation

CreateStringExpectation()¶

Creates a string expectation.

Returns:: The string expectation
Return type:: StringExpectation

CreateStringExpressionExpectation(expression=None)¶

Creates a string expression expectation.

Parameters:

expression : str¶: Optional. The expression text.

Returns:

The string expression expectation

Return type:

StringExpressionExpectation

CreateStringListExpectation()¶

Creates a string list expectation.

Returns:: The string list expectation
Return type:: StringListExpectation

CreateVectorAllExpectation(expectationObject)¶

Creates a vector expectation. All values of the vector have to fulfill the given expectation.

Parameters:

expectationObject¶: The expectation object

Returns:

The vector expectation

Return type:

VectorAllExpectation

CreateVectorAllExpressionExpectation(expression)¶

Creates a vector expectation. All values of the vector have to fulfill the given expression.

Parameters:

expression : str¶: String expression

Returns:

The vector expectation

Return type:

VectorAllExpectation

CreateVectorSingleExpectation(dimension)¶

Creates a vector expectation.

Parameters:

dimension : int¶: Vector dimension

Returns:

The vector expectation

Return type:

VectorSingleExpectation