Compartmentation Reference Data - Intergraph Smart 3D - Reference Data

Intergraph Smart 3D Compartmentation Reference Data

PPMProduct
Intergraph Smart 3D
PPMCategory_custom
Reference Data
Version_SThreeD_Custom
11 (2016)

Each organization using the Intergraph Smart 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 Help:

  • 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 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 Help.

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
Compartmentation Generic Services
Compartmentation Codelists