NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder Class Reference

Represents a NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder which is used to change default object display settings for ship structures. More...

Inheritance diagram for NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder:
NXOpen.Features.FeatureBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  AngleRuleTypes { RightHand, ShipOrientation }
 The methods that can be used to measure angles in ship design. More...
 
enum  ColorType { Default, Set }
 the color option type More...
 
enum  DisplayType { Curve, CurveAndSolid }
 display profile system curve and body. More...
 
enum  Types {
  Hull, Deck, TransverseBulkhead, LongitudinalBulkhead,
  GenericPlateSystem, StiffenerSystem, EdgeReinforcementSystem, PillarSystem,
  ScantlingSeam, ErectionSeam, StrakingSeam, IntersectionSeam,
  Bracket, CollarPlate
}
 This enum represents the ship structure types. More...
 

Public Member Functions

unsafe void ApplyDisplayOption ()
 Apply profile system display option. More...
 
- Public Member Functions inherited from NXOpen.Features.FeatureBuilder
unsafe NXOpen.Features.Feature CommitFeature ()
 Commits the feature parameters and creates the feature More...
 
unsafe NXOpen.Features.Feature GetFeature ()
 Returns the feature currently being edited by this builder. More...
 
unsafe void HideInternalParentFeatureAfterEdit (NXOpen.Features.Feature parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
unsafe void SetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited More...
 
unsafe void ShowInternalParentFeatureForEdit (NXOpen.Features.Feature parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
unsafe void UnsetParentFeatureInternal (NXOpen.Features.Feature parentFeature)
 Set the internal parent feature of the feature being edited to external More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe double AnalysisSpacing [get, set]
 Returns or sets the distance between points on the path used to check twist rate or surface angle. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.AngleRuleTypes 
AngleRule [get, set]
 Returns or sets the indication of how angles are to be measured. More...
 
unsafe NXOpen.NXColor Color [get, set]
 Returns or sets the default color to use for the current ship structure type, only used if the ColorOption is NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorType.Set . More...
 
unsafe
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorType 
ColorOption [get, set]
 Returns or sets the color option of the current ship structure type. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.DisplayType 
DisplayOption [get, set]
 Returns or sets the profile system display solid option. More...
 
unsafe
NXOpen.Preferences.PartObject.LineFontType 
Font [get, set]
 Returns or sets the default font to use for the current ship structure type. More...
 
unsafe int Layer [get, set]
 Returns or sets the default layer to use for the current ship structure type. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Types 
ShipStructureType [get, set]
 Returns or sets the ship structure type. More...
 
unsafe NXOpen.NXColor SurfaceAngleAcceptableColor [get, set]
 Returns or sets the surface angle acceptable color. More...
 
unsafe NXOpen.NXColor SurfaceAngleFailureColor [get, set]
 Returns or sets the surface angle failure color. More...
 
unsafe double SurfaceAngleFailureLimit [get, set]
 Returns or sets the surface angle failure limit. More...
 
unsafe NXOpen.NXColor SurfaceAngleWarningColor [get, set]
 Returns or sets the surface angle warning color. More...
 
unsafe double SurfaceAngleWarningLimit [get, set]
 Returns or sets the surface angle warning limit. More...
 
unsafe NXOpen.NXColor TwistRateAcceptableColor [get, set]
 Returns or sets the twist rate acceptable color. More...
 
unsafe NXOpen.NXColor TwistRateFailureColor [get, set]
 Returns or sets the twist rate failure color. More...
 
unsafe double TwistRateFailureLimit [get, set]
 Returns or sets the twist rate failure limit. More...
 
unsafe NXOpen.NXColor TwistRateWarningColor [get, set]
 Returns or sets the twist rate warning color. More...
 
unsafe double TwistRateWarningLimit [get, set]
 Returns or sets the twist rate warning limit. More...
 
unsafe
NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Types 
Type [get, set]
 Returns or sets the ship structure type. More...
 
unsafe
NXOpen.Preferences.PartObject.WidthType 
Width [get, set]
 Returns or sets the default width to use for the current ship structure type. More...
 
- Properties inherited from NXOpen.Features.FeatureBuilder
unsafe bool ParentFeatureInternal [get, set]
 Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder which is used to change default object display settings for ship structures.

To create a new instance of this class, use NXOpen.Features.ShipCollection.CreateShipDesignPreferencesBuilder

Default values.

Property Value

AnalysisSpacing

100

AngleRule

RightHand

ColorOption

Default

Layer

0

SurfaceAngleFailureLimit

20

SurfaceAngleWarningLimit

10

TwistRateFailureLimit

3

TwistRateWarningLimit

1

Created in NX8.0.0

Member Enumeration Documentation

The methods that can be used to measure angles in ship design.

Enumerator
RightHand 

Angle is measured using the right hand rule system.

ShipOrientation 

Angle direction and reference position is determined by the location in the ship.

the color option type

Enumerator
Default 

default type

Set 

set color type

display profile system curve and body.

Enumerator
Curve 

Use the values entered as display profile system curve.

CurveAndSolid 

e the values entered as display profile system curve and body.

This enum represents the ship structure types.

Enumerator
Hull 

Hull type

Deck 

Deck type

TransverseBulkhead 

Transverse Bulkhead type

LongitudinalBulkhead 

Longitudinal Bulkhead type

GenericPlateSystem 

Generic Plate System type

StiffenerSystem 

Stiffener System type

EdgeReinforcementSystem 

Edge Reinforcement System type

PillarSystem 

Pillar System type

ScantlingSeam 

Scantling Seam type

ErectionSeam 

Erection Seam type

StrakingSeam 

Straking Seam type

IntersectionSeam 

Intersection Seam type

Bracket 

Bracket type

CollarPlate 

Collar Plate type

Member Function Documentation

unsafe void NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ApplyDisplayOption ( )
inline

Apply profile system display option.

Created in NX12.0.1

License requirements: nx_ship_basic ("Ship Basic Design")

Property Documentation

unsafe double NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.AnalysisSpacing
getset

Returns or sets the distance between points on the path used to check twist rate or surface angle.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.AngleRuleTypes NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.AngleRule
getset

Returns or sets the indication of how angles are to be measured.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Color
getset

Returns or sets the default color to use for the current ship structure type, only used if the ColorOption is NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorType.Set .

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorType NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ColorOption
getset

Returns or sets the color option of the current ship structure type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.DisplayType NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.DisplayOption
getset

Returns or sets the profile system display solid option.

Created in NX12.0.1

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design")

unsafe NXOpen.Preferences.PartObject.LineFontType NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Font
getset

Returns or sets the default font to use for the current ship structure type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe int NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Layer
getset

Returns or sets the default layer to use for the current ship structure type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Types NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ShipStructureType
getset
unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.SurfaceAngleAcceptableColor
getset

Returns or sets the surface angle acceptable color.

All analysis that has a angle from the surface normal to the web lower than the surface angle warning limit will be displayed in this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.SurfaceAngleFailureColor
getset

Returns or sets the surface angle failure color.

All analysis that has a angle between the surface normal and the web exceeding the surface angle failure limit will be displayed in this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe double NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.SurfaceAngleFailureLimit
getset

Returns or sets the surface angle failure limit.

If the angle between the surface normal and the web exceeds this value the analysis will be display with the surface angle failure color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.SurfaceAngleWarningColor
getset

Returns or sets the surface angle warning color.

All analysis that has a angle between the surface normal and the web exceeding the surface angle warning limit will be displayed in this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe double NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.SurfaceAngleWarningLimit
getset

Returns or sets the surface angle warning limit.

If the angle between the surface normal and the web exceeds this value the analysis will be display with the surface angle warning color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.TwistRateAcceptableColor
getset

Returns or sets the twist rate acceptable color.

All analysis that has a twist rate lower than the twist rate warning limit will be displayed in this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.TwistRateFailureColor
getset

Returns or sets the twist rate failure color.

All analysis that exceeds the twist rate failure limit will be displayed using this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe double NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.TwistRateFailureLimit
getset

Returns or sets the twist rate failure limit.

If the twist rate exceeds this value the analysis will be display with the twist rate failure color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.NXColor NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.TwistRateWarningColor
getset

Returns or sets the twist rate warning color.

All analysis that exceeds the twist rate warning limit will be displayed using this color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe double NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.TwistRateWarningLimit
getset

Returns or sets the twist rate warning limit.

If the twist rate exceeds this value the analysis will be display with the twist rate warning color.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Types NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Type
getset

Returns or sets the ship structure type.

Created in NX8.0.0

Deprecated in NX9.0.0. Get the active ship structure using NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.ShipStructureType .

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Preferences.PartObject.WidthType NXOpen.Features.ShipDesign.ShipDesignPreferencesBuilder.Width
getset

Returns or sets the default width to use for the current ship structure type.

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")


The documentation for this class was generated from the following file:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.