Weighting

HasAppliedMainWeightT()

Query whether a summation field has an applied main weight in the given tabulation job.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

HasAppliedMainWeightT(JobInfoT* JobInfo,int Dimension, int FieldOffset)

Arguments

JobInfo	Input	Information about the current job.
Dimension	Input	The dimension index within the data cube.
FieldOffset	Input	The field index within this dimension to check.

Returns

1	The summation has a main weight.
0	The summation does not have a main weight.

HasAppliedReplicateWeightsT()

Query whether a summation field has applied replicate weights in the given tabulation job.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

HasAppliedReplicateWeightsT(JobInfoT* JobInfo,int Dimension, int FieldOffset)

Arguments

JobInfo	Input	Information about the current job.
Dimension	Input	The dimension index within the data cube.
FieldOffset	Input	The field index within this dimension to check.

Returns

1	The summation has applied replicate weights.
0	The summation does not have applied replicate weights.

GetAppliedReplicateWeightsT()

Retrieve the names of the replicate weights for the given summation field in the given tabulation job. The order of the names will be the same as the order of retrieved replicate weight values for a given cell.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetAppliedReplicateWeightsT(JobInfoT* JobInfo,int Dimension, int FieldOffset, const char*** Replicates,int* Len)

Arguments

JobInfo	Input	Information about the current job.
Dimension	Input	The dimension index within the data cube.
FieldOffset	Input	The field index within this dimension to get replicate weights from.
Replicates	Output	The names of replicate weights.
Len	Output	The number of replicate weights returned.

Returns

1	Success.
0	Failed.

HasAppliedMainWeightOnDefaultSummationT()

Query whether the default summation field has an applied main weight in the given tabulation job. This function must be used when the given tabulation job does not have an explicitly added summation.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

HasAppliedMainWeightOnDefaultSummationT(JobInfoT* JobInfo)

Arguments

JobInfo	Input	Information about the current job.

Returns

1	The summation has an applied main weight.
0	The summation does not have an applied main weight.

GetAppliedMainWeightOnDefaultSummationT()

Retrieve the name of the main weight for the given summation field in the given tabulation job. This function must be used when the given tabulation job does not have an explicitly added summation.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetAppliedMainWeightOnDefaultSummationT(JobInfoT* JobInfo,const char** MainWeight)

Arguments

JobInfo	Input	Information about the current job.
MainWeight	Output	The name of the main weight, terminated by '\0'

Returns

1	Success.
0	Failed.

HasAppliedReplicateWeightsOnDefaultSummationT()

Query whether the default summation field in the given tabulation job has applied replicate weights.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

HasAppliedReplicateWeightsOnDefaultSummationT(JobInfoT* JobInfo)

Arguments

JobInfo	Input	Information about the current job.

Returns

1	The default summation has applied replicate weights.
0	The summation does not have applied replicate weights.

GetAppliedReplicateWeightsOnDefaultSummationT()

Retrieve the names of the replicate weights for the given summation field in the given tabulation job. The order of the names is the same as the order of retrieved values of replicate weights for a given cell. This function must be used when the given tabulation job doesn't have an explicitly added summation.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetAppliedReplicateWeightsOnDefaultSummationT(JobInfoT* JobInfo,const char*** Replicates, int* Len)

Arguments

JobInfo	Input	Information about the current job.
Replicates	Output	The names of replicate weights.
Len	Output	The number of replicate weights returned.

Returns

1	Success.
0	Failed.

GetCurrentCellReplicateWeightValuesT()

Retrieve the values of replicate weights for the current cell in the given tabulation job. The order of the values will be the same as the order of retrieved replicate weight names for the current cell.

The lifetime of the returned value of const double** may last up to the next function call. However, if your client code needs to maintain the returned value in the scope of the tabulation job, the client should make a copy of the returned value.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetCurrentCellReplicateWeightValuesT(JobInfoT *JobInfo, const double** Values, int* Len)

Arguments

JobInfo	Input	Information about the current job.
Values	Output	The values of the replicate weights.
Len	Output	The number of replicate weights returned.

Returns

1	Success.
0	Failed.

GetCellReplicateWeightValuesT()

Retrieve the values of replicate weights for the given cell in the given tabulation job. The order of the values will be the same as the order of retrieved replicate weight names for the given cell.

The lifetime of the returned value of const double** may last up to the next function call. However, if your client code needs to maintain the returned value in the scope of the tabulation job, the client should make a copy of the returned value.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetCellReplicateWeightValuesT(JobInfoT *JobInfo, int* DimensionItems, const double** Values, int* Len)

Arguments

JobInfo	Input	Information about the current job.
Dimension	Input	The dimension index within the data cube.
Values	Output	The values of the replicate weights.
Len	Output	The number of replicate weights returned.

Returns

1	Success.
0	Failed.

GetSumMainWeightTableT()

Retrieve the sum of the main weight in specified table.

Available To	PrepareJob	PerformJob	CleanUpJob

CPP

GetSumMainWeightTableT(JobInfoT *JobInfo, const char * tableName, double* result)

Arguments

JobInfo	Input	Information about the current job.
tableName	Input	The table to query.
result	Output	A pointer to the value containing the resulting sum value.

Returns

1	Success.
0	Failed.

GetWeightedTableIdentifiersT()

Retrieve the table IDs for a weighted table.

Available To	PreJob	PrepareJob	PerformJob

CPP

GetWeightedTableIdentifiersT(JobInfoT* JobInfo, const char*** TableIds, int* Len)

Arguments

JobInfo	Input	Information about the current job.
TableIds	Output	The fact table IDs (set to NULL if there are no weighted tables).
Len	Output	The number of IDs returned.

Returns

1	Success.
0	Failed.

GetDefaultMainWeightFieldIdentifierT()

Retrieve the ID of the default main weight for a given fact table.

Available To	PreJob	PrepareJob	PerformJob

CPP

GetDefaultMainWeightFieldIdentifierT(JobInfoT* JobInfo, const char* table)

Arguments

JobInfo	Input	Information about the current job.
table	Input	The fact table ID.

Returns

The ID of the default main weight field, or NULL if the field does not exist.

GetDefaultReplicateWeightFieldIdentifiersT()

Retrieve the default replicate weight field IDs.

Available To	PreJob	PrepareJob	PerformJob

CPP

GetDefaultReplicateWeightFieldIdentifiersT(JobInfoT* JobInfo, const char* table, const char*** Replicates, int* Len)

Arguments

JobInfo	Input	Information about the current job.
table	Input	The fact table ID.
Replicates	Output	The replicate weight field IDs.
Len	Output	The number of IDs returned.

Returns

1	Success.
0	Failed.