You are on page 1of 46

Compartmentation

Reference Data Guide

Version 2016 (11.0)


November 2016
Copyright
Copyright © 2004-2016 Intergraph® Corporation. All Rights Reserved. Intergraph is part of Hexagon.
Including software, file formats, and audiovisual displays; may be used pursuant to applicable software license agreement; contains
confidential and proprietary information of Intergraph and/or third parties which is protected by copyright law, trade secret law, and
international treaty, and may not be provided or otherwise made available without proper authorization from Intergraph Corporation.
Portions of this software are owned by Spatial Corp. © 1986-2016. All Rights Reserved.
Portions of the user interface are copyright © 2012-2016 Telerik AD.

U.S. Government Restricted Rights Legend


Use, duplication, or disclosure by the government is subject to restrictions as set forth below. For civilian agencies: This was
developed at private expense and is "restricted computer software" submitted with restricted rights in accordance with
subparagraphs (a) through (d) of the Commercial Computer Software - Restricted Rights clause at 52.227-19 of the Federal
Acquisition Regulations ("FAR") and its successors, and is unpublished and all rights are reserved under the copyright laws of the
United States. For units of the Department of Defense ("DoD"): This is "commercial computer software" as defined at DFARS
252.227-7014 and the rights of the Government are as specified at DFARS 227.7202-3.
Unpublished - rights reserved under the copyright laws of the United States.
Intergraph Corporation
305 Intergraph Way
Madison, AL 35758

Documentation
Documentation shall mean, whether in electronic or printed form, User's Guides, Installation Guides, Reference Guides,
Administrator's Guides, Customization Guides, Programmer's Guides, Configuration Guides and Help Guides delivered with a
particular software product.

Other Documentation
Other Documentation shall mean, whether in electronic or printed form and delivered with software or on Intergraph Smart Support,
SharePoint, or box.net, any documentation related to work processes, workflows, and best practices that is provided by Intergraph
as guidance for using a software product.

Terms of Use
a. Use of a software product and Documentation is subject to the End User License Agreement ("EULA") delivered with the
software product unless the Licensee has a valid signed license for this software product with Intergraph Corporation. If the
Licensee has a valid signed license for this software product with Intergraph Corporation, the valid signed license shall take
precedence and govern the use of this software product and Documentation. Subject to the terms contained within the
applicable license agreement, Intergraph Corporation gives Licensee permission to print a reasonable number of copies of the
Documentation as defined in the applicable license agreement and delivered with the software product for Licensee's internal,
non-commercial use. The Documentation may not be printed for resale or redistribution.
b. For use of Documentation or Other Documentation where end user does not receive a EULA or does not have a valid license
agreement with Intergraph, Intergraph grants the Licensee a non-exclusive license to use the Documentation or Other
Documentation for Licensee’s internal non-commercial use. Intergraph Corporation gives Licensee permission to print a
reasonable number of copies of Other Documentation for Licensee’s internal, non-commercial use. The Other Documentation
may not be printed for resale or redistribution. This license contained in this subsection b) may be terminated at any time and
for any reason by Intergraph Corporation by giving written notice to Licensee.

Disclaimer of Warranties
Except for any express warranties as may be stated in the EULA or separate license or separate terms and conditions, Intergraph
Corporation disclaims any and all express or implied warranties including, but not limited to the implied warranties of merchantability
and fitness for a particular purpose and nothing stated in, or implied by, this document or its contents shall be considered or deemed
a modification or amendment of such disclaimer. Intergraph believes the information in this publication is accurate as of its
publication date.
The information and the software discussed in this document are subject to change without notice and are subject to applicable
technical product descriptions. Intergraph Corporation is not responsible for any error that may appear in this document.

Compartmentation Reference Data Guide 2


The software, Documentation and Other Documentation discussed in this document are furnished under a license and may be used
or copied only in accordance with the terms of this license. THE USER OF THE SOFTWARE IS EXPECTED TO MAKE THE FINAL
EVALUATION AS TO THE USEFULNESS OF THE SOFTWARE IN HIS OWN ENVIRONMENT.
Intergraph is not responsible for the accuracy of delivered data including, but not limited to, catalog, reference and symbol data.
Users should verify for themselves that the data is accurate and suitable for their project work.

Limitation of Damages
IN NO EVENT WILL INTERGRAPH CORPORATION BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL INCIDENTAL,
SPECIAL, OR PUNITIVE DAMAGES, INCLUDING BUT NOT LIMITED TO, LOSS OF USE OR PRODUCTION, LOSS OF
REVENUE OR PROFIT, LOSS OF DATA, OR CLAIMS OF THIRD PARTIES, EVEN IF INTERGRAPH CORPORATION HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
UNDER NO CIRCUMSTANCES SHALL INTERGRAPH CORPORATION’S LIABILITY EXCEED THE AMOUNT THAT
INTERGRAPH CORPORATION HAS BEEN PAID BY LICENSEE UNDER THIS AGREEMENT AT THE TIME THE CLAIM IS
MADE. EXCEPT WHERE PROHIBITED BY APPLICABLE LAW, NO CLAIM, REGARDLESS OF FORM, ARISING OUT OF OR IN
CONNECTION WITH THE SUBJECT MATTER OF THIS DOCUMENT MAY BE BROUGHT BY LICENSEE MORE THAN TWO (2)
YEARS AFTER THE EVENT GIVING RISE TO THE CAUSE OF ACTION HAS OCCURRED.
IF UNDER THE LAW RULED APPLICABLE ANY PART OF THIS SECTION IS INVALID, THEN INTERGRAPH LIMITS ITS
LIABILITY TO THE MAXIMUM EXTENT ALLOWED BY SAID LAW.

Export Controls
Intergraph Corporation’s software products and any third-party Software Products obtained from Intergraph Corporation, its
subsidiaries, or distributors (including any Documentation, Other Documentation or technical data related to these products) are
subject to the export control laws and regulations of the United States. Diversion contrary to U.S. law is prohibited. These Software
Products, and the direct product thereof, must not be exported or re-exported, directly or indirectly (including via remote access)
under the following circumstances:
a. To Cuba, Iran, North Korea, Sudan, or Syria, or any national of these countries.
b. To any person or entity listed on any U.S. government denial list, including but not limited to, the U.S. Department of Commerce
Denied Persons, Entities, and Unverified Lists, http://www.bis.doc.gov/complianceandenforcement/liststocheck.htm, the U.S.
Department of Treasury Specially Designated Nationals List, http://www.treas.gov/offices/enforcement/ofac/, and the U.S.
Department of State Debarred List, http://www.pmddtc.state.gov/compliance/debar.html.
c. To any entity when Licensee knows, or has reason to know, the end use of the Software Product is related to the design,
development, production, or use of missiles, chemical, biological, or nuclear weapons, or other un-safeguarded or sensitive
nuclear uses.
d. To any entity when Licensee knows, or has reason to know, that an illegal reshipment will take place.
Any questions regarding export or re-export of these Software Products should be addressed to Intergraph Corporation’s Export
Compliance Department, Huntsville, Alabama 35894, USA.

Trademarks
Intergraph, the Intergraph logo, PDS, SmartPlant, FrameWorks, I-Sketch, SmartMarine, IntelliShip, ISOGEN, SmartSketch,
SPOOLGEN, SupportManager, SupportModeler, Sapphire, and Intergraph Smart are trademarks or registered trademarks of
Intergraph Corporation or its subsidiaries in the United States and other countries. Hexagon and the Hexagon logo are registered
trademarks of Hexagon AB or its subsidiaries. Microsoft and Windows are registered trademarks of Microsoft Corporation. ACIS is a
registered trademark of SPATIAL TECHNOLOGY, INC. Infragistics, Presentation Layer Framework, ActiveTreeView Ctrl,
ProtoViewCtl, ActiveThreed Ctrl, ActiveListBar Ctrl, ActiveSplitter, ActiveToolbars Ctrl, ActiveToolbars Plus Ctrl, and ProtoView are
trademarks of Infragistics, Inc. Incorporates portions of 2D DCM, 3D DCM, and HLM by Siemens Product Lifecycle Management
Software III (GB) Ltd. All rights reserved. Gigasoft is a registered trademark, and ProEssentials a trademark of Gigasoft, Inc.
VideoSoft and VXFlexGrid are either registered trademarks or trademarks of ComponentOne LLC 1991-2013, All rights reserved.
Oracle, JD Edwards, PeopleSoft, and Retek are registered trademarks of Oracle Corporation and/or its affiliates. Tribon is a
trademark of AVEVA Group plc. Alma and act/cut are trademarks of the Alma company. Other brands and product names are
trademarks of their respective owners.

Compartmentation Reference Data Guide 3


Contents
Preface .......................................................................................................................................................... 7

What's New in Compartmentation Reference Data .................................................................................. 7

Compartmentation Reference Data ........................................................................................................... 8


Understanding the Compartmentation Reference Data Workflow........................................................ 10
Compartmentation Reference Data Common Tasks ..................................................................... 13
Move custom .dlls to SharedContent folder ................................................................................... 14

Compartmentation Part Classes and Load Case Types ........................................................................ 16


Compartmentation Part Classes ........................................................................................................... 16
BulkCargoType ............................................................................................................................... 16
CmpartZoneCPS ............................................................................................................................ 17
CmpartZoneDamageControl .......................................................................................................... 17
CmpartZoneFire ............................................................................................................................. 18
CmpartZonePlanning...................................................................................................................... 18
CompartmentCargo ........................................................................................................................ 18
CompartmentHabitable................................................................................................................... 19
CompartmentMachinery ................................................................................................................. 19
CompartmentTank .......................................................................................................................... 20
CompartmentUnknown ................................................................................................................... 20
CompartmentVoid........................................................................................................................... 21
GaseousCargoType ....................................................................................................................... 21
LiquidCargoType ............................................................................................................................ 22
LoadCaseType ............................................................................................................................... 23
UnitCargoType ............................................................................................................................... 23
VoidSpace ...................................................................................................................................... 23
Compartmentation Load Case and Cargo Types ................................................................................. 24
Compartmentation Cargo Rules ........................................................................................................... 24
CompartmentCargoRule ................................................................................................................ 24

Interference Zones .................................................................................................................................... 25


Interference Zone Type Sheet .............................................................................................................. 25

Regions....................................................................................................................................................... 26
Region Corrosion Sheet ........................................................................................................................ 26

Compartmentation Symbols .................................................................................................................... 27

Compartmentation Generic Services ...................................................................................................... 30


Compart Split Rule Sheet ..................................................................................................................... 30
Compartment Custom Attribute Sheet .................................................................................................. 31
Custom Class Interface List Sheet........................................................................................................ 31

Compartmentation Reference Data Guide 4


Contents

Naming Rules Sheet ............................................................................................................................. 32


Naming Rules ................................................................................................................................. 32

Compartmentation Labels and Reports .................................................................................................. 34

Compartmentation Codelists ................................................................................................................... 37


Compart Coating Color Codelist ........................................................................................................... 38
Compart Coating Process Codelist ....................................................................................................... 38
Compart Coating Responsibility Codelist ............................................................................................. 38
Compart Coating Status Codelist.......................................................................................................... 38
Compart Coating Type Codelist ............................................................................................................ 38
Compartment Authorization Class Codelist .......................................................................................... 38
Compartment Bulk Cargo Type Codelist .............................................................................................. 38
Compartment Bulkhead Tightness Codelist ......................................................................................... 39
Compartment Capacity Context Codelist .............................................................................................. 39
Compartment Cargo Context Codelist .................................................................................................. 39
Compartment Coating Applicability Codelist ......................................................................................... 39
Compartment Coating Certification Codelist ......................................................................................... 39
Compartment Coating Inspection Codelist ........................................................................................... 39
Compartment Compartment Group Codelist ........................................................................................ 39
Compartment Compartment Type Codelist .......................................................................................... 39
Compartment Contact Material Type Codelist ...................................................................................... 39
Compartment Damage Location Codelist ............................................................................................. 40
Compartment Damage Type Codelist .................................................................................................. 40
Compartment Design Requirement Codelist ........................................................................................ 40
Compartment Function Type Codelist .................................................................................................. 40
Compartment Insulation Category Codelist .......................................................................................... 40
Compartment Naval Nuclear Class Codelist ........................................................................................ 40
Compartment Naval Safety Category Codelist ..................................................................................... 40
Compartment Naval Security Class Codelist ........................................................................................ 40
Compartment Noise Category Codelist ................................................................................................ 40
Compartment Positional Rel Type Codelist .......................................................................................... 41
Compartment Property Context Codelist .............................................................................................. 41
Compartment Relevant Cargos Codelist .............................................................................................. 41
Compartment Structure Type Codelist ................................................................................................. 41
Compartment Surface Preparation Codelist ......................................................................................... 41
Load Case Liquid Pressure Codelist .................................................................................................... 41
Load Case Sea Pressure Codelist ........................................................................................................ 41
Ship Design Loading Condition Type Codelist ..................................................................................... 41
Space Access Type Codelist ................................................................................................................ 42
Space Adjacency Contact Type Codelist .............................................................................................. 42
Space Adjacency Geometry Type Codelist .......................................................................................... 42
Space Arrangement Orientation Codelist ............................................................................................. 42
Space Arrangement Type Codelist ....................................................................................................... 42
Space Item Purpose Codelist ............................................................................................................... 42
Space Physical Orientation Type Codelist ............................................................................................ 42
Space Positional Relationship Type Codelist ....................................................................................... 42
Space Product Structure Type Codelist ................................................................................................ 42

Compartmentation Reference Data Guide 5


Contents

Interference Zones Codelists ................................................................................................................... 43


Interference Type Codelist .................................................................................................................... 43

Regions Codelists ..................................................................................................................................... 44


Region Ship Type Codelist ................................................................................................................... 44
Region Type Codelist ............................................................................................................................ 44

Index ........................................................................................................................................................... 45

Compartmentation Reference Data Guide 6


Preface
This document is a reference data guide for the Intergraph SmartTM 3D Compartmentation task.
The purpose of this document is to describe the reference data delivered with the software for
this task.
Reference data includes both catalog data and specification data. Catalog data includes the
parts that you place in the model, such as piping components and equipment. Specification data
includes the rules that govern how those parts are placed and connected.

Documentation Comments
For the latest support information for this product, comments or suggestions about this
documentation, and documentation updates for supported software versions, please visit
Intergraph Smart Support (https://smartsupport.intergraph.com).

What's New in Compartmentation Reference Data


The following changes have been made to the Compartmentation reference data.
Version 2016 (11.0)
 No changes were made for this release of the software.

Compartmentation Reference Data Guide 7


SECTION 1

Compartmentation Reference Data


Each organization using the Intergraph SmartTM 3D requires customized reference data such as
rules, catalog items, and symbols to meet their exact needs. Customized rules control how and
when the catalog items and symbols are used in the model.
Before working with compartmentation reference data, you must be familiar with how the
software handles reference data in general. If you have not already done so, read and
understand the following important concepts and procedures described in the Smart 3D
Reference Data Guide:
 Bulkloading
 Excel reference data workbooks
 Custom interfaces and attributes
 Naming rules and other types of rules
 Symbols
 Codelists (also referred to as "select lists")
This reference data guide describes the example compartmentation reference data delivered
with the software. Microsoft Excel workbooks are delivered for bulkloading items into the
Catalog. Visual Studio source code files are delivered for the rules.

Compartmentation Workbooks
The Compartmentation reference data is defined in multiple workbooks, delivered to the
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles folder:
 CompartGenericServices.xls
 CompartLabels.xls
 CompartmentCodeLists.xls
 Compartments.xls
 CompartReports.xls
 InterferenceZoneCodeLists.xls
 InterferenceZones.xls
 RegionCodeLists.xls
 Regions.xls

Compartmentation Symbols
Volumes in the Compartmentation task are not represented by 3D symbols, so you do not need
to be concerned with 3D symbol creation and definition.
However, the Compartmentation task does use 2D symbols in the Place Volume Along Path
command, when you specify a cross section. These symbols are defined in Visual Basic source

Compartmentation Reference Data Guide 8


Compartmentation Reference Data

code, delivered to the [Reference Data


Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes folder. The files in this
folder are not used by Compartmentation. This project is for reference and can be used for
customization purposes.
For more information about symbols, see the 2D Symbols Reference Data Guide.

Compartmentation Rules
The Compartmentation rules are defined in Visual Basic source code, delivered to the
[Programming Resources Folder]\Programming\ExampleCode\Compartmentation\Rules folder.
 Compartment rules: CompartMergeSplitRule, CustomCompute, and Naming
 General load rules: CustomCompute, Naming
 General volume rules: CompartAttributeHelper, Naming
 Load combination rules: Naming
 Region rules: CustomCompute
 Spatial load rules: FilterRule

Compartmentation Application Programming Interface


An application programming interface (API), CompartQueryServices.dll, is provided in the
software for common objects, methods, and properties used in the Compartmentation query
service custom command. For more information, see the Compartmentation Query Services
Customization documentation, which also describes the Compartmentation Attribute Helper and
Compartmentation Geometry Service Object. This documentation is available as part of the
programming reference documentation.
See Also
Compartmentation Part Classes and Load Case Types (on page 16)
Compartmentation Generic Services (on page 30)
Compartmentation Codelists (on page 37)

Compartmentation Reference Data Guide 9


Compartmentation Reference Data

Understanding the Compartmentation Reference Data


Workflow
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\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls,
CompartmentCodeLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Compartmentation Reference Data Guide 10


Compartmentation Reference Data

Creates and names interference zones in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook:
[Product Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\InterferenceZones.xls
[Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\InterferenceZoneCod
eLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Creates and names regions in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule\CompartMergeSpltRule.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute\C
ompartSemantics.vbp (6 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming\Compartm
entNamingRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\CompartAttribute
Helper\CompartHelper.vbp (4 classes)

Compartmentation Reference Data Guide 11


Compartmentation Reference Data

[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralVolume\Naming\Compart
Rules.vbp (3 classes)
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Regions.xls,
RegionCodeLists.xls
Visual Basic Symbols: [Reference Data
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes (Place Volume Along Path
command)
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Creates and names loads and load combinations in the model


Visual Basic Rules:
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute\C
ustomLoad.vbp (2 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming\LoadNamin
gRules.vbp (2 classes)
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming\LoadC
ombRules.vbp
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\SpatialLoad\FilterRule\SpatialFilte
r.vbp
Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\Compartments.xls
API: CompartQueryServices.dll, CompartAttributeHelper.dll

Defines codelist values used by Compartmentation


Bulkload Workbook: [Product
Folder]\ShipCatalogData\BulkLoad\DataFiles\Compartmentation\DataFiles\CompartmentCodeLi
sts.xls, InterferenceZoneCodeLists.xls, RegionCodeLists.xls
See Also
Compartmentation Reference Data Common Tasks (on page 13)

Compartmentation Reference Data Guide 12


Compartmentation Reference Data

Compartmentation Reference Data Common Tasks


By following these tasks, you can create and customize your own compartmentation reference
data.

Define Compartmentation Part Classes


In addition to the compartment classes that are delivered with the software, you can add classes
to the catalog. For more information, see Compartmentation Part Classes (on page 16).

Define Compartmentation Load Case Types and Cargo Types


In addition to the load case and cargo types that are delivered with the software, you can add
types to the catalog. For more information, see Compartmentation Load Case and Cargo Types
(on page 24). You can also define cargo rules, which define the load on a compartment based
on the cargo the compartment is holding.

Define Interference Zones and Regions


In addition to the interference zones and regions that are delivered with the software, you can
add types to the catalog. For more information, see Interference Zones (on page 25) and
Regions (on page 26).

Define Compartmentation Rules and Custom Attributes


You can define rules and custom attributes for compartmentation. For more information, see
Compartmentation Generic Services (on page 30).

Define Compartmentation Labels and Reports


You can define labels and reports that show the attributes for compartments and loads. For
more information, see Compartmentation Labels and Reports (on page 34).

Define Compartmentation Codelists


Codelists, also known as select lists, are useful when attributes can have one of many values.
You can define compartmentation-specific codelists. For more information, see
Compartmentation Codelists (on page 37), Interference Zones Codelists (on page 43), and
Regions Codelists (on page 44).
See Also
Understanding the Compartmentation Reference Data Workflow (on page 10)

Compartmentation Reference Data Guide 13


Compartmentation Reference Data

Move custom .dlls to SharedContent folder


You must save custom .dlls, including delivered .dlls that you have modified, in the [Reference
Data Folder]\SharedContent\Custom Symbols folder on a central reference data server.
Use the following workflow to copy your customized .dlls.
1. Recompile each project in a Version 2016 (11.0) client installation.
2. Copy the new .dlls to the [Reference Data Folder]\SharedContent\Custom Symbols folder.

 You can create hierarchy folders as needed under the Custom Symbols folder.
 If a custom .dll has a localizer .dll, both files must be located in the same folder.
 .dlls ending with "–Ref..dll" or "_Ref..dll" are treated as reference .dlls and are ignored.
Do not copy these .dlls from the client machine containing the Visual Basic source code.
3. Run Tools > Update Custom Symbol Configuration.
Create or update the custom symbol configuration file

 Whenever a symbol or naming rule class is accessed, the software searches for the .dll as
follows:
a. The software checks for the ProgID entry in the xml files. If an entry exists, then the
corresponding .dll is loaded, and an instance of the class is created.
b. If an entry does not exist, the software searches previously registered .dlls on the local
computer.
c. If any entry is not found for the ProgID in either .xml file, and the .dll is also not
registered on the local machine, the software returns an error. In this case, you should
copy the .dll to the [Reference Data Folder]\SharedContent\Custom Symbols folder and
run Update Custom Symbol Configuration in Project Management.
If a ProgID entry exists in the .xml files, that .dll is used even though another or the same
copy of the .dll is registered on the local machine. The order of priority when creating an
instance of an object is: CustomSymbolConfig.xml, SystemSymbolConfig.xml, and then the
registry.
 When you add a new custom .dll to the [Reference Data Folder]\SharedContent\Custom
Symbols folder or modify an existing custom .dll, you must re-run Update Custom Symbol
Configuration in Project Management.
 If a Visual Basic 6 component uses helper classes, and the helper classes are instantiated
by calling CreateObject, you must replace CreateObject. If the helper class is in the
same project, then replace it with new. If the helper class is in a different project, then
replace it with SP3DCreateObject. SP3DCreateObject tries to instantiate the object
using the information in .xml files. If the software does not find an entry in .xml files for the
given ProgID, then it calls CreateObject, and implements SP3DCreateObject in the
[Product Folder]\Core\Runtime\SP3DCoCreateInstance..dll. When SP3DCreateObject
needs to be used, [Product Folder]\Core\Runtime\SP3DCoCreateInstance.dll needs to be
referenced in the Visual Basic project. Example usage of SP3DCreateObject is shown
below:
Set oHelperObject = SP3DCreateObject(strHelperProgId)

Compartmentation Reference Data Guide 14


Compartmentation Reference Data

 If the Visual Basic 6 symbol class has any public structures or types, they should be made
private. For example:
Public Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
uomValue As Double
End Type
Should be changed to:
Private Type InputType
Name As String
Description As String
Properties As IMSDescriptionProperties
uomValue As Double
End Type
 Debugging and maintaining Visual Basic project references, reference .dlls, and binary
compatibility are beyond the scope of this document. Contact your Intergraph Support
representative if you have questions.

Compartmentation Reference Data Guide 15


SECTION 2

Compartmentation Part Classes and


Load Case Types
The Compartments.xls workbook contains worksheets that define all of the compartment part
classes, void spaces, load case types, and cargo types that are available in the catalog. In
addition, this workbook contains load rules for different types of cargo.
You can add new data to the workbook, or you can modify or delete the data already there. After
making changes, you must bulk load to see the changes reflected in the software.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)
Compartmentation Part Classes (on page 16)
Compartmentation Part Classes and Load Case Types (on page 16)
Compartmentation Load Case and Cargo Types (on page 24)

Compartmentation Part Classes


The delivered compartmentation reference data includes compartment tanks, unknown and void
compartments, habitable compartments, compartments for cargo and machinery, and ship
zones for planning, fire, and damage control.
In addition, void spaces are provided. These volumes set aside space reservation in a model.
Compartments, void spaces, ship zones, interference zones, and regions are not
represented by 3D symbols, so you do not need to be concerned with 3D symbol creation and
definition. You can type NULL in this field or leave it blank.
See Also
Compartmentation Part Classes and Load Case Types (on page 16)

BulkCargoType
Defines bulk cargo types.
The Head section contains the following parameters (listed in alphabetical order):
 actual_angle_of_repose - Actual angle subtended with the horizontal by the upper surface
of the conic pile, made by the cargo type when loaded into a hold.
 BreadthofHatch - Inside breadth of the hatch.
 Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e.

Compartmentation Reference Data Guide 16


Compartmentation Part Classes and Load Case Types

 Description - Part description.


 DesignBulkCargoMassMh - Homogenous load in all cargo hold (load dependent input).
 DesignBulkCargoMassMhd - Alternate load in all cargo holds (load dependent input).
 LengthOfHatch - Inside length of hatch.
 Mass - Mass of the load that is supposed to be carried in the compartment.
 Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
 natural_angle_of_repose - Angle that forms between the horizontal at the top of a pile of
unconsolidated material, and the sides.
 permeability - Measure of how easily fluid (e.g., water) can pass through a porous medium.
 ReducedVolume - Used in FEA 1A1 bulk vessels. Volume of bulk load (Rules gives filling
height: calculate volume of load).
 stowage_factor - Specifies the stowage factor for the cargo.
 TopOfHatch - Top of hatch.
 trimmed - Natural pile of cargo type that has been flattened and spread out to fill the
compartment.
 volume - Volume of compartment.

CmpartZoneCPS
The Head section contains the following parameters (listed in alphabetical order):
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.

CmpartZoneDamageControl
Defines ship zones for damage control.
The Head section contains the following parameters (listed in alphabetical order):
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.

Compartmentation Reference Data Guide 17


Compartmentation Part Classes and Load Case Types

 SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data]\SharedContent folder.

CmpartZoneFire
Defines ship fire zones.
The Head section contains the following parameters (listed in alphabetical order):
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RiskFactor - Risk factor associated with the part.
 SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.

CmpartZonePlanning
Defines ship zones for planning.
The Head section contains the following parameters:
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 PartDescription - Part description.
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Product Folder]\SharedContent folder.
 Classification - Classification for the part.

CompartmentCargo
Defines various cargo compartments.
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.

Compartmentation Reference Data Guide 18


Compartmentation Part Classes and Load Case Types

 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

CompartmentHabitable
Defines living space compartments.
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

CompartmentMachinery
Defines compartments for machinery.
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.

Compartmentation Reference Data Guide 19


Compartmentation Part Classes and Load Case Types

 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

CompartmentTank
Defines compartment tank specifications.
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

CompartmentUnknown
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.

Compartmentation Reference Data Guide 20


Compartmentation Part Classes and Load Case Types

 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

CompartmentVoid
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentGroup - Groups available for compartments.
 CompartmentNumber - Manufacturers and model numbers for compartments.
 CompartmentType - Types of compartments.
 functionType - Types of functions for compartments.
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 RelevantCargos - Cargo types available for compartments.
 structureType - Types of structure for compartments.
SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are delivered
to the [Reference Data Product Folder]\SharedContent folder.

GaseousCargoType
Defines cargo types for gases.
The Head section contains the following parameters (listed in alphabetical order):
 Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
 density - Thickness of a material (mass per unit volume).
 Description - Part description.

Compartmentation Reference Data Guide 21


Compartmentation Part Classes and Load Case Types

 expansion_coefficient - Measurement of swelling or expansion of a composite material


due to temperature changes or moisture absorption
 Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
 OverPressure - Overpressure setting. Min according to rule.
 required_carriage_pressure - Required pressure to keep the gas in a liquid state.
 specific_heat_capacity - Amount of energy required to raise the temperature of a kilogram
of a material by 1 degree Centigrade.
 thermal_conductivity - Rate at which a material conducts heat.
 viscosity - Measured resistance to flow.

LiquidCargoType
Defines cargo types for liquids.
The Head section contains the following parameters (listed in alphabetical order):
 Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
 density - Thickness of a material (mass per unit volume).
 Description - Part description.
 expansion_coefficient - Measurement of swelling or expansion of a composite material
due to temperature changes or moisture absorption.
 FreeSurfaceCenter - Free surface center.
 Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
 OverPressure - Overpressure setting. Min according to rule.
 required_carriage_pressure - Required pressure to keep the gas in a liquid state.
 SloshingBreadth - Rule dependent definition.
 SloshingLength - Rule dependent definition.
 specific_heat_capacity - Amount of energy required to raise the temperature of a kilogram
of a material by 1 degree Centigrade.
 TankHoldNumber – Tank Hold number. Tank number starts in the forship: Fore tank: 1->.
 thermal_conductivity - Rate at which a material conducts heat.
 TopOfAirPipe - Top of air pipe.
 viscosity - Measured resistance to flow.

Compartmentation Reference Data Guide 22


Compartmentation Part Classes and Load Case Types

LoadCaseType
Defines the type of cargo load.
The Head section contains the following parameters (listed in alphabetical order):
 Description - Part description.
 LiquidPressure - Fluid pressure per unit area.
 Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
 SeaPressure - Pressure at sea level.

UnitCargoType
The Head section contains the following parameters (listed in alphabetical order):
 Custom Program - Custom program for the cargo type, if needed. The Visual Basic source
code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomComput
e folder.
 Description - Part description.
 Name - Part name as it appears in the Catalog task. This identification must be unique
across the entire catalog.
 permeability - Measure of how easily fluid (e.g., water) can pass through a porous medium.
 stack_limit - Maximum number of this type of material that can be stacked on top of each
other.
 stowage_factor - Ratio of weight to stowage space required under normal conditions.
 volume - Volume of compartment.
 weight - Weight of the compartment.

VoidSpace
Defines volumes set aside for space reservation in a model.
The Head section contains the following parameters (listed in alphabetical order):
 MirrorBehaviorOption - Mirror behavior option code for the part. Valid codes are listed in
the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
 PartDescription - Part description.
 PartNumber - Part number or name as it appears in the Catalog task. This identification
must be unique across the entire catalog.
 SymbolDefinition - 2D symbol file associated with the part. You can specify a symbol file
different from the SymbolDefinition in the Definition section. The 2D symbol files are
delivered to the [Reference Data Folder]\SharedContent folder.

Compartmentation Reference Data Guide 23


Compartmentation Part Classes and Load Case Types

Compartmentation Load Case and Cargo Types


The delivered compartmentation reference data includes load case types and cargo types for
gases, liquids, and other materials.
Below is a complete listing of all the properties, both common and unique, that you will see on a
load case or cargo type sheet. Occurrence properties are not listed.

Common Properties
These properties appear for the load case and cargo type classes. The properties are listed
here in the order that they appear, from left to right, on the part sheet.
Name - Type the unique identification for the part as found in the catalog data.
Description - Type a description for the part.

Unique Properties
Unique properties appear only for certain classes.
Custom Program - Type a custom program for the cargo type, if necessary. The Visual Basic
source code for the load custom programs (rules) is delivered in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\CustomCompute
folder.
See Also
Compartmentation Part Classes and Load Case Types (on page 16)

Compartmentation Cargo Rules


The delivered compartmentation reference data includes cargo rules that can define the load on
a compartment based on the type of cargo the compartment is holding.
Below is a complete listing of all the properties, both common and unique, that you will see on
the cargo rules sheet. Occurrence properties are not listed.
The properties are listed here in the order that they appear, from left to right, on the part sheet.
Rule Name - Type the name for the rule.
Compartment Object - Specify the type of compartment object, such as CompartmentTank.
Load Type - Specify the type of load, such as GaseousCargoType.

CompartmentCargoRule
Defines the load on a compartment based on the type of cargo the compartment is holding.
The Head section contains the following parameters (listed in alphabetical order):
 CompartmentObject - Type of compartment object, such as a CompartmentTank.
 LoadType - Type of load, such as a GaseousCargoType.
 RuleName - Rule name as it appears in the Catalog task.

Compartmentation Reference Data Guide 24


SECTION 3

Interference Zones
The InterferenceZones.xls workbook defines the zones available for interferences in the
model. These zones are similar to interference volumes, but include the ability to construct ACIS
geometry. An example of when to use an interference zone is when you want an evacuation
path that must remain clear.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)
Interference Zone Type Sheet (on page 25)

Interference Zone Type Sheet


The Interference Zone Type sheet in the InterferenceZones.xls workbook defines the
interference zones for compartmentation.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the Smart 3D Reference Data Guide, available from the Help >
Printable Guides command.
Part Number - Type the unique identification for the part as found in the catalog data.
Part Description - Type a description for the part.
Mirror Behavior Option - Type the mirror behavior option code for the part. Valid codes are
listed in the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
Symbol Definition - Type the symbol definition for the part.
Compartments are not represented by symbols, so you do not need to be concerned
with symbol creation and definition. You can type NULL in this field or leave it blank.
Type - Type a code for the type of interference zone. Valid codes are listed in the
InterferenceZoneCodeLists.xls workbook on the Interference Type sheet in the Codelist
Number column.
The Type attribute is an occurrence attribute, denoted by oa: in the Definition section of the
worksheet.
See Also
Interference Zones (on page 25)

Compartmentation Reference Data Guide 25


SECTION 4

Regions
The Regions.xls workbook defines the regions that are available for placement in the model.
These regions support custom analysis rules that can be used to apply corrosion factors or other
rules during data extraction for analysis.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)
Region Corrosion Sheet (on page 26)

Region Corrosion Sheet


The Region Corrosion sheet in the Regions.xls workbook defines the types of regions for
compartmentation.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the Smart 3D Reference Data Guide, available from the Help >
Printable Guides command.
Part Number - Type the unique identification for the part as found in the catalog data.
Part Description - Type a description for the part.
Mirror Behavior Option - Type the mirror behavior option code for the part. Valid codes are
listed in the AllCodeLists.xls workbook on the Mirror Behavior Option sheet in the Codelist
Number column.
Symbol Definition - Type the symbol definition for the part.
Compartments are not represented by symbols, so you do not need to be concerned
with symbol creation and definition. You can type NULL in this field or leave it blank.
The following three attributes are occurrence attributes, denoted by oa: in the Definition section
of this worksheet.
Ship Type - Type a code for the type of ship. Valid codes are listed in the RegionCodeLists.xls
workbook on the Region Ship Type sheet in the Codelist Number column.
Region Type - Type a code for the type of region. Valid codes are listed in the
RegionCodeLists.xls workbook on the Region Type sheet in the Codelist Number column.
Corrosion Rule - Displays a code for the corrosion rule associated with this region. This value
is defined internally by the software. Do not modify.
See Also
Regions (on page 26)

Compartmentation Reference Data Guide 26


SECTION 5

Compartmentation Symbols
Compartment volumes, ship zones, interference zones, and regions are not represented by 3D
symbols, so you do not need to be concerned with 3D symbol creation and definition.
However, the Compartmentation task does use 2D symbols in the Place Volume Along Path
command, when you specify a cross section. These symbols are defined in Visual Basic source
code, delivered to the [Reference Data Product
Folder]\Compartmentation\Data\Symbols\Compartmentation\Shapes folder. The files in this
folder are not used by Compartmentation. This project is for reference and can be used for
customization purposes.
Delivered symbols include a circle, hexagon, oval, square, and so forth. Bitmaps are provided
on the Symbols share, in the SketchCrossSections folder.

Symbol Picture

Circle

Rectangle

Triangle

Compartmentation Reference Data Guide 27


Compartmentation Symbols

Ellipse

Hexagon

Sector

Road

TrapezoidR (right angle)

Compartmentation Reference Data Guide 28


Compartmentation Symbols

TrapezoidC (concentric)

I-Beam

See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)

Compartmentation Reference Data Guide 29


SECTION 6

Compartmentation Generic Services


The CompartGenericServices.xls workbook lists the compartmentation-specific custom
classes, interfaces, and attributes that you want in your catalog. This information is necessary
for the Update Attributes command in the Compartmentation task.
Using custom attributes, you have can control when attributes update and on which objects. You
can also specify the code that calculates the attribute values.
The CompartGenericServices.xls workbook also provides naming rules for compartments and
a rule to check whether compartments overlap.
For more information about custom classes, interfaces, and attributes, as well as naming rules,
see the Smart 3D Reference Data Guide, available from the Help > Printable Guides
command.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)

Compart Split Rule Sheet


The Compart Split Rule sheet in the CompartGenericServices.xls workbook provides a rule
that checks whether compartments overlap.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the Smart 3D Reference Data Guide, available from the Help >
Printable Guides command.
Name - Specifies a name for the rule. This name is solely for bulkloading purposes and does not
appear on the user interface of the software.
Attribute Name - Specifies a descriptive name for the rule. This name is more user-friendly and
can have spaces; this name appears on the Catalog task user interface.
Type - Specifies the type of query for the rule.
Subtype - Specifies the subtype of query for the rule.
Custom Program - Provides the name of a Visual Basic project and class that is used to
perform the calculation. The Visual Basic source code for this custom program (rule) is delivered
in [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CompartMergeSplit
Rule folder.
Query Order - Specifies the order in which the query runs.
See Also
Compartmentation Generic Services (on page 30)

Compartmentation Reference Data Guide 30


Compartmentation Generic Services

Compartment Custom Attribute Sheet


The Compartment Custom Attribute sheet in the CompartGenericServices.xls workbook
defines custom attributes for compartmentation. You use this information when running the
Update Attributes command in the Compartmentation task.
This topic describes the Head/Start/End section of the sheet. For information about the
Definition section, see the Smart 3D Reference Data Guide, available from the Help >
Printable Guides command.
Name - Specifies a name for the custom attribute. This name is solely for bulkloading purposes
and does not appear on the user interface of the software.
Attribute Name - Specifies a descriptive name for the attribute. This name is more user-friendly
and can have spaces; this name appears on the Catalog task user interface.
Rule Name - Specifies the rule associated with the attribute. This field is optional and can be left
blank.
Order - Allows you to use the previously calculated attribute values as a reference to process
the next set of attributes.
Custom Class - Specifies the name of the class associated with the attribute. This class is
listed on the Custom Class Interface List sheet in this workbook.
Virtual Interface - Specifies the name of the interface associated with the attribute. This
interface is listed on the Custom Class Interface List sheet in this workbook.
Custom Program - Provides the name of a Visual Basic project and class that is used to
calculate the attribute. The Visual Basic source code for these rules is delivered in
[Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\CustomCompute
(CompartSemantics) and [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Region\CustomCompute
(RegionSemantics).
Semantic Control - Controls when the custom code for the attribute is run.
 1 = Run during compute (for example, modification of object)
 2 = Run during commit (for example, creation of object)
 4 = Run by user request (Update Attributes command in software)
See Also
Compartmentation Generic Services (on page 30)

Custom Class Interface List Sheet


The Custom Class Interface List sheet in the CompartGenericServices.xls workbook maps
interfaces to compartmentation classes. You use this information when running the Update
Attributes command in the Compartmentation task.
Class Name - Lists the name of a non-virtual, system class. For example, type CCompartment.
Interface Name - Lists the name of a custom virtual interface.
See Also
Compartmentation Generic Services (on page 30)

Compartmentation Reference Data Guide 31


Compartmentation Generic Services

Naming Rules Sheet


The Naming Rules sheet in the CompartGenericServices.xls workbook lists the naming rules
for compartments.
TypeName - Specifies the internal class names of objects. The type names appear in the
Catalog hierarchy under the NamingRules folder.
Name - Specifies the rule name. You can use the same naming rule for more than one object
type. See Naming Rules (on page 32) for the conventions used by each of the
compartmentation naming rules.
SolverProgID - Lists the ProgID for the naming rule, using the format [project name].[class
name]. The Visual Basic source code for compartment naming rules is delivered in the following
folders:
 Compartments (frame rule) - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\Compartment\Naming
 Loads - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\GeneralLoad\Naming
 General Volumes - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Ruless\GeneralVolume\Naming
 Load Combinations - [Programming Resources
Folder]\Programming\ExampleCode\Compartmentation\Rules\LoadCombination\Naming
See Also
Compartmentation Generic Services (on page 30)

Naming Rules
The software provides several options for naming various types of compartmentation objects
that you can place in the model. In addition to the delivered sample naming rules that are
described below, you can create your own naming rules.
Part Description Rule - Names the object using the format:
[part description]-[global workshare location ID]-[index number]
The part description is the description from the SM3D reference data catalog for the
selected object. The global workshare location ID is the number assigned in the Project
Management task; and the index number is the object placement count. For example, the
name Wing tank-1-0001 represents the first object placed in the model at location 1.
Frame Rule - Names the objected based on the existing frame system within the site area.
From the frame system, the software checks the existing frame which is closest to the
compartment surface.
Space Rule - Names the object using the format:
[space folder name]-[global workshare location ID]-[index number]
The space folder name is the name of the currently-defined space folder you are using. The
global workshare location ID is the number assigned in the Project Management task, and the
index number is the object placement count. For example, the name Ship-1-0003 represents the
third object placed in the model in the Ship space folder at location 1.
Part Class Rule - Names the object using the format:

Compartmentation Reference Data Guide 32


Compartmentation Generic Services

[part class name]-[global workshare location ID]-[index number]


The part class name is the class or type from the SM3D reference data catalog containing the
selected object. The global workshare location ID is the number assigned in the Project
Management task; and the index number is the object placement count. For example, the name
ShipZoneClass-1-0001 represents the first Ship Zone class object placed in the model at
location 1. Compartmentation contains the Compartments, Interference Zones, Regions, Ship
Zone and Void Space classes.
User Defined - Enables you to define the name of the compartment. After selecting this naming
rule, type the name in the Name box of the Properties dialog box.

Compartmentation Reference Data Guide 33


SECTION 7

Compartmentation Labels and Reports


The Compartmentation reference data includes labels (tooltips) and reports.

Labels
The CompartLabels.xls workbook (Report sheet) lists the catalog labels that are available for
compartments. For example, the delivered labels show general information on a compartment,
tightness of a compartment, and the load on a compartment. The following table describes the
delivered labels.

Label Description

Compart Tightness Tooltip Displays the tightness property of a compartment.

Compart Tooltip General Displays the name and surface area of a


compartment.

Load General Tooltip Displays the name of a load.

You can associate objects and labels, and you can edit labels by clicking Tools > Options and
selecting the ToolTips tab. To view a label in the software, you pause the mouse pointer over
the compartment in the model.

Reports
The CompartReports.xls workbook (Report sheet) lists the catalog reports that are available
for compartments. The delivered reports show compartment attributes, loads, objects inside the
compartments, and so forth. The following table describes the delivered reports.

Report Description

Compartment Attributes Displays a list of compartments and their associated


Report properties: part description, volume, surface area, and
center of gravity coordinates.

CompartPaintingArea Displays the exposed surface area of structural


objects (plates and profiles) for estimating total paint
area. The report shows the objects which are in
contact with the compartment in the following ways:
 Overlapping
 OutsideAndTouching
 InsideAndTouching
 Inside
 Boundary

Compartmentation Reference Data Guide 34


Compartmentation Labels and Reports

Report Description
If you do not select compartments before
running the report, all compartments in the current
work session are processed.
The underlying report processes include:
 Get all the objects which are in touch with each
compartment.
 Get the subtracted geometry of the compartment
and object.
 Get the surface area of the subtracted geometry.
 Get the coating information of the
compartment(s).

Compartment Tightness Displays a list of compartments and their tightness


Report properties: part description, compartment tightness,
structural tightness, plate, and plate tightness.

Compartments And Zones Displays a list of compartments and connected zones.


Report This report includes the type of compartment and type
of zone.

Compartment Weight and Displays a list of compartments, their weight and their
CG center of gravity.

Connected Compartments Displays a list of compartments that are adjacent.


Report

Load Combination And Displays a list of load combinations, including the


Relations Report associated spatial loads, connected compartments,
unit loads, and load folders. This report provides a
load combination overview.

Objects inside the Displays a list of compartments, their part


Compartments descriptions, and the objects inside the
compartments. This report requires you to select a
filter during runtime.

Spatial Loads And Relations Displays a list of spatial loads, with associated load
Report combinations, compartments, and part descriptions.
This report provides a spatial load overview.

Unit Attributes Report Displays a list of unit loads, including their load
magnitudes and vector components.

Unit Loads And Relations Displays a list of unit loads and their parent folders.
Report This report provides a unit load overview.

Compartmentation Reference Data Guide 35


Compartmentation Labels and Reports

Report Description

Volumes and Parents Report Displays a list of volumes in the model, with part
descriptions and parent folders.

To run a report, start the software, and click Tools > Run Report. Select the Catalog Reports
tab, and browse to the Compartmentation folder.
For more information about labels and reports, see the Common User's Guide and the Reports
User's Guide.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)

Compartmentation Reference Data Guide 36


SECTION 8

Compartmentation Codelists
The CompartmentCodeLists.xls workbook specifies the compartmentation-specific codelists in
your catalog. Most of the codelists are examples and are not required in the catalog.
For more information about codelists, see the Smart 3D Reference Data Guide, available from
the Help > Printable Guides command.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)
In This Section
Compart Coating Color Codelist .................................................... 38
Compart Coating Process Codelist ............................................... 38
Compart Coating Responsibility Codelist ...................................... 38
Compart Coating Status Codelist .................................................. 38
Compart Coating Type Codelist .................................................... 38
Compartment Authorization Class Codelist ................................... 38
Compartment Bulk Cargo Type Codelist ....................................... 38
Compartment Bulkhead Tightness Codelist .................................. 39
Compartment Capacity Context Codelist ...................................... 39
Compartment Cargo Context Codelist........................................... 39
Compartment Coating Applicability Codelist ................................. 39
Compartment Coating Certification Codelist ................................. 39
Compartment Coating Inspection Codelist .................................... 39
Compartment Compartment Group Codelist ................................. 39
Compartment Compartment Type Codelist ................................... 39
Compartment Contact Material Type Codelist .............................. 39
Compartment Damage Location Codelist ..................................... 40
Compartment Damage Type Codelist ........................................... 40
Compartment Design Requirement Codelist ................................. 40
Compartment Function Type Codelist ........................................... 40
Compartment Insulation Category Codelist ................................... 40
Compartment Naval Nuclear Class Codelist ................................. 40
Compartment Naval Safety Category Codelist .............................. 40
Compartment Naval Security Class Codelist ................................ 40
Compartment Noise Category Codelist ......................................... 40
Compartment Positional Rel Type Codelist ................................... 41
Compartment Property Context Codelist ....................................... 41
Compartment Relevant Cargos Codelist ....................................... 41
Compartment Structure Type Codelist .......................................... 41
Compartment Surface Preparation Codelist .................................. 41
Load Case Liquid Pressure Codelist ............................................. 41
Load Case Sea Pressure Codelist ................................................ 41
Ship Design Loading Condition Type Codelist .............................. 41
Space Access Type Codelist ......................................................... 42
Space Adjacency Contact Type Codelist ...................................... 42

Compartmentation Reference Data Guide 37


Compartmentation Codelists

Space Adjacency Geometry Type Codelist ................................... 42


Space Arrangement Orientation Codelist ...................................... 42
Space Arrangement Type Codelist................................................ 42
Space Item Purpose Codelist ........................................................ 42
Space Physical Orientation Type Codelist .................................... 42
Space Positional Relationship Type Codelist ................................ 42
Space Product Structure Type Codelist ........................................ 42

Compart Coating Color Codelist


The Compart Coating Color sheet defines the available coating colors for compartments. This
codelist is used in the reference data for the Compartmentation task.

Compart Coating Process Codelist


The Compart Coating Process sheet specifies the different coating processes for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compart Coating Responsibility Codelist


The Compart Coating Responsibility sheet defines the list of responsible parties available for
applying the coating to compartments. This codelist is used in the reference data for the
Compartmentation task.

Compart Coating Status Codelist


The Compart Coating Status sheet lists the different statuses for compartment coatings. This
codelist is used in the reference data for the Compartmentation task.

Compart Coating Type Codelist


The Compart Coating Type sheet lists the types of coatings that you want to use for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Authorization Class Codelist


The Compartment Authorization Class sheet specifies the levels of authorization for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Bulk Cargo Type Codelist


The Compartment Bulk Cargo Type sheet specifies the different types of bulk cargo for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide 38


Compartmentation Codelists

Compartment Bulkhead Tightness Codelist


The Compartment Bulkhead Tightness sheet specifies the levels of bulkhead tightness for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Capacity Context Codelist


The Compartment Capacity Context sheet specifies the levels of capacity for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Cargo Context Codelist


The Compartment Cargo Context sheet specifies the levels of cargo context for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Applicability Codelist


The Compartment Coating Applicability sheet specifies the coating applicability options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Certification Codelist


The Compartment Coating Certification sheet specifies the levels of coating certification for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Coating Inspection Codelist


The Compartment Coating Inspection sheet specifies the coating inspection options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Compartment Group Codelist


The Compartment Compartment Group sheet specifies the groups for compartments. This
codelist is used in the reference data for the Compartmentation task.

Compartment Compartment Type Codelist


The Compartment Compartment Type sheet specifies the different types for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Contact Material Type Codelist


The Compartment Contact Material Type sheet specifies the types of contact materials for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide 39


Compartmentation Codelists

Compartment Damage Location Codelist


The Compartment Damage Location sheet specifies the damage locations for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Damage Type Codelist


The Compartment Damage Type sheet specifies the types of damage for compartments. This
codelist is used in the reference data for the Compartmentation task.

Compartment Design Requirement Codelist


The Compartment Design Requirement sheet specifies the design requirement options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Function Type Codelist


The Compartment Function Type sheet specifies the types of functions for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Insulation Category Codelist


The Compartment Insulation Category sheet specifies the categories of insulation for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Nuclear Class Codelist


The Compartment Naval Nuclear Class sheet specifies the naval nuclear classes for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Safety Category Codelist


The Compartment Naval Safety Category sheet specifies the categories of naval safety for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Naval Security Class Codelist


The Compartment Naval Security Class sheet specifies the classes of naval security for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Noise Category Codelist


The Compartment Noise Category sheet specifies the categories of noise levels for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide 40


Compartmentation Codelists

Compartment Positional Rel Type Codelist


The Compartment Positional Rel Type sheet specifies the types of positional relationships for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Property Context Codelist


The Compartment Property Context sheet specifies the property context options for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Relevant Cargos Codelist


The Compartment Relevant Cargos sheet specifies the relevant types of cargo for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartment Structure Type Codelist


The Compartment Structure Type sheet specifies the types of structure for compartments.
This codelist is used in the reference data for the Compartmentation task.

Compartment Surface Preparation Codelist


The Compartment Surface Preparation sheet specifies the different types of surface
preparation for compartments. This codelist is used in the reference data for the
Compartmentation task.

Load Case Liquid Pressure Codelist


The Load Case Liquid Pressure sheet specifies liquid pressure ratings for load cases on
compartments. This codelist is used in the reference data for the Compartmentation task.

Load Case Sea Pressure Codelist


The Load Case Sea Pressure sheet specifies sea pressure ratings for load cases on
compartments. This codelist is used in the reference data for the Compartmentation task.

Ship Design Loading Condition Type Codelist


The Ship Design Loading Condition Type sheet specifies the loading condition types for
compartments. This codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide 41


Compartmentation Codelists

Space Access Type Codelist


The Space Access Type sheet specifies the types of access for space objects. This codelist is
used in the reference data for the Compartmentation task.

Space Adjacency Contact Type Codelist


The Space Adjacency Contact Type sheet specifies the adjacency contact types for space
objects. This codelist is used in the reference data for the Compartmentation task.

Space Adjacency Geometry Type Codelist


The Space Adjacency Geometry Type sheet specifies the adjacency geometry types for space
objects. This codelist is used in the reference data for the Compartmentation task.

Space Arrangement Orientation Codelist


The Space Arrangement Orientation sheet specifies arrangement options for space objects.
This codelist is used in the reference data for the Compartmentation task.

Space Arrangement Type Codelist


The Space Arrangement Type sheet specifies the types of arrangements for space objects.
This codelist is used in the reference data for the Compartmentation task.

Space Item Purpose Codelist


The Space Item Purpose sheet specifies lists the item purposes for space objects. This codelist
is used in the reference data for the Compartmentation task.

Space Physical Orientation Type Codelist


The Space Physical Orientation Type sheet specifies the types of physical orientation for
space objects. This codelist is used in the reference data for the Compartmentation task.

Space Positional Relationship Type Codelist


The Space Positional Relationship Type sheet specifies the types of positional relationships
for space objects. This codelist is used in the reference data for the Compartmentation task.

Space Product Structure Type Codelist


The Space Product Structure Type sheet specifies the type of structure for space objects. This
codelist is used in the reference data for the Compartmentation task.

Compartmentation Reference Data Guide 42


SECTION 9

Interference Zones Codelists


The InterferenceZoneCodeLists.xls workbook specifies the interference zone-specific
codelists in your catalog.
For more information about codelists, see the Smart 3D Reference Data Guide, available from
the Help > Printable Guides command.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)

Interference Type Codelist


The Interference Type sheet lists the different types of interference zones that are available
when you create or modify these zones in the model. This codelist is used in the reference data
for the Compartmentation task.

Compartmentation Reference Data Guide 43


SECTION 10

Regions Codelists
The RegionCodeLists.xls workbook specifies the regions- specific codelists in your catalog.
For more information about codelists, see the Smart 3D Reference Data Guide, available from
the Help > Printable Guides command.
See Also
Compartmentation Reference Data (on page 8)
Understanding the Compartmentation Reference Data Workflow (on page 10)
What's New in Compartmentation Reference Data (on page 7)

Region Ship Type Codelist


The Region Ship Type sheet lists the different types of ships that are available when you create
or modify regions in the model. This codelist is used in the reference data for the
Compartmentation task.

Region Type Codelist


The Region Type sheet lists the different types of regions that are available when you create or
modify regions in the model. This codelist is used in the reference data for the
Compartmentation task.

Compartmentation Reference Data Guide 44


Index
Compartment Naval Nuclear Class Codelist
B • 40
Compartment Naval Safety Category
BulkCargoType • 16 Codelist • 40
Compartment Naval Security Class Codelist
C • 40
CmpartZoneCPS • 17 Compartment Noise Category Codelist • 40
CmpartZoneDamageControl • 17 Compartment Positional Rel Type Codelist •
CmpartZoneFire • 18 41
CmpartZonePlanning • 18 Compartment Property Context Codelist •
Compart Coating Color Codelist • 38 41
Compart Coating Process Codelist • 38 Compartment Relevant Cargos Codelist •
Compart Coating Responsibility Codelist • 41
38 Compartment Structure Type Codelist • 41
Compart Coating Status Codelist • 38 Compartment Surface Preparation Codelist
Compart Coating Type Codelist • 38 • 41
Compart Split Rule Sheet • 30 Compartmentation Cargo Rules • 24
Compartment Authorization Class Codelist • Compartmentation Codelists • 37
38 Compartmentation Generic Services • 30
Compartment Bulk Cargo Type Codelist • Compartmentation Labels and Reports • 34
38 Compartmentation Load Case and Cargo
Compartment Bulkhead Tightness Codelist Types • 24
• 39 Compartmentation Part Classes • 16
Compartment Capacity Context Codelist • Compartmentation Part Classes and Load
39 Case Types • 16
Compartment Cargo Context Codelist • 39 Compartmentation Reference Data • 8
Compartment Coating Applicability Codelist Compartmentation Reference Data
• 39 Common Tasks • 13
Compartment Coating Certification Codelist Compartmentation Symbols • 27
• 39 CompartmentCargo • 18
Compartment Coating Inspection Codelist • CompartmentCargoRule • 24
39 CompartmentHabitable • 19
Compartment Compartment Group Codelist CompartmentMachinery • 19
• 39 CompartmentTank • 20
Compartment Compartment Type Codelist • CompartmentUnknown • 20
39 CompartmentVoid • 21
Compartment Contact Material Type Custom Class Interface List Sheet • 31
Codelist • 39
Compartment Custom Attribute Sheet • 31 G
Compartment Damage Location Codelist • GaseousCargoType • 21
40
Compartment Damage Type Codelist • 40
Compartment Design Requirement Codelist I
• 40 Interference Type Codelist • 43
Compartment Function Type Codelist • 40 Interference Zone Type Sheet • 25
Compartment Insulation Category Codelist • Interference Zones • 25
40 Interference Zones Codelists • 43

Compartmentation Reference Data Guide 45


Index

L V
LiquidCargoType • 22 VoidSpace • 23
Load Case Liquid Pressure Codelist • 41
Load Case Sea Pressure Codelist • 41 W
LoadCaseType • 23
What's New in Compartmentation
Reference Data • 7
M
Move custom .dlls to SharedContent folder •
14

N
Naming Rules • 32
Naming Rules Sheet • 32

P
Preface • 7

R
Region Corrosion Sheet • 26
Region Ship Type Codelist • 44
Region Type Codelist • 44
Regions • 26
Regions Codelists • 44

S
Ship Design Loading Condition Type
Codelist • 41
Space Access Type Codelist • 42
Space Adjacency Contact Type Codelist •
42
Space Adjacency Geometry Type Codelist •
42
Space Arrangement Orientation Codelist •
42
Space Arrangement Type Codelist • 42
Space Item Purpose Codelist • 42
Space Physical Orientation Type Codelist •
42
Space Positional Relationship Type
Codelist • 42
Space Product Structure Type Codelist • 42

U
Understanding the Compartmentation
Reference Data Workflow • 10
UnitCargoType • 23

Compartmentation Reference Data Guide 46