Data Set Header Record

The Data Set Header Record (DSHR) defines all information common to all entities contained in a single CCOGIF dataset. A CCOGIF volume may contain more than one dataset.

FME represents a DSHR record with a CCOGIF_METADATA feature with the following attributes:

Attribute Name	Description	Type
ccogif_record_code	Record code (constant DSHR).	char(4)
ccogif_data_set_name	Dataset name.	char(64)
ccogif_ds_cre_date	Dataset creation date.	date
ccogif_ds_loc_text	Dataset geographic location text.	char(64)
ccogif_related_ds	Reference to other related datasets.	char(64)
ccogif_data_three_dim	Specifies whether data is three-dimensional (3D). If false, Z coordinate is always zero. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_pt_to_ln_topo	Specifies whether point-to-line topology exists in a dataset. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_ln_to_pt_topo	Specifies whether line-to-point topology exists in a dataset. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_colloc_exists	Specifies whether dataset employs line collocation. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_ln_to_area_topo	Specifies whether line-to-area topology exists in a dataset. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_area_to_ln_topo	Specifies whether area-to-line topology exists in a dataset. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_known_pt_in_area	Specifies whether there is a known point in each area. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_attrs_in_entity	Specifies whether attributes are present in entity records. Legal values are T (true), F (false) and U (unknown).	char(1)
ccogif_feat_classes	Ordered list of feature classes (A to K) for the dataset. Blanks are placed for classes not present; e.g., A, D, GH, J.	char(32)
ccogif_num_data_grp	Number of data groups contained in this CCOGIF dataset (n>=1).	int(16)
ccogif_num_ufl_recs	Number of user fixed length records immediately following this dataset header record (n>=0).	int(16)
ccogif_num_emd_recs	Number of entity metadata records that describe the contents of this CCOGIF dataset (n>=1).	int(16)
ccogif_x_data_type, ccogif_y_data_type, ccogif_z_data_type	Data type of x, y, or z coordinate values. Legal values are INT, REAL or DMS.	char(4)
ccogif_x_data_units, ccogif_y_data_units, ccogif_z_data_units	Units in which x, y, or z coordinate values are measured – for example, METRES, METRES ASL.	char(16)
ccogif_z_min_value, ccogif_z_max_value	Z coordinate minimum and maximum values. Interpretation of this attribute depends on the values of ccogif_z_data_type and ccogif_z_data_units.	variable1Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHRs x, y, or z data type corresponding to that field.
ccogif_proj_id	Map projection identifier that describes the map projection in which the entity data in the dataset is encoded. See the discussion below this table for more details.	char(4)
ccogif_geod_datum	Name of geodetic datum.	char(16)
ccogif_adj_name	Name of adjustment.	char(16)
ccogif_vert_datum	Name of vertical datum.	char(16)

The ccogif_x_data_type, ccogif_y_data_type, and ccogif_z_data_type tell what numeric format is used to represent x, y, and z coordinate values. INTEGER and REAL are obvious representations. DMS values for x and y coordinate values only are stored as +ddd mm ss.sss, where ddd is the degrees portion of the number, mm is the number of minutes, and ss.sss is the number of seconds. DMS values are converted by FME to their corresponding numeric or decimal values.

The DSHR feature also contains a number of attributes specific to the map projection in which the dataset's entities are expressed. The selection of map projection is made by the ccogif_proj_id attribute. It has one of the following values:

Map Projection ID	Projection Name
0100	Latitude/Longitude
0200	Transverse Mercator—Universal Transverse Mercator (UTM) projections are stored with this ID as well
0203	Mercator
0300	Lambert Conformal
0400	Stereographic
0500	Polyconic

The attributes for each map projection type are listed in the following sections.

Latitude/Longitude Project Parameters

Datasets in the Latitude/Longitude projection have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0100.	char(4)
ccogif_proj_name	Map projection name, constant LATITUDE/LONGITUDE.	char(32)
ccogif_proj_origin_x, ccogif_proj_origin_y	Longitude/latitude origin for x,y coordinates.	DMS
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12).	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd).	DMS

Transverse Mercator Projection Parameters

Datasets in the Transverse Mercator projection have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0200.	char(4)
ccogif_proj_name	Map projection name, constant TRANSVERSE MERCATOR.	char(32)
ccogif_proj_cent_merid	Central meridian.	DMS
ccogif_proj_zone_width	Zone width.	DMS
ccogif_proj_sphd_name	Spheroid name.	char(20)
ccogif_proj_semi_major	Semi-major axis.	real(16)
ccogif_proj_semi_minor	Semi-minor axis.	real(16)
ccogif_proj_eccent	Eccentricity.	real(16)
ccogif_proj_scl_fact	Scale factor.	real(16)
ccogif_proj_false_east, ccogif_proj_fals_north	False Easting/Northing.	real(16)
ccogif_proj_zone	Zone number.	int(16)
ccogif_proj_orig_east, ccogif_proj_orig_north	Origin (easting, northing).	variable2Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHR’s x, y, or z data type corresponding to that field.
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12).	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd).	variablea

Mercator Projection Parameters

Datasets in the Mercator projection have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0203.	char(4)
ccogif_proj_name	Map projection name, constant MERCATOR.	char(32)
ccogif_proj_mid_lat	Mid latitude.	DMS
ccogif_proj_sphd_name	Spheroid name.	char(20)
ccogif_proj_semi_major	Semi-major axis.	real(16)
ccogif_proj_semi_minor	Semi-minor axis.	real(16)
ccogif_proj_eccent	Eccentricity.	real(16)
ccogif_proj_orig_east, ccogif_proj_orig_north	Origin (easting, northing).	variable3Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHR’s x, y, or z data type corresponding to that field.
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12).	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd).	variablea

Lambert Conformal Projection Parameters

Datasets in the Mercator projection have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0300.	char(4)
ccogif_proj_name	Map projection name, constant LAMBERT CONFORMAL.	char(32)
ccogif_proj_frst_scl_par	First scaling parallel.	DMS
ccogif_proj_secnd_scl_par	Second scaling parallel.	DMS
ccogif_proj_sphd_name	Spheroid name.	char(20)
ccogif_proj_semi_major	Semi-major axis.	real(16)
ccogif_proj_semi_minor	Semi-minor axis.	real(16)
ccogif_proj_eccent	Eccentricity.	real(16)
ccogif_proj_orig_east, ccogif_proj_orig_north	Origin (easting, northing).	variable4Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHR’s x, y, or z data type corresponding to that field.
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12).	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd).	variablea

Stereographic Projection Parameters

Datasets in the Mercator projection will have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0400	char(4)
ccogif_proj_name	Map projection name, constant STEREOGRAPHIC	char(32)
ccogif_proj_scale_lat	Scaling latitude	DMS
ccogif_proj_sphd_name	Spheroid name	char(20)
ccogif_proj_semi_major	Semi-major axis	real(16)
ccogif_proj_semi_minor	Semi-minor axis	real(16)
ccogif_proj_eccent	Eccentricity	real(16)
ccogif_proj_orig_east, ccogif_proj_orig_north	Origin (easting, northing)	variable5Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHRs x, y, or z data type corresponding to that field.
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12)	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd)	variablea

Polyconic Projection Parameters

Datasets in the Mercator projection have the following attributes defined on their DSHR feature:

Attribute Name	Description	Type
ccogif_proj_id	Map projection identifier, constant 0500.	char(4)
ccogif_proj_name	Map projection name, constant POLYCONIC.	char(32)
ccogif_proj_cent_merid	Central meridian.	DMS
ccogif_proj_sphd_name	Spheroid name.	char(20)
ccogif_proj_semi_major	Semi-major axis.	real(16)
ccogif_proj_semi_minor	Semi-minor axis.	real(16)
ccogif_proj_eccent	Eccentricity.	real(16)
ccogif_proj_orig_east, ccogif_proj_orig_north	Origin (easting, northing).	variable6Fields marked with a type of variable are either REAL, INTEGER, or DMS depending on the DSHR’s x, y, or z data type corresponding to that field.
ccogif_proj_num_bnd_crd	Number of coordinate pairs that form a bounding polygon for this dataset (0>=n>=12).	int(16)
ccogif_proj_bnd_crd{n}.x, ccogif_proj_bnd_crd{n}.y	Coordinate #n of bounding polygon (0>=n>config_num_bnd_crd).	variablea