Hull

Class KcsBodyPlanViewOptions.BodyPlanViewOptions

The class holds information about Body plan View attributes.

Parameters and attributes:

BodyPlanName

string

Defines view name

bAutoSeams

integer

Auto Seams flag. If set, include all seams (longitudinal direction) and butts (transversal direction) inside the box.

bAutoLongTrace

integer

Auto longitudinal trace flag. If set, include traces of all profiles inside the box.

bAutoLongSection

integer

Auto longitudinal section flag. If set, include cross-sections of all profiles inside the box

SurfacesFilter

[ string ]

List of surface for filtering (include/exclude depends on SurfacesExclude flag)

SurfacesExclude

integer

Surfaces exclude/include flag

Scale

integer

Defines view scale

AftLimits

Point3d

Defines coordinate of aft limit of the view

FwdLimits

Point3d

Defines coordinate of fwd limit of the view

bLooking

constant

Defines looking code. Can be one of:

LOOKING_PS  = 1

LOOKING_SB  = 2

LOOKING_FOR = 4

LOOKING_AFT = 3

LOOKING_TOP = 5

LOOKING_BOT = 6

LongSectionImage

constant

Defines how cross-sections of profiles should be drawn. Can be one of:

IMAGE_FULL   = 0

IMAGE_MOULD  = 1

IMAGE_THICK  = 2

LongSectionFrame

integer

This attribute can be used to display the cross-section of the profiles at a single frame only.

DrawFrame

integer

Interval (number of frames) between sections to be drawn in the body plan view.

SeamColour

colour

Defines seam colour

LongColour

colour

Defines longitudinal colour

FrameColour

colour

Defines frame colour

GridSpacing

integer

Defines grid spacing, if it should be drawn.

PanelFilter

[ string ]

Include/Exclude list

SeamsFilter

[ string ]

Include/Exclude list (depends on SeamsExclude flag)

SeamsExclude

integer

Except flag

TraceFilter

[ string ]

List of names of shell profiles whose traces will be included/excluded (depends on TraceExclude flag).

TraceExclude

integer

Except flag

SectionFilter

[ string ]

List of names of shell profiles whose sections will be included/excluded (depends on SectionExclude flag).

SectionExclude

integer

Except flag

SelectCurves

dictionary

Curve Name/LineType dictionary (name : line type). Line type must be defined in system.

Constructor:

BodyPlanViewOptions()

This constructor will create instance of BodyPlanViewOptions () class.

Methods:

SetSection (image, frame)

Sets longitudinal section image and frame.

image

constant

Longitudinal section image type (IMAGE_THICK, IMAGE_MOULD or IMAGE_FULL)

frame

integer

Longitudinal section frame

GetSection ()

(constant, integer)

Gets section image and frame (image, frame)

SetColours (long, seam, frame)

Sets longitudinal, seam and frame colours. Available colour strings are defined in KcsBodyPlanViewOptions.COLOURS table.

long

colour

Longitudinal colour

seam

colour

Seam colour

frame

colour

Frame colour

GetColours ()

(Colour, Colour, Colour)

Gets longitudinal, seam and frame colours (long, seam, frame)

Class protocols:

__repr__

Used to return string representation of BodyPlanViewOptions() object.

Class KcsCopyPanOptions

The class holds information about Copy Panel Options : Inherits from KcsMovePanOptions

Parameters and attributes:

__Dictionary

Dictionary

Panel Names Dictionary

__BlockName

string

Block Name

Methods:

SetNameMapping (Dictionary)

Sets Dictionary used to change Panel Names.

It defines names of panels to copy and names after copy operation.

Example call of Method:

SetNameMapping({'oldPanel' : 'newPanel'})

Where:

• OldPanel – is name of copied panel

• NewPanel – is name of panel created by copy function.

SetBlockName (string)

Sets Block for copied Panel

It defines name of block where panel will be copied.

Class KcsMovePanOptions

The class holds information about Move Panel Options

Parameters and attributes:

__LocationType

Constant

Type of Location. Can be one of:

PRINCIPAL_PLANE =1

THREE_POINTS    =2

PLANE_OBJECT    =3

__Coordinate

Constant

Defines Coordinate. Can be one of:

X =1

Y =2

Z =3

__RelativePosition

Constant

Defines Relative Position. Can be one of:

1 – Relative

0 – Not Relative

__CoordinateValue

string

Coordinate Value in String format

__Origin

Point3D

If defined by three points, Point of Origin

__Uaxis

Point3D

If defined by three points, Point of Uaxis

__Vaxis

Point3D

If defined by three points, Point of VAxis

__ObjectName

string

If Defined by Object, object name

Methods:

SetPrincipalPlane (integer, integer, string)

Sets Principal Plane by giving cord, relpos, cordval. Example call:

SetPrincipalPlane(coordinate, relativePosition, coordinateValue)

Where:

coordinate – is coordinate definition, which defines plane of moving operation. See parameters and attributes definition.

relativePosition – is flag which defines if coordinateValue is relative position or absolute. See parameters and attributes definition.

CoordinateValue – is, regarding to relativePosition flag, absolute coordinate value or relative coordinate value that means, ‘1000’ or ‘FR1’ .

SetThreePoints (Point3D, Point3D, Point3D)

Sets three points by giving: origin, uaxis, vaxis

Defines moving operation by three points.

SetThreePoints(Origin, Uaxis, Vaxis)

Where:

Origin, Uaxis, Vaxis – are Point3D definitions in UVW coordinate system.

SetPlaneObject(string)

Sets Plane Object by giving: name

Set moving operation by plane object where name is plane object name used to move panel.

Class KcsPanelSchema

The class contains functions operating on panel schema.

Methods:

SetValue(Group, Keyword, Value)

Function to set value of keyword in panel schema statement.

Parameters:

Group ( Integer/String ) : Index of statement in group or statement string

Keyword ( String ) : Name of keyword

Value ( String ) : Value of keyword

GetValue(Group, Keyword )

Function to get value of keyword in panel schema statement.

Group ( Integer/String ) : Index of statement in group or statement string

Keyword ( String ) : Name of keyword

Return value: ( String ) Value of keyword in given statement

Class KcsPanHoleOptions

The class holds information about PanHole Options.

Parameters and attributes:

__Axis

Constant

Defines axis by which hole is created:

BY_UNDEF = 0

BY_U = 1

BY_V = 2

BY_UV = 3

BY_X = 11

BY_Y = 12

BY_Z = 13

BY_YZ = 21

BY_XZ = 22

BY_XY = 23

BY_XYZ = 30

BY_X_Y_ZAP = 36

BY_X_YAP_Z = 34

BY_XAP_Y_Z = 32

BY_XRT = 40

BY_1 = 100

BY_2 = 200

BY_T = 500

____HasApprox

Integer

Defines if approximated coordinate.

0 - true

1- false

__Pt1

Point3D

Defines the origin coordinates.

__Pt2

Point3D

Defines the origin coordinates.

__AsStored

integer

Defines the origin of a hole "as stored".

This is used when the hole is created from an existing contour which has a transformation. The contour will be projected into the curved panel along the normal of the plane in which the contour is defined.

1 - true

0 - false

__Rotation

Point3D

In case of an asymmetrical hole, this defines the direction of the U-axis of the hole.

__Symm

Constant

Symmetry code.

SYMM_AS_PANEL = 0

SYMM_PS       = 1

SYMM_SB       = 12

__IsFictive

integer

Define if hole will be burnt or only marked.

1 - true

0 - false

__Develop

integer

Set the develop option for the hole.

1 – true

0 – false

__IsArbitrary

integer

Set the hole arbitrary, that means, the hole designation is a curve.

1 - true

0 - false

__MarkType

Constant

Defines Marking Type

HOLE_MARK = 0

CROSS_MARK = 1

BOTH_MARK = 2

__CrossType

Constant

Defines Cross Type:

OVERHOLE_CROSS = 0

SMALL_CROSS = 1

SPECIAL_CROSS = 2

__MarkLen

Float

Defines Marking Length

Methods:

SetOriginAlongLine (Pt1, Pt2 )

Defines the origin of a hole in a curved panel, when defined "along line".

The (limited) line is defined by two 3d points. The origin will be the intersection point of the line and the panel.

Pt1 (Input). The start point of line intersecting the curved panel.

Pt2 (Input). The end point of the intersecting line.

SetOriginAlongAxis(Axis, Pt1, HasApprox)

Defines the origin of a hole in a curved panel, when defined "along axis".

The (infinite)line is defined by two coordinates. The origin will be the intersection point of the line and the panel. An approximate coordinate must be given. "Axis" selects which coordinate if "Pt1" is the approximate one.

Axis (Input). Selects the approximate coordinate

Pt1 (Input). The coordinates.

SetOriginAsStored(Axis, Pt1)

Defines the origin of a hole "as stored". This is used when the hole is created from an existing contour which has a transformation. The contour will be projected into the curved panel along the normal of the plane in which the contour is defined. You may given an approximate coordinate in case of multiple intersection with the surface. Approx is: (axis+coordinate value)

SetDirection(Dir)

In case of an asymmetrical hole, this selects the direction of the U-axis of the hole. "Dir" is either a vector or a point. Interpreted as a vector if the length <= 1.0 If dir is a point the system will form a vector from origin the point. The vector will then be projected into the tangent plane of the panel ( in the origin of the hole ).

Dir (Input). Point defining the direction of the U-axis of the hole.

SetArbitrary()

Set the hole arbitrary, that means, the hole designation is a curve.

SetFictive()

Set "fictive" form the hole, ( A fictive hole will not be burnt, only marked.)

SetDevelop()

Set the develop option for the hole.

SetMarkingType(type)

Defines Marking Type

SetCrossType(self, type)

Defines Cross Type

SetMarkLength(self, value)

Defines Marking Length

GetOriginAlongLine(self)

Gets the origin of a hole in a curved panel, when defined along line

GetOriginAlongAxis(self)

Gets the origin of a hole in a curved panel, when defined along axis

GetOriginAsStored(self)

Gets the origin of a hole in a curved panel

GetDirection(self)

Gets Direction

GetDesign(self)

Gets Design

IsFictive(self)

Gets Fictive flag

IsDevelop(self)

Gets Develop Flag

IsArbitrary(self)

Gets Arbitrary Flag

GetMarkType(self)

Gets Mark Type

GetCrossType(self)

Gets Cross Type

GetMarkLen(self)

Gets Mark Len

Class KcsRunModeOptions

The class holds information about planar hull scheme run mode options.

Parameters and attributes:

__ConfirmGeneration

Integer

Confirm generation option.

__TraceOn

Integer

Trace on option

Methods:

SetConfirmGeneration(Integer)

Set Confirm Generation value.

Allowed values: [ 0,1, None ]

GetConfirmGeneration

Get Confirm Generation value.

SetTraceOn (Integer)

Set Trace On value.

Allowed values: [ 0,1, None ]

GetTraceOn ()

Get Trace On value.

Class KcsShPlateProp.ShPlateProp

The class holds information about a shell plate.

Parameters and attributes:

__PartsList

String

An explicitly given parts list name.

__GPS_1

String

General Purpose String.

__GPS_2

String

General Purpose String.

__GPS_3

String

General Purpose String.

__GBP_4

String

General Purpose String.

__SurfaceTreatment

String

Surface Treatment.

__Destination

String

Destination.

__Thickness

Float

Material Thickness (inside).

__ThicknessOut

Float

Material Thickness (outside).

__Quality

String

Material Quality Code.

__Posno

Integer

Position Number.

__LaminateIn

Integer

Laminate code for inside of plate.

__LaminateOut

Integer

Laminate code for outside of plate. A value o 0 means same laminate code as for inside.

__LongitudinalShrinkage

Float

Longitudinal shrinkage.

__TransversalShrinkage

Float

Transversal shrinkage.

__RawPlate

String

Raw Plate Identification.

Methods:

GetDestination

GetGPS_1

GetGPS_2

GetGPS_3

GetGPS_4

GetLaminateIn

GetLaminateOut

GetLongitudinalShrinkage

GetPartsList

GetPosno

GetQuality

GetRawPlate

GetSurfaceTreatment

GetThickness

GetThicknessOut

GetTransversalShrinkage

SetDestination

SetGPS_1

SetGPS_2

SetGPS_3

SetGPS_4

SetLaminateIn

SetLaminateOut

SetLongitudinalShrinkage

SetPartsList

SetPosno

SetQuality

SetRawPlate

SetSurfaceTreatment

SetThickness

SetThicknessOut

SetTransversalShrinkage

ClassKcsShStiffProp.ShStiffProp

The class holds information about a shell stiffener.

Parameters and attributes:

_DummyInterval

Integer

= 1 The shell stiffener is a dummy interval.

_GPS_1

String

General purpose string.

_GPS_2

String

General purpose string.

_GPS_3

String

General purpose string.

_GPS_4

String

General purpose string.

_SurfaceTreatment

String

Surface treatment.

_Destination

String

Destination.

_UseStiffenerData

Integer

= 1 Use the profile data in this class.

= 0 Use the profile data in the shell profile this stiffener belongs to.

_Posno

Integer

Position number.

_PosnoPrefix

String

Position number prefix.

_PosnoSuffix

String

Position number prefix.

_Profile

_Type

Profile type according to standards.

_Parameters

Profile parameters.

_Quality

String

Material quality code.

_End[0,1]

_Connection

Connection code.

_Excess

Excess.

_Offset

The given length from the starting / ending point of the trace to the actual starting / ending point of the physical profile, measured as described below. This length should always be >=0.

_OffsetFrom

The physical end point of the shell stiffener will be located at a distance

_Offset from the plane described by

_OffsetFrom, measured perpendicularly to the plane.

Can be of type:

kcsCUTTING_PLANE

kcsFRAME_PLANE

kcsBUTTOCK_PLANE

kcsWATERLINE_PLANE

_EndCut

• _CalcWebAngle

  The angle is calculated according to the values of _Connection.

• _CalcFrom

  kcsCUTTING_PLANE

  kcsFRAME_PLANE

  kcsBUTTOCK_PLANE

  kcsWATERLINE_PLANE

• _Type

  End cut type.

• _Parameters

  End cut parameters

_WebBevel

Bevel Code for profile web.

_FlaBevel

Bevel code for profile flange.

_InclAngle

Angle measure.

_InclAngelType

Angel type:

kcsX_AXIS,KcsY_AXIS,kcsZ-AXIs,

kcsPERPENDIUCULAR,

kcsPERP_WHOLe,

kcsCUTTING_PLANE

_TraceBevel

Float

Bevel code along the trace of this stiffener.

_Shrinkage

Float

Shrinkage of the stiffener in millimeters per meter.

_FilletWeldDepth

Float

Depth of fillet weld when stiffener is mounted on a curved panel.

_Perpendicular

Integer

= 1 The stiffener is perpendicular to the surface at all positions along the trace.

= 0 Inclination is specified at both ends.

Methods:

GetDestination

GetDummyInterval

GetEnd1,GetEnd2

Get Connection

GetEndCut

GetCalcFrom

GetCalcWebAngle

GetParameter

GetType

SetCalcFrom

SetCalcWebAngle

SetParameter

SetTyp

GetExcess

GetFlaBevel

GetInclAngle

GetInclAngleType

GetOffset

GetOffsetFrom

GetWebBevel

SetConnection

SetExcess

SetFlaBevel

SetInclAngle

SetInclAngleType

SetOffset

SetOffsetFrom

SetWebBevel

GetFilletWeldDepth

GetGPS_1

GetGPS_2

GetGPS_3

GetGPS_4

GetPerpendicular

GetPosno

GetPosnoPrefix

GetPosnoSuffix

GetProfileParameter

GetProfileType

GetQuality

GetShrinkage

GetSurfaceTreatment

GetTraceBevel

GetUseStiffenerData

SetDestination

SetDummyInterval

SetFilletWeldDepth

SetGPS_1

SetGPS_2

SetGPS_3

SetGPS_4

SetPerpendicular

SetPosno

SetPosnoPrefix

SetPosnoSuffix

SetProfileParameter

SetProfileType

SetQuality

SetShrinkage

SetSurfaceTreatment

SetTraceBevel

SetUseStiffenerData

Class KcsShellXViewOptions

The class holds information about Shell Expansion View Options.

Parameters and attributes:

__ShellXName

string

Defines View Name

__DevelopedFromCode

Constant

Defines Coordinate. Can be one of:

X = 1

Y = 2

Z = 3

__DevelopedFromCoordinate

Point3D

Defines Developed From Coordinate

__SternLimtsCode

string

Defines Limits Code. Can be one of:

PLANE_BY_SEAMS = 1

PLANE_BY_X     = -1

PLANE_BY_Y     = -2

PLANE_BY_Z     = -3

__SternLimitsSeams

[ ]

If defined by Seams, list of seams.

__SternLimitsCoordinate

Point3D

Defines Limits Coordinate.

__StemLimitsCode

Point3D

Defines Limits Code. Can be one of:

PLANE_BY_SEAMS = 1

PLANE_BY_X     = -1

PLANE_BY_Y     = -2

PLANE_BY_Z     = -3

__StemLimitsSeams

[ ]

If defined by Seams, list of seams.

__StemLimitsCoordinate

Point3D

Defines Limits Coordinate.

__UpperLimitsCode

Constant

Defines Limits Code. Can be one of:

PLANE_BY_SEAMS = 1

PLANE_BY_X     = -1

PLANE_BY_Y     = -2

PLANE_BY_Z     = -3

__UpperLimitsSeams

[ ]

If defined by Seams, list of seams.

__UpperLimitsCoordinate

Point3D

Defines Limits Coordinate.

__LowerLimitsCode

Constant

Defines Limits Code. Can be one of:

PLANE_BY_SEAMS = 1

PLANE_BY_X     = -1

PLANE_BY_Y     = -2

PLANE_BY_Z     = -3

__LowerLimitsSeams

[ ]

If defined by Seams, list of seams.

__LowerLimitsCoordinate

Point3D

Defines Limits Coordinate.

__SideCode

Constant

Defines Side Code. Can be one of:

SIDE_PORT      = 0

SIDE_STARBOARD = 1

__bExceptPanels

Integer

Except Flag

__SelectPanels

[ ]

Include/Exclude List

__bExceptBlocks

Integer

Except Flag

__SelectBlocks

[ ]

Include/Exclude List

__bExceptSeams

integer

Except Flag

__SelectSeams

[ ]

Include/Exclude List

__bExceptLongitudinals

integer

Except Flag

__SelectLongitudinals

[ ]

Include/Exclude List

__bExceptTransversals

Integer

Except Flag

__SelectTransversals

[ ]

Include/Exclude List

__SelectCurves

Dictionary

Select Curves Dictionary

Methods:

SetShelXViewName (string)

Sets View Name

SetDevelopedFromX (Point3D)

Sets plane defined by X coordinate

SetDevelopedFromY (Point3D)

Sets plane defined by Y coordinate

SetDevelopedFromZ (Point3D)

Sets plane defined by Z coordinate

GetShellXViewName

Gets View Name

SetSternLimits

Sets Limits defined by plane X, Y or Z) or seams and coordinate or seams list.

GetSternLimits

Gets Stern Limits (code and coordinate or seam list)

SetStemLimits

Sets Limits defined by plane X, Y or Z) or seams and coordinate or seams list.

GetStemLimits

Gets Stem Limits (code and coordinate or seam list)

SetUpperLimits

Sets Limits defined by plane X, Y or Z) or seams and coordinate or seams list.

GetUpperLimits

Gets Upper Limits (code and coordinate or seam list)

SetLowerLimits

Sets Limits defined by plane X, Y or Z) or seams and coordinate or seams list.

GetLowerLimits

Gets Lower Limits (code and coordinate or seam list)

SetSideCode

Sets Side Code.

GetSideCode

Gets Side Code.

SetSelectPanels

Sets select panels list.

GetPanels

Gets select panels list

SetExceptPanels

Sets except panels flag

SetSelectBlocks

Sets select blocks list.

GetBlocks

Gets select blocks list

SetExceptBlocks

Sets except blocks flag

SetSelectLongitudinals

Sets select longitudinals list.

GetLongs

Gets select longitudinals list

SetExceptLongitudinals

Sets except longitudinals flag

SetSelectTransversals

Sets select transversals list.

GetTrans

Gets select transversals list

SetExceptTransversals

Sets except transversals flag

SetLineTypes

Sets dictionary with curves names and types (name : type)

GetCurves

Gets dictionary with curves names and types.

Class KcsSplitPanOptions.SplitPanOptions

The class holds information about Split Panel Options

Parameters and attributes:

Plane3D

Plane3D

Cutting Plane used to split panel

PanelMapping

[…]

List of items defining new panels after split operation. Each item is an dictionary containing following keys:

‘Name’ - panel name

‘Block’ – block name

‘SymmetryCode’ – symmetry code string

Constructor:

SplitPanOptions()

This constructor will create an instance of SplitPanOptions class

Methods:

AddPanelMapping

(PanelName, Block, Symmetry)

Define panel name, block and symmetry code for new panels generated by split operation. The function should be called once for each new panel.

PanelName

String

New panel name

Block

<String>

Panel block. If not defined panel block is remained.

Symmetry

<String>

Panel symmetry code. Possible values: ‘S’, ‘P’, ‘SP’, ‘SBPS’. Default value is ‘SBPS’.

Class protocols:

__repr__

Used to return string representation of SplitPanOptions object.