The reference data for the Compartmentation task is divided into the following areas:
-
Catalog parts, such as compartments, ship zones, load cases, cargo types, interference zones, regions, and so forth.
-
Rules for custom calculations and for naming.
-
Custom interfaces and attributes.
-
Labels and reports for compartments and loads.
-
Codelists, which define attribute values.
Each type of reference data for the Compartmentation task has a different set of related reference data files:
Creates and names Compartments in the model
Visual Basic Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule\CompartMergeSpltRule.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\CompartmentNamingRules.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\CompartRules.vbp (3 classes)
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\Compartments.xls
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\CompartmentCodeLists.xls
Visual Basic Symbols: [Reference Data Folder]\SymbolIcons (Place Volume Along Path command)
API: VolumeQueryServices.dll, VolumeAttributeHelper.dll
.NET Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\NamingRules.sln (9 classes)
Creates and names Interference Zones in the model
Visual Basic Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule\CompartMergeSpltRule.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\CompartmentNamingRules.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\CompartRules.vbp (3 classes)
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZones.xls
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZoneCodeLists.xls
Visual Basic Symbols: [Reference Data Folder]\SymbolIcons (Place Volume Along Path command)
API: VolumeQueryServices.dll, VolumeAttributeHelper.dll
.NET Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\NamingRules.sln (9 classes)
Creates and names Regions in the model
Visual Basic Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplitRule\CompartMergeSpltRule.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\CompartSemantics.vbp (6 classes)
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\CompartmentNamingRules.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\CompartRules.vbp (3 classes)
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\Regions.xls
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\RegionCodeLists.xls
Visual Basic Symbols: [Reference Data Folder]\SymbolIcons (Place Volume Along Path command)
API: VolumeQueryServices.dll, VolumeAttributeHelper.dll
.NET Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\NamingRules.sln (9 classes)
Creates and names Loads and Load Combinations in the model
Visual Basic Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute\CustomLoad.vbp (2 classes)
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming\LoadNamingRules.vbp (2 classes)
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming\LoadCombRules.vbp
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\SpatialLoad\FilterRule\SpatialFilter.vbp
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\Compartments.xls
API: VolumeQueryServices.dll, VolumeAttributeHelper.dll
.NET Rules:
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules\NamingRules.sln (9 classes)
Defines codelist values used by Compartmentation
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\CompartmentCodeLists.xls
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZoneCodeLists.xls
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\RegionCodeLists.xls