OCX Reader

Supported Entities

Entities supported by the OCX reader.

Vessel
Arrangements
Compartments
Physical spaces
Panels
Plates
Pillars
Stiffeners
Brackets
Hole profiles
Seam profiles
Reference planes

When @CreationType = TreeOfComponents, an assembly tree is created and organized as follows:

1 assembly corresponding to a vessel
- 1 assembly per arrangement
  - 1 component per compartment
  - 1 component per physical space
- 1 component per vessel level plate
- 1 component per vessel level bracket
- 1 component per vessel level stiffener
- 1 component per vessel level pillar
- 1 assembly per panel
  - 1 component for the geometry of the panel
  - 1 component per panel level plate (if XXXX option is enabled)
  - 1 component per panel level bracket
  - 1 component per panel level stiffener
  - 1 component per panel level seam
  - 1 component per panel level pillar

When @CreationType = Parts, a corresponding tree is created but not assembly entities are created. Parts are created instead. The components are also created.

When @CreationType = BOM Only, a corresponding tree is created with parts as in the previous case, but no components are actually created.

Panel geometries, plates, and brackets are mapped onto surfaces. Stiffeners and pillars are mapped onto curves, but can be mapped onto surfaces if the option XXXX is enabled and the corresponding info can be found in the file. Seams are mapped into curves.

Appropriate material definitions are also created in the model. Supported material info includes density, Poisson’s ratio, thermal expansion, ultimate stress, yield stress, and Young's modulus provided as metadata of the material. Each material is associated with a unique grade name. Objects reference material entities via metadata. Thickness info is provided as metadata of plate parts.

Beam section definitions are also created in the model. Stiffeners using a beam section reference definitions via metadata.

Import Options

The OCX reader uses the ocx_reader.ini file.

`@BodyIdAsMetadata`
Value	Description
`on`	Assign body identifier as metadata. `BODY_ID`
`off`	Do not assign body identifier as metadata (default).

`@CleanupTol`
Value	Description
`double`	A negative value (default) indicates to use the auto cleanup tolerance. A value greater than the calculated auto cleanup tolerance indicates to use that specific tolerance. Refer to the CAD Import Options.

`@CreateComposingPlates`
Value	Description
`on`	Create geometry for panel level plates.
`off`	Do not create geometry for panel level plates (default).

`@CreateDetailedObjects`
Value	Description
`on`	Provide a more complete representation of an object when available (default)
`off`	Provide just the basic representation of an object.

`@CreateObjectContours`
Value	Description
`on`	Create a wire frame representation of the object contours.
`off`	Do not create a wire frame representation of the object contours (default).

`@CreationType`
Value	Description
`Parts`	Generate a full part-based hierarchy.
`BOMOnly`	Generate an empty part-based hierarchy.
`TreeOfComponents`	Generate an assemblies/components based hierarchy.
`PackIntoSinglePart`	Consolidate hierarchy into a single part.

`@DoNotMergeEdges`
Value	Description
`on`	Preserve the original geometry edges, instead of merging them together during the import cleanup phase.
`off`	Merge edges together during the import cleanup phase (default).

`@ExtendSurfaces`
Value	Description
`on`	The imported surfaces are extended to match neighbor surfaces (default).
`off`	The imported surfaces are not extended.

`@ImportCompartments`
Value	Description
`on`	Import both compartments in the IGES files, and compartments defined by “Faces”. The former by importing the geometry, the latter just by creating a metadata; also reference planes are created, because they can be referenced by compartments.
`off`	Do not import any compartments (default).

`@ImportHoles`
Value	Description
`on`	Create holes (default).
`off`	Do not create create holes.

`@LegacyHierarchyAsMetadata`
Value	Description
`on`	Generate metadata with the original CAD hierarchy within the part. `LEGACY_HIERARCHY`
`off`	Do not generate metadata with the original CAD hierarchy within the part (default).

`@MetadataPrefix`
Value	Description
`string`	The string is prefixed to all metadata names. No prefix is used by default. See CAD Metadata Naming for more details.

`@OrphanPlatesAsSurfaces`
Value	Description
`Surfaces`	When a vessel level plate contains just wire frame, create appropriate surfaces out of it (default).
`Any other value`	Keep wire frame representation only.

`@ScaleFactor`
Value	Description
`double`	Define the model scaling factor during import. Default is 1.0.

`@SplitComponents`
Value	Description
`Part`	Generate part-based component (only allowed value if `CreationType`=`Parts`).
`General`	Keep component as in CAD (only allowed value if `CreationType`=`TreeOfComponents`).

`@StitchEdges`
Value	Description
`on`	Edges of close surfaces are stitched together (default).
`off`	Edges of close surfaces are not stitched together.

`@TargetUnits`
Value	Description
`CAD units`	Keep the units of the CAD files (default for GUI).
`MKS [m kg N s]`	Convert to the corresponding units system.
`MMKS [mm kg N s]`	Convert to the corresponding units system.
`MPA [mm t N s]`	Convert to the corresponding units system.
`CGS [cm g dyn s]`	Convert to the corresponding units system.
`MMKNMS [mm kg kN ms]`	Convert to the corresponding units system.
`MMGNMS [mm g N ms]`	Convert to the corresponding units system.
`IPS Std [in pounds lbf s]`	Convert to the corresponding units system.
`IPS Grav [in slinch lbf s]`	Convert to the corresponding units system.
`FPS Std [ft pounds lbf s]`	Convert to the corresponding units system.
`FPS Grav [ft slug lbf s]`	Convert to the corresponding units system.
`Scale factor`	Apply the corresponding scale factor (default for no GUI to allow supporting legacy scripts).

Supported Metadata

Metadata possibly generated from the OCX reader.

`AirFillingHeight`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`AirPipeHeight`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`AP_Pos`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`BEAM_SECTION`
Type	Entities	Description
`entity`	parts	Stiffener groups might contain this metadata which points the corresponding BEAMSECTION entity.

`BlockCoefficient`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`BulkCargoAngleOfRepose`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`BulkCargoPermeability`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`BulkCargoStowageFactor`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`BulkCargoType`
Type	Entities	Description
`string`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`CallSign`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`COG_X`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	X position of the center of gravity for panels, plates, stiffeners, brackets, pillars, compartments, physical spaces.

`COG_Y`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Y position of the center of gravity for panels, plates, stiffeners, brackets, pillars, compartments, physical spaces.

`COG_Z`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Z position of the center of gravity for panels, plates, stiffeners, brackets, pillars, compartments, physical spaces.

`DeadWeight`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`DeepestEquilibriumWL`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Description`
Type	Entities	Description
`string`	assemblies or components if hierarchy as Assemblies; parts if hierarchy as Parts	Contains the description of an object as provided in the OCX file.

`Designer`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`DesignSpeed`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`DryWeight`
Type	Entities	Description
`double`	assemblies or components if hierarchy as Assemblies; parts if hierarchy as Parts	Panels, plates, stiffeners, brackets, pillars might contain this metadata if available in the OCX file.

`ExternalGeometryFormat`
Type	Entities	Description
`string`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`ExternalGeometryReference`
Type	Entities	Description
`string`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`FlagState`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`FlangeDirection`
Type	Entities	Description
`double array`	components if hierarchy as Assemblies; parts if hierarchy as Parts	An array of six double values might be added to each line belonging to stiffeners and pillars. Each line is provided with two triplets of inclination values to form two unit vectors. The vectors indicate the inclinations of the flange, if any, at the endpoints of the lines in the absolute reference system.

`FP_Pos`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`FreeboardDeckHeight`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`FreeboardLength`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`FreeboardType`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`HasBilgeKeel`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`HasDeadWeightLessThan`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`HeavyBallastDraught`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Identification`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`INCLINATION`
Type	Entities	Description
`double array`	assems	An array of 6 double values is added to each line belonging to pillars, flanges, stiffeners, and faceplates. Each line is provided with two triplets of inclination values to form 2 unit vectors. The vectors indicate the inclinations at the endpoints of the lines in the absolute reference system.

`LengthOfWaterline`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if heirarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Lpp`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if heirarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Material`
Type	Entities	Description
`entity`	parts	Plates, brackets, stiffeners and pillars might contain this metadata which points the corresponding MATERIAL entity.

`MODELUNIT`
Type	Entities	Description
`integer`	comps if hierarchy as Assemblies; parts if hierarchy as Parts	Model units specified in the CAD file. 1 = inches 2 = millimeters 4 = feet 5 = miles 6 = meters 7 = kilometers 8 = mils 9 = microns 10 = centimeters 11 = microinches 12 = decimeters 13 = yards This is always generated.

`MouldedBreadth`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`MouldedDepth`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`MouldedDraught`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`NewBuildingSociety`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`NewBuildingSocietyName`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`NormalBallastDraught`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`NumberIMO`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`NumberOfDecksAbove`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`OCXObjectType`
Type	Entities	Description
`string`	comps, assems if hierarchy as Assemblies; parts if hierarchy as Parts	The value is a string indicating the role of the object. Currently created values include: Vessel Container Vessel Panel Plate Stiffener Bracket Pillar Arrangement Compartment Physical Space Panel Geometry Seam

`OFFSET`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Plates and brackets might contain this metadata if available in the OCX file.

`Owner`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Plate_T`
Type	Entities	Description
`double`	components if hierarchy as Assemblies; parts if hierarchy as Parts	Plates, stiffeners, brackets and pillars might contain this metadata if available in the OCX file.

`PortRegistration`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Purpose`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`ReliefValvePressure`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file. .

`RuleLength`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`ShipName`
Type	Entities	Description
`string`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`ShipType`
Type	Entities	Description
`string`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`SlammingDraughtEmptyFP`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`SlammingDraughtFullFP`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Society`
Type	Entities	Description
`string`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`SocietyName`
Type	Entities	Description
`string`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`SpeedFactor`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Tightness`
Type	Entities	Description
`string`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Panels might contain this metadata if available in the OCX file.

`Tonnage`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`UnitCargoType`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`UpperDeckArea`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Volume`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Compartments and Physical Spaces might contain this metadata if available in the OCX file.

`WaterPlaneArea`
Type	Entities	Description
`double`	assems if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`Yard`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`YearOfBuild`
Type	Entities	Description
`string`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`ZPosDeckline`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.

`ZPosOfDeck`
Type	Entities	Description
`double`	assemblies if hierarchy as Assemblies; parts if hierarchy as Parts	Vessels might contain this metadata if available in the OCX file.