Description of Records and Tokens
The tokens seen on a record can vary for some record types depending upon the setup. These variations will be described specifically where necessary.
VERSION:
This is a required record type, of which there must be only one in the file. It must be the first non-commented record. This must have only one token following, which is the version number. At the time of writing, only version 2 is supported for Washability. See line 6 in the specimen .
Note: Metafiles from the old Vulcan washability are not supported by this system. They do not contain sufficient setup information to support the flexibility of the new Washability system.
SEAM_MATCH:
This optional record contains the match string for horizon name used to select horizons when creating the metafile. This record is only present if the standardisation specifications use string name matching for horizons (By name option)—of which there must be only one record in the file. It is not present when using selections lists or selection files. The presence of this record is also a flag to indicate that seam name is used.
This record must have only one token, which is the match string for horizon names. See line 7 in the specimen , where the match string is the wildcard asterisk, i.e. any match.
PLY_MATCH:
This optional record contains the match string for ply name used to select horizons when creating the metafile. This record is only present if the standardisation specifications use string name matching for horizons (By name option) and if the source database specifications for the sample record indicate that a ply field is in use. There can be only one record in the file and it may only be present if there is also a SEAM_MATCH: record. The presence of this record is also a flag to indicate that ply name is used.
This record must have only one token, which is the match string for ply names. See line 8 in the specimen , where the match string is the wildcard asterisk, i.e. any match.
SIZE_RANGE:
This optional record contains the size range (passing sieve and holding sieve sizes) for matching samples for an intercept. This record is present only if the standardisation specifications use size range matching—of which there can be only one record in the file. The presence of this record is also a flag to indicate that sample size fractions are used ( SIZE_FRAC: records must not be present unless this flag record is specified).
This record must have two tokens following, which are the passing sieve size and the holding sieve size in that order. See line 9 in the specimen .
VARIABLES:
This is a required record type, of which there can be only one in the file. This must have only one token following, which is an integer number (>0). This number specified is the number of variables (N) analysed by gravity-separation in the wash tables contained in this file. See line 10 in the specimen .
VARIABLE:
This is a required record type, of which there can be N numbers in the file (where N is indicated by the VARIABLES: record). See lines 11–13 in the specimen . Each of these records can have seven tokens in the order shown below to describe the variable:
| Name | String | Used as column header in the tables |
| Width | Integer | Used as field width in standard database |
| Precision | Integer | Used as field precision in standard database |
| Percentage | Flag | Set if variable is a percentage |
| Cumulate | Flag | Set if variable is cumulate type (eg. CSN) |
| Zero | Flag | Set if zero values are acceptable for a variable |
| Field | String | Used as variable field name in standard database (i.e. field name from source database) |
Note: The flag fields must be a Boolean set using a string equivalent (i.e. either TRUE or FALSE).
HAS_SAM_RD:
This is a required record type, of which there can be only one in the file. This must have one token, which is a Boolean string flag (TRUE or FALSE). See line 14 in the specimen .
The presence of this record is also a flag to indicate whether or not the data contains sample raw density values. The raw density value is expected as a token in the INTERCEPT: record when used.
HAS_SAMYLD:
This is a required record type, of which there can be only one in the file. This must have one token, which is a Boolean string flag (TRUE or FALSE). See line 15 in the specimen .
The presence of this record is also a flag to indicate whether or not the data contains sample yield values. It is likely to be used only when using sizes but not necessarily. If size fractions are used, the sample yield value is expected in the SIZE_FRAC: record and if not used, the sample yield value is expected in the WASH_START: record.
HAS_CUMFLG:
This is a required record type, of which there can be only one in the file. This must have one token, which is a Boolean string flag (TRUE or FALSE). See line 16 in the specimen .
The presence of this record is also a flag to indicate whether or not the wash tables have a flag character token to know if it is a cumulative or a fractional wash table. If used, the flag will be a token in the WASH_START: record (for auto-generated metafiles, this will be derived from the value of the cumulative/fractional indicator on the source database). If not used, the wash tables will be assumed to be fractional while they are read, but will be examined to determine if they contain cumulative data. This is not regarded as a foolproof technique and recommended that an explicit flag be used.
HAS_FRC_RD:
This is a required record type, of which there can be only one in the file. This must have one token, which is a Boolean string flag (TRUE or FALSE). See line 17 in the specimen .
The presence of this record is also a flag to indicate whether or not the wash tables will have a column containing the actual RD of the density fractions. If used, it is usually the end points where an RD value is given (i.e. the first float fraction and the final sinks).
TABLE_ENDS:
This is a required record type, of which there can be only one in the file. This must have one token, which is a Boolean string flag (TRUE or FALSE). See line 18 in the specimen .
The presence of this record is also a flag to indicate whether or not the WASH_START: sink and the WASH_END: float densities are shown as 0.0 (TRUE) or <blank> (FALSE). For example:
| Appearance if FALSE | Appearance if TRUE | ||
| 1.850 | 0.000 | 1.850 | |
| 1.850 | 1.900 | 1.850 | 1.900 |
| 1.900 | 2.000 | 1.900 | 2.000 |
| 2.000 | 2.000 | 0.000 |
SIZE_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 19 in the specimen . This record indicates the format of size field in resultant standard database.
COORD_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 20 in the specimen . This record indicates the format of coordinate fields in resultant standard database.
COLLAR_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 21 in the specimen . This record indicates the format of collar level field in resultant standard database.
DEPTH_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 22 in the specimen . This record indicates the format of depth fields in resultant standard database.
SEAM_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 23 in the specimen . This record indicates the format of seam field in resultant standard database.
PLY_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 24 in the specimen . This record indicates the format of ply field in resultant standard database.
HOLEID_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 25 in the specimen . This record indicates the format of hole ID field in resultant standard database.
SAMPID_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 26 in the specimen . This record indicates the format of sample ID field in resultant standard database.
SAMYLD_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 27 in the specimen . This record indicates the format of sample yield field in resultant standard database.
RAWRD_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 28 in the specimen . This record indicates the format of raw ID field in resultant standard database.
FLSKRD_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 29 in the specimen . This record indicates the format of float/sink RD fields in resultant standard database.
YIELD_FMT:
This is a required record type, of which there can be only one in the file. It must have two integer tokens, namely field width and field precision. See line 30 in the specimen . This record indicates the format of yield field in resultant standard database.
HOLE_REC:
This record indicates the start of a data group in the resultant standard database. It is assumed that the hole ID used should be unique for the file, however it is not tested. If it is not unique, only the last data group for a hole will be retained in the resultant database.
Note: HOLE_REC: records won't be present without associated SEAM: records.
The hole record must have other five tokens in the following order:
| Hole ID | String | The hole name—needs to be unique for the file |
| Easting | Double | The hole collar easting coordinate |
| Northing | Double | The hole collar northing coordinate |
| Level | Double | The hole collar reduced level |
| Depth | Double | The total depth of the hole |
See lines 31 and 75 in the specimen .
SEAM:
This is the geological horizon record defining a seam (and ply). There can be multiple seam records per hole but there should always be at least one.
Note: SEAM: records won't be present without associated INTERCEPT: records.
The seam record must have at least one token, but it may have two, in the following order:-
| Seam | String | The seam name—must always be present |
| Ply | String | The ply name—only present if PLY_MATCH : record is present |
See lines 32, 51, 63, and 76 in the specimen .
INTERCEPT:
This is the depth interval record for a geological intercept with a measured sample. There can be multiple intercept records per seam but there should always be at least one.
Note: INTERCEPT: records won't be present without associated SIZE_FRAC: records (if a SIZE_RANGE: record is present) or associated wash table groups.
The intercept record must have at least three tokens, but it may have four, in the following order:
| Top | Double | Top depth of intercept |
| Bottom | Double | Bottom depth of intercept |
| Sample | String | The sample ID |
| Raw RD | Double | The raw sample density— only present if HAS_SAM_RD: record is set to TRUE) |
See lines 33, 52, and 64 in the specimen .
SIZE_FRAC:
This is the size fraction record for a sieved portion of a sample (intercept). It is present only if a SIZE_RANGE: was defined in the setup. When used, there may be multiple size-fraction records for each intercept record but there should always be at least one.
Note: SIZE_FRAC: records will not be present without associated wash-table group(s).
The size-fraction record must have at least two tokens, but it may have three, in the following order:
| Passing | Double | The passing-sieve size |
| Holding | Double | The holding-sieve size |
| Yield | Double | The sample yield (i.e. the proportion of the sample requested in this size-fraction)—only present if HAS_SAMYLD: record is set to TRUE |
See lines 34, 44, 53, and 65 in the specimen .
WASH_START:
This record indicates the first line of a wash table group. The wash table is made up of one WASH_START: record, 0–n WASH_LINE: records, and one WASH_END: record. There may be more than one wash table group per intercept/size-fraction if repeat testing was done but there should always be at least one. The fractional structure may be different between them as they will be shaped to standard and averaged.
The number of tokens is variable depending upon the number of variables analysed and the various setup settings. The will occur in the following order:
| Sink RD | Double | The fraction sink density—only present if TABLE_ENDS: record is set TRUE, in which case it will always be 0.000 |
| Float RD | Double | The fraction float density—must be present |
| Yield | Double | The fraction yield—must be present |
| Raw RD | Double | The fraction density—only present if HAS_FRC_RD: record is set to TRUE |
| Variables | Double | The analysed variable values—must be N of them (See VARIABLES: record) |
| Cum Flag | Double | The cumulative/fractional table indicator flag—only present if the HAS_CUMFLG: record is set to TRUE. Must be set to either F or C—for Fractional or Cumulative respectively. |
| Sample Yld | Double | The sample yield (i.e. the proportion of the sample represented in this sample/intercept)—only present if HAS_SAMYLD: is set to TRUE and there is no SIZE_RANGE : record (i.e. not using sizes) |
See lines 35, 45, 54, and 66 in the specimen .
WASH_LINE:
This record indicates the lines making up the body of the table in a wash table group. There will be 0–n of this record present.
The number of tokens is variable depending upon the number of variables analysed and the various setup settings. The will occur in the following order:
| Sink RD | Double | The fraction sink density—must be present |
| Float RD | Double | The fraction float density—must be present |
| Yield | Double | The fraction yield—must be present |
| Raw RD | Double | The fraction density—only present if HAS_FRC_RD: record is set to TRUE |
| Variables | Double | The analysed variable values—must be N of them (See VARIABLES: record) |
See lines 36–42, 46–49, 55–61, and 67–73 in the specimen .
WASH_END:
This is the last line of a wash table group and indicates the end of the table.
The number of tokens is variable depending upon the number of variables analysed and the various setup settings. The will occur in the following order:
| Sink RD | Double | The fraction sink density—must be present |
| Float RD | Double | The fraction float density—only present if TABLE_ENDS: record is set to TRUE, in which case it will always be 0.000 |
| Yield | Double | The fraction yield—must be present |
| Raw RD | Double | The fraction density—only present if HAS_FRC_RD: record is set to TRUE |
| Variables | Double | The analysed variable values—must be N of them (See VARIABLES: record) |
See lines 43, 50, 62, and 74 in the specimen .
EOF:
This is the last record of the file and indicates that the file has not terminated prematurely. There are no tokens for this type of record.
See line 9999 in the specimen .
