Class pvc.options.DimensionsCalculation
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
A dimensions calculation allows the values of a dimension
to be calculated from the typed values of
the other non-calculated dimensions.
|
| Field Attributes | Field Name and Description |
|---|---|
| General | |
|
The name or names of the dimensions that
are calculated by the calculation.
|
|
| Method Attributes | Method Name and Description |
|---|---|
| General | |
|
calculation(datum, outAtoms)
A dimensions calculation function.
|
|
While a dimensions reader could achieve the same result, it works by reading values from the logical table, accessing it by index. That would require the knowledge of the indexes in which the desired dimensions were, which is many times not true, specially when the mapping between dimensions and logical table indexes is determined automatically by the data translator.
When the argument is a string, it can be a list of names, separated by the character ",".
Only one dimensions calculation or dimensions reader can calculate or read a given dimension.
- Context:
- {null}
- Arguments:
- {pvc.data.Complex} datum
- The complex (Datum or Data) instance whose dimensions are being calculated.
- {object} outAtoms
- An object that should be filled with read raw or typed values,
each placed in a property with the name
of the corresponding dimension.
It is also possible that the values be the atoms themselves, a technique that can be used to achieve greater performance, when a dimension only has two or three possible values.
- Returns:
- {undefined}