Control File
- Last UpdatedDec 09, 2025
- 5 minute read
The customer specification of the purposes and space properties are set up in a text file in a special format, described in detail below. The interpretation and compilation of the file is made by a function within Inithull and a control object named __COMP_PURP__ is stored in the database after successful compilation.
Layout of the File
The control file may contain a number of different statement types as specified below.
The MODE Statement
The statement is used to define type of update, either creating a completely new purpose object or to update the existing one.
Syntax
|
MODE, [ /UPDATE ] [ /NEW ] ; |
|
|
/UPDATE |
To be used when updating the existing purpose object. |
|
/NEW |
To be used when creating a new purpose object and eventually overwriting a existing one. |
The LIST Statement
The statement is used to list the contents of an existing purpose object. If no object exists, the default object setup will be listed.
Syntax
LIST;
The TYPE_SEL Statement
The statement is used to define the type codes to be used on spaces.
Syntax
|
TYPE_SEL,<code> [ /DESC=<description> ] [ /DENS=<value> ) [ /STORE | /ACC | /MACH | /VOID | /DCARGO | /LCARGO | /TYPE_UD1 | /TYPE_UD2 | /TYPE_UD3 | /TYPE_UD4 | /TYPE_UD5 ] ; |
|
|
<code> |
String used as code for the type definition. |
|
/DESC |
Description string. |
|
/DENS |
Density. If given, the density will be used on space given this type. Value given as kg/m3. |
|
/STORE |
Type is defined as Stores. |
|
/ACC |
Type is defined as Accommodation. |
|
/MACH |
Type is defined as Machinery. |
|
/VOID |
Type is defined as Void. |
|
/DCARGO |
Type is defined as Dry cargo. |
|
/LCARGO |
Type is defined as Liquid cargo. |
|
/TYPE_UD<n> |
Type is user defined, <n> is a number between 1 and 50. |
|
/TYPE_UD1 |
Type is user defined. |
|
/TYPE_UD2 |
Type is user defined. |
|
/TYPE_UD3 |
Type is user defined. |
|
/TYPE_UD4 |
Type is user defined. |
|
/TYPE_UD5 |
Type is user defined. |
The Tight_SEL Statement
The statement is used to define the tightness codes to be used on spaces.
Syntax
|
TIGHT_SEL,<code> [ /DESC=<description> ] [ /AIR_T | /NON_T | /OIL_T | /WATER_T | /WEATHER_T | /TIGHT_UD1 | /TIGHT_UD2 | /TIGHT_UD3 | /TIGHT_UD4 | /TIGHT_UD5 ] ; |
|
|
<code> |
String used as code for the tightness definition. |
|
/DESC |
Description string. |
|
/AIR_T |
Tightness is defined as Air tight. |
|
/NON_T |
Tightness is defined as Non tight. |
|
/OIL_T |
Tightness is defined as Oil tight. |
|
/WATER_T |
Tightness is defined as Water tight. |
|
/WEATHER_T |
Tightness is defined as Weather tight. |
|
/TIGHT_UD1 |
Tightness is user defined. |
|
/TIGHT_UD2 |
Tightness is user defined. |
|
/TIGHT_UD3 |
Tightness is user defined. |
|
/TIGHT_UD4 |
Tightness is user defined. |
|
/TIGHT_UD5 |
Tightness is user defined. |
The NOISE_SEL Statement
The statement is used to define the noise category codes to be used on spaces.
Syntax
|
NOICE_SEL,<code> [ /DESC=<description> ] [ /LOW_N | /COMFORT | /QUIET | /DAVOID | /HIGH_N | /TOPS_N | /NOISE_UD1 | /NOISE_UD2 | /NOISE_UD3 | /NOISE_UD4 | /NOISE_UD5 ] ; |
|
|
<code> |
String used as code for the noise category definition. |
|
/DESC |
Description string. |
|
/LOW_N |
Noise category is defined as Intelligible speech - low noise. |
|
/COMFORT |
Noise category is defined as Comfort. |
|
/QUIET |
Noise category is defined as Quiet. |
|
/DAVOID |
Noise category is defined as Deafness avoidance. |
|
/HIGH_N |
Noise category is defined as Intelligible speech - high noise. |
|
/TOPS_N |
Noise category is defined as Intelligible speech - topside. |
|
/NOISE_UD1 |
Noise category is user defined. |
|
/NOISE_UD2 |
Noise category is user defined. |
|
/NOISE_UD3 |
Noise category is user defined. |
|
/NOISE_UD4 |
Noise category is user defined. |
|
/NOISE_UD5 |
Noise category is user defined. |
The ACCESS_SEL Statement
The statement is used to define the access category codes to be used on spaces.
Syntax
|
ACCESS_SEL,<code> [ /DESC=<description> ] [ /ACC_C | /ACC_O | /ACC_R | /ACC_U | /ACC_UD1 | /ACC_UD2 | /ACC_UD3 | /ACC_UD4 | /ACC_UD5 ] ; |
|
|
<code> |
String used as code for the access category definition. |
|
/DESC |
Description string. |
|
/ACC_C |
Access category is defined as Crew only. |
|
/ACC_O |
Access category is defined as Officers only. |
|
/ACC_R |
Access category is defined as Restricted. |
|
/ACC_U |
Access category is defined as Unrestricted. |
|
/ACC_UD1 |
Access category is user defined. |
|
/ACC_UD2 |
Access category is user defined. |
|
/ACC_UD3 |
Access category is user defined. |
|
/ACC_UD4 |
Access category is user defined. |
|
/ACC_UD5 |
Access category is user defined. |
The SAFETY_SEL Statement
The statement is used to define the safety category codes to be used on spaces.
Syntax
|
SAFETY_SEL,<code> [ /DESC=<description> ] [ /SAFE_A | /SAFE_B | /SAFE_C | /SAFE_UD1 | /SAFE_UD2 | /SAFE_UD3 | /SAFE_UD4 | /SAFE_UD5 ] ; |
|
|
<code> |
String used as code for the access category definition. |
|
/DESC |
Description string. |
|
/SAFE_A |
Safety category is defined as Class A. |
|
/SAFE_B |
Safety category is defined as Class B. |
|
/SAFE_C |
Safety category is defined as Class C. |
|
/SAFE_UD1 |
Safety category is user defined. |
|
/SAFE_UD2 |
Safety category is user defined. |
|
/SAFE_UD3 |
Safety category is user defined. |
|
/SAFE_UD4 |
Safety category is user defined. |
|
/SAFE_UD5 |
Safety category is user defined. |
The SECURITY_SEL Statement
The statement is used to define the security category codes to be used on spaces.
Syntax
|
SECURITY_SEL,<code> [ /DESC=<description> ] [ /SEC_C | /SEC_S | /SEC_U | /SEC_UD1 | /SEC_UD2 | /SEC_UD3 | /SEC_UD4 | /SEC_UD5 ] ; |
|
|
<code> |
String used as code for the security category definition. |
|
/DESC |
Description string. |
|
/SEC_C |
Security category is defined as Classified. |
|
/SEC_S |
Security category is defined as Secret. |
|
/SEC_U |
Security category is defined as Unclassified. |
|
/SEC_UD1 |
Security category is user defined. |
|
/SEC_UD2 |
Security category is user defined. |
|
/SEC_UD3 |
Security category is user defined. |
|
/SEC_UD4 |
Security category is user defined. |
|
/SEC_UD5 |
Security category is user defined. |
The PURP Statement
The statement is used to define a purpose definition that can be applied to spaces. The purpose definition is built up by adding properties as specified above, but also values density, structural allowance and permeability.
Syntax
|
PURP,<code> [ /DESC=<description> ] [ /DENS=<value> ] [ /STRUC=<value> ] [ /PERM=<value> ] [ /STORE | /ACC | /MACH | /VOID | /DCARGO | /LCARGO | /TYPE_UD<n> ] [ /AIR_T | /NON_T | /OIL_T | /WATER_T | /WEATHER_T | /TIGHT_UD1 | /TIGHT_UD2 | /TIGHT_UD3 | /TIGHT_UD4 | /TIGHT_UD5 ] [ /LOW_N | /COMFORT | /QUIET | /DAVOID | /HIGH_N | /TOPS_N | /NOISE_UD1 | /NOISE_UD2 | /NOISE_UD3 | /NOISE_UD4 | /NOISE_UD5 ] [ /ACC_C | /ACC_O | /ACC_R | /ACC_U | /ACC_UD1 | /ACC_UD2 | /ACC_UD3 | /ACC_UD4 | /ACC_UD5 ] [ /SAFE_A | /SAFE_B | /SAFE_C | /SAFE_UD1 | /SAFE_UD2 | /SAFE_UD3 | /SAFE_UD4 | /SAFE_UD5 ] [ /SEC_C | /SEC_S | /SEC_U | /SEC_UD1 | /SEC_UD2 | /SEC_UD3 | /SEC_UD4 | /SEC_UD5 ] ; |
|
|
<code> |
String used as code for the security category definition. |
|
/DESC |
Description string. |
|
/DENS |
Density. Value given as kg/m3. |
|
/STRUC |
Structural allowance. Given value shall be between 0 and 1. |
|
/PERM |
Permeability. Given value shall be between 0 and 1. |
All other attributes are explained above under relevant statements.