2.4.134 BrtBeginPCDFGRange
The BrtBeginPCDFGRange record specifies the grouping (section 2.2.5.2.4) properties of a cache field (section 2.2.5.2.2) and specifies the beginning of an empty collection of records as defined by the PivotCache Definition (section 2.1.7.38) part ABNF.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
iByType |
A |
B |
C |
reserved |
xnumStart |
||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
xnumEnd |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
xnumBy |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
iByType (8 bits): An unsigned integer that specifies the type of grouping. This value MUST be a value from the following table.
-
iByType
Meaning
0x00
By numeric range.
0x01
By seconds.
0x02
By minutes.
0x03
By hours.
0x04
By days.
0x05
By months.
0x06
By quarters.
0x07
By years.
If the BrtBeginPCDFGroup (section 2.4.135) record immediately preceding this record has an ifdbParent field that is not equal to -1, the iByType field of the BrtBeginPCDFGRange record directly following the BrtBeginPCDFGroup record that is directly following the BrtBeginPCDField (section 2.4.136) record specified by the ifdbParent field in the immediately preceding BrtBeginPCDFGroup record MUST have a value that is greater than this value.
If the value is greater than 0x00 and the fSrcField field of the preceding BrtBeginPCDField record is 1, then the BrtBeginPCDFAtbl (section 2.4.131) record of this cache field MUST have fDateInField field equal to 1 and fNumField field equal to 0. Also, the preceding BrtBeginPCDField record MUST have fTextEtcField equal to 0; otherwise, it MUST have fMixedTypesIgnoringBlanks equal to 0 and fHasBlankItem equal to 0.
If this value is greater than 0x00, the BrtBeginPCDFAtbl record of this cache field MUST have fHasTextItem equal to 0 and fMixedTypesIgnoringBlanks equal to 0.<15>
A - fAutoStart (1 bit): A bit that specifies whether the source data (section 2.2.5.2.1) is used to set the starting range value. Possible values for this field are listed in the following table.
-
Value
Meaning
0
The starting range value is set from the value specified in xnumStart.
1
The starting range value is set from the source data.
-
B - fAutoEnd (1 bit): A bit that specifies whether the source data is used to set the ending range value. Possible values for this field are listed in the following table.
-
Value
Meaning
0
The ending range value is set from the value specified in xnumEnd.
1
The ending range value is set from the source data.
-
C - fDates (1 bit): A bit that specifies that xnumStart and xnumEnd are dates rather than numbers. The value in this field MUST be 1 if iByType is greater than 0x00, and MUST be 0 otherwise. Possible values for this field are listed in the following table.
-
Value
Meaning
0
xnumStart and xnumEnd are numbers.
1
xnumStart and xnumEnd are dates.
-
reserved (5 bits): This value MUST be 0 and MUST be ignored.
xnumStart (8 bytes): An Xnum (section 2.5.172) or DateAsXnum (section 2.5.30) that specifies the starting value used for numeric or date grouping when fAutoStart is 0. If fDates is 1, this value is a DateAsXnum, otherwise it is an Xnum.
xnumEnd (8 bytes): An Xnum or DateAsXnum that specifies the ending value used for numeric or date grouping when fAutoEnd is 0. If fDates is 1, this value is a DateAsXnum, otherwise it is an Xnum. MUST be greater than or equal to xnumStart.
xnumBy (8 bytes): An Xnum that specifies the grouping interval for numeric range grouping. Specifies the number of days to group by in date range grouping. This value MUST be greater than zero. If iByType is not 0x00, it MUST be an integer less than 32,768.