The OperatorFilter object defines an operator filter.
The OperatorFilter object is derived from the Filter object.
filterApi.filters()[name]
This method creates an OperatorFilter object.
filterApi.OperatorFilter
odb_OperatorFilter&
OperatorFilter(const odb_String& name,
double cutoffFrequency,
int order,
const odb_String& operation,
bool halt,
odb_Union limit,
const odb_String& invariant);Required arguments
An odb_String specifying the repository key. This name ANTIALIASING is reserved for filters generated internally by the program.
A Double specifying the attenuation point of the filter. Possible values are non-negative numbers. Order is not available for OperatorFilter.
Optional arguments
An Int specifying the highest power of the filter transfer function. Possible values are non-negative numbers less than or equal to 20. Order is not available for OperatorFilter. The default value is 2.
An odb_String specifying the filter operator. Possible values are "NONE", "MIN", "MAX", and "ABS". The default value is "NONE".
A Boolean specifying whether to stop the analysis if the specified limit is reached. The default value is false.
The string "NONE" or a Double specifying the threshold limit, an upper or lower bound for output values depending on the operation, or a bound for stopping the analysis when Halt is used. The default value is "NONE".
An odb_String specifying the invariant to which filtering is applied. Possible values are "NONE", "FIRST", and "SECOND". The default value is "NONE".
Return value
An OperatorFilter object.
Exceptions
InvalidNameError and RangeError.
This method modifies the OperatorFilter object.
Required arguments
Optional arguments
The optional arguments to setValues are the same as the arguments to the OperatorFilter method, except for the name argument.
Return value
Exceptions
RangeError.
The OperatorFilter object has members with the same names and descriptions as the arguments to the OperatorFilter method.