Apama 10.7.2 | Building and Using Apama Dashboards | Dashboard Function Reference | Tabular Functions | Multiply Columns
 
Multiply Columns
Returns a table that includes a column reflecting the product of two specified columns of a specified table, the product of a specified value and a specified column, or the product of two specified values.
Usage notes
*Case 1: Product of two specified columns of a specified table. This is the case if First Column Name or Numeric Value and Second Column Name or Numeric Value both specify a column of Table.
*Case 2: Product of a specified value and a specified column. This is the case if one of First Column Name or Numeric Value and Second Column Name or Numeric Value specifies a column of Table and the other specifies a numeric value.
*Case 3: Product of two specified values. This is the case if First Column Name or Numeric Value and Second Column Name or Numeric Value both specify a numeric value.
In case 1, the nth cell in the returned column corresponds to the nth cell of the table specified by the argument Table. Each cell of the returned column contains the result of multiplying the corresponding row's cell in First Column Name or Numeric Value by the cell in Second Column Name or Numeric Value.
In case 2, the nth cell in the returned column corresponds to the nth cell of the table specified by the argument Table. Each cell of the returned column contains the result of multiplying the corresponding row's cell in the specified column by the specified numeric value.
In case 3, each cell of the returned column contains the product of the two specified numeric values.
In the returned table, the product column is preceded by copies of all the columns in Table.
Arguments
The function has the following arguments:
*Table: Table that contains the columns to be summed.
*First Column Name or Numeric Value: Text string specifying the first column to be included in the product, or numerical value to be included in the product.
*Second Column Name or Numeric Value: Text string specifying the second column to be included in the product, or numerical value to be included in the product.
*Result Column Name: Text string that specifies the name of the column containing the products. You must supply a value for this argument.
This function returns a table.