Skip to end of metadata
Go to start of metadata

HasAppliedMainWeightT()

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

Available To
PrepareJob
PerformJob
CleanUpJob
HasAppliedMainWeightT(JobInfoT* JobInfo,int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to check.
Returns
1The summation has a main weight.
0The 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
HasAppliedReplicateWeightsT(JobInfoT* JobInfo,int Dimension, int FieldOffset)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to check.
Returns
1The summation has applied replicate weights.
0The 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
GetAppliedReplicateWeightsT(JobInfoT* JobInfo,int Dimension, int FieldOffset, const char*** Replicates,int* Len)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
FieldOffsetInputThe field index within this dimension to get replicate weights from.
ReplicatesOutputThe names of replicate weights.
LenOutputThe number of replicate weights returned.
Returns
1Success.
0Failed.

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
HasAppliedMainWeightOnDefaultSummationT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns
1The summation has an applied main weight.
0The 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
GetAppliedMainWeightOnDefaultSummationT(JobInfoT* JobInfo,const char** MainWeight)
Arguments
JobInfoInputInformation about the current job.
MainWeightOutputThe name of the main weight, terminated by '\0'
Returns
1Success.
0Failed.

HasAppliedReplicateWeightsOnDefaultSummationT()

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

Available To
PrepareJob
PerformJob
CleanUpJob
HasAppliedReplicateWeightsOnDefaultSummationT(JobInfoT* JobInfo)
Arguments
JobInfoInputInformation about the current job.
Returns
1The default summation has applied replicate weights.
0The 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
GetAppliedReplicateWeightsOnDefaultSummationT(JobInfoT* JobInfo,const char*** Replicates, int* Len)
Arguments
JobInfoInputInformation about the current job.
ReplicatesOutputThe names of replicate weights.
LenOutputThe number of replicate weights returned.
Returns
1Success.
0Failed.

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
GetCurrentCellReplicateWeightValuesT(JobInfoT *JobInfo, const double** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
ValuesOutputThe values of the replicate weights.
LenOutputThe number of replicate weights returned.
Returns
1Success.
0Failed.

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
GetCellReplicateWeightValuesT(JobInfoT *JobInfo, int* DimensionItems, const double** Values, int* Len)
Arguments
JobInfoInputInformation about the current job.
DimensionInputThe dimension index within the data cube.
ValuesOutputThe values of the replicate weights.
LenOutputThe number of replicate weights returned.
Returns
1Success.
0Failed.

GetSumMainWeightTableT()

Retrieve the sum of the main weight in specified table.

Available To
PrepareJob
PerformJob
CleanUpJob
GetSumMainWeightTableT(JobInfoT *JobInfo, const char * tableName, double* result)
Arguments
JobInfoInputInformation about the current job.
tableNameInputThe table to query.
resultOutputA pointer to the value containing the resulting sum value.
Returns
1Success.
0Failed.
  • No labels