public interface ShipPreparationInfo extends TransientObject
ShipPreparationBuilder
.
The following is a description of the class for each ShipPreparationInfo.Types
setting.
If a description is not given for a class property or method, then that property or method is not applicable, except for
toBeDeleted()
is always applicable. This is the way the
data is set up after calling ShipPreparationBuilder.findBasicDesignData(nxopen.assemblies.Component[])
.
ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.LINKED_BODY
.
feature()
returns the linked body feature
if it has been created, null otherwise.sourcePart()
returns the
Component
of the source object.getSourceData()
will output the bodies that are linked by this feature.getLinkedData()
will output the linked bodies once they are created.basicDesignFeature()
returns the Plate System feature that
created the source body.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
.feature()
returns the linked body feature
if it has been created, null otherwise.sourcePart()
returns the
Component
of the source object.target()
returns the
ShipPreparationInfo
that is to be imprinted with this body.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.parent()
returns the
ShipPreparationInfo
that is the parent of this slave feature.getSourceData()
will output the bodies
that are linked by this feature.getLinkedData()
will output the linked
bodies once they are created.basicDesignFeature()
returns
the Bracket feature that created the source body.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.LINKED_EDGES
.
feature()
returns the
composite curve feature if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to include these edges for imprint.targetBody()
returns the body
of the linked body that is being imprinted by these edges. This data is only available when all the linked data is created.parent()
returns the
ShipPreparationInfo
that is the parent of this slave feature. The is also the
linked body containing the edges.getSourceData()
will output the edges that
are gathered by this feature.getLinkedData()
will output the composite
curves once they are created.basicDesignFeature()
returns
the main feature or Sub Systems feature of the plate system.ShipPreparationInfo
that contains the edges that are part of a composite curve
feature.
When ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.LINKED_CURVES
.
feature()
returns the
linked composite curve feature if it has been created, null otherwise.sourcePart()
returns the
Component
of the source object.target()
returns the
ShipPreparationInfo
that is to include these curves for imprint.
Will be null for pillar curves.targetBody()
returns the body
of the linked body that is being imprinted by these curves. This data is only available when all the linked data is created.
Will be null for pillar curves.parent()
returns the
ShipPreparationInfo
that is the parent of this slave feature.getSourceData()
will output the curves that
are linked by this feature.getLinkedData()
will output the linked
curves once they are created.basicDesignFeature()
returns
the main feature or Sub Systems feature of the plate system, the standard part feature, or the pillar feature.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.LINKED_FACES
.
feature()
returns the
linked face feature if it has been created, null otherwise.sourcePart()
returns the
Component
of the source object.target()
returns the
ShipPreparationInfo
of the linked body that is to being imprinted by these base faces.targetBody()
returns the body
of the linked body that is being imprinted by these base faces. This data is only available when all the linked data is created.parent()
returns the
ShipPreparationInfo
that is the parent of this slave feature.getSourceData()
will output the bodies whose faces
are linked by this feature.getLinkedData()
will output the linked
faces once they are created.basicDesignFeature()
returns
the main feature or Sub Systems feature of the stiffener system, or edge reinforcement system.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.PLATE_DIVIDE
.
feature()
returns the plate divide feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.getImprintData()
will output the bodies and curves that will be used for imprint.
This data is only available when all the linked data is created.extendImprints()
and setExtendImprints(boolean)
allows you to indicate if you want
imprints to be extended to the closest edge.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.STIFFENER_DIVIDE
, or
ShipPreparationInfo.Types.STIFFENER_BY_SUPPORT_DIVIDE
.
feature()
returns the profile divide feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.getImprintData()
will output the bodies that will be used for imprint.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
main feature or Sub Systems feature of the stiffener system or edge reinforcement system.extendImprints()
and setExtendImprints(boolean)
allows you to indicate if you want
imprints to be extended to the closest edge.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_DIVIDE
.
feature()
returns the edge reinforcement marking feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to have its edges split with this feature.targetBody()
returns the body
of the linked body that is to have its edges split by this body. This data is only available when all the linked data is created.getImprintData()
will output the bodies that will be used for splitting the edges.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
main feature or Sub Systems feature of the edge reinforcement system.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_EDGES
.
feature()
returns the edge reinforcement marking feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.parent()
returns the
ShipPreparationInfo
that is the parent of this slave feature.getImprintData()
will output the edges that will be labelled.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
edge reinforcement system feature.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.STANDARD_PART_BRACKET_DIVIDE
.
feature()
returns the bracket divide feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.getImprintData()
will output the curves that will be used for imprint.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
standard part bracket feature.extendImprints()
and setExtendImprints(boolean)
allows you to indicate if you want
imprints to be extended to the closest edge.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.BRACKET_DIVIDE
.
feature()
returns the bracket divide feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body. This data is only available when all the linked data is created.getImprintData()
will output the body that will be used for imprint.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
bracket feature.extendImprints()
and setExtendImprints(boolean)
allows you to indicate if you want
imprints to be extended to the closest edge.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.PILLAR
.
feature()
returns the pillar feature
if it has been created, null otherwise.getImprintData()
will output the curves that were linked in for the pillar.
This data is only available when all the linked data is created.basicDesignFeature()
returns the
main feature or Sub Systems of the pillar feature.ShipPreparationInfo.Types
returns
ShipPreparationInfo.Types.USER_DEFINED
.
feature()
returns the plate divide feature
if it has been created, null otherwise.target()
returns the
ShipPreparationInfo
that is to be imprinted with this feature.targetBody()
returns the body
of the linked body that is being imprinted by this body.getImprintData()
will output the bodies and curves that will be used for imprint.basicDesignFeature()
returns the
feature supplied by the user, can be null.extendImprints()
and setExtendImprints(boolean)
allows you to indicate if you want
imprints to be extended to the closest edge.Modifier and Type | Interface and Description |
---|---|
static class |
ShipPreparationInfo.Types
Used to specify the type of object represented in the data.
|
Modifier and Type | Method and Description |
---|---|
Feature |
basicDesignFeature()
Returns the basic design feature related to this information.
|
double |
blendRadius()
Returns the blend radius.
|
boolean |
extendImprints()
Returns the option to extend the imprints.
|
Feature |
feature()
Returns the feature generating this information.
|
NXObject[] |
getImprintData()
Gets the data to be imprinted onto the target plate system.
|
NXObject[] |
getLinkedData()
Gets the linked data of the object.
|
NXObject[] |
getSourceData()
Gets the source data of the object.
|
double |
holeDiameter()
Returns the hole diameter.
|
double |
maximumExtensionDistance()
Returns the maximum distance edges will be extended to completion.
|
ShipPreparationInfo |
parent()
Returns the parent of the Ship Preparation feature.
|
boolean |
removeBlends()
Returns the option to remove blends.
|
boolean |
removeOpenings()
Returns the option to remove openings.
|
void |
setBasicDesignFeature(Feature feature)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setBlendRadius(double blendRadius)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setExtendImprints(boolean extendImprints)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setFeature(Feature feature)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setHoleDiameter(double holeDiameter)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setImprintData(NXObject[] imprintData)
Sets the data to be imprinted onto the target plate system.
|
void |
setMaximumExtensionDistance(double maximumExtensionDistance)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setParent(ShipPreparationInfo parent)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setRemoveBlends(boolean removeBlends)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setRemoveOpenings(boolean removeOpenings)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setSourceData(NXObject[] sourceData)
Sets the source data of the object.
|
void |
setTarget(ShipPreparationInfo target)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setTargetBody(Body targetBody)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setToBeDeleted(boolean toBeDeleted)
License requirements: nx_ship_basic ("Ship Basic Design") . |
void |
setType(ShipPreparationInfo.Types type)
License requirements: nx_ship_basic ("Ship Basic Design") . |
Component |
sourcePart()
Returns the source part file of the linked data.
|
ShipPreparationInfo |
target()
Returns the target FeatureInfo for the divide operation.
|
Body |
targetBody()
Returns the target body for the divide operation.
|
boolean |
toBeDeleted()
Returns the indication if this preparation data should be deleted or not.
|
ShipPreparationInfo.Types |
type()
Returns the type of Ship Preparation feature.
|
_value, dispose, printTestData, printTestData
Feature feature() throws NXException, RemoteException
NXException
RemoteException
void setFeature(Feature feature) throws NXException, RemoteException
feature
- NXException
RemoteException
Feature basicDesignFeature() throws NXException, RemoteException
NXException
RemoteException
void setBasicDesignFeature(Feature feature) throws NXException, RemoteException
feature
- NXException
RemoteException
ShipPreparationInfo.Types type() throws NXException, RemoteException
NXException
RemoteException
void setType(ShipPreparationInfo.Types type) throws NXException, RemoteException
type
- NXException
RemoteException
Component sourcePart() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
,
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
,
ShipPreparationInfo.Types.LINKED_CURVES
, or
ShipPreparationInfo.Types.LINKED_FACES
.
NXException
RemoteException
ShipPreparationInfo parent() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
,
ShipPreparationInfo.Types.LINKED_EDGES
,
ShipPreparationInfo.Types.LINKED_CURVES
,
ShipPreparationInfo.Types.LINKED_FACES
, or
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_EDGES
.
NXException
RemoteException
void setParent(ShipPreparationInfo parent) throws NXException, RemoteException
parent
- NXException
RemoteException
NXObject[] getSourceData() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
,
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
,
ShipPreparationInfo.Types.LINKED_EDGES
,
ShipPreparationInfo.Types.LINKED_CURVES
, or
ShipPreparationInfo.Types.LINKED_FACES
.
NXException
RemoteException
void setSourceData(NXObject[] sourceData) throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
,
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
,
ShipPreparationInfo.Types.LINKED_EDGES
,
ShipPreparationInfo.Types.LINKED_CURVES
, or
ShipPreparationInfo.Types.LINKED_FACES
.
sourceData
- The objects to be linked into the preparation part.NXException
RemoteException
NXObject[] getLinkedData() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
,
ShipPreparationInfo.Types.LINKED_BODY_BRACKET
,
ShipPreparationInfo.Types.LINKED_EDGES
,
ShipPreparationInfo.Types.LINKED_CURVES
, or
ShipPreparationInfo.Types.LINKED_FACES
.
This will only be set after the basic design data has been linked.
NXException
RemoteException
boolean toBeDeleted() throws NXException, RemoteException
NXException
RemoteException
void setToBeDeleted(boolean toBeDeleted) throws NXException, RemoteException
toBeDeleted
- NXException
RemoteException
Body targetBody() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
.
This will typically only be set after the basic design data has been linked.
NXException
RemoteException
void setTargetBody(Body targetBody) throws NXException, RemoteException
targetBody
- NXException
RemoteException
ShipPreparationInfo target() throws NXException, RemoteException
ShipPreparationInfo.Types.LINKED_BODY
.
NXException
RemoteException
void setTarget(ShipPreparationInfo target) throws NXException, RemoteException
target
- NXException
RemoteException
NXObject[] getImprintData() throws NXException, RemoteException
ShipPreparationInfo.Types.PLATE_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_BY_SUPPORT_DIVIDE
,
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_DIVIDE
,
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_EDGES
,
ShipPreparationInfo.Types.STANDARD_PART_BRACKET_DIVIDE
,
ShipPreparationInfo.Types.BRACKET_DIVIDE
, or
ShipPreparationInfo.Types.PILLAR
, or
ShipPreparationInfo.Types.USER_DEFINED
.
Will be curves or bodies. This will typically only be set after the basic design data has been linked.
NXException
RemoteException
void setImprintData(NXObject[] imprintData) throws NXException, RemoteException
ShipPreparationInfo.Types.STIFFENER_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_BY_SUPPORT_DIVIDE
,
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_DIVIDE
,
ShipPreparationInfo.Types.EDGE_REINFORCEMENT_EDGES
,
ShipPreparationInfo.Types.STANDARD_PART_BRACKET_DIVIDE
,
ShipPreparationInfo.Types.BRACKET_DIVIDE
, or
ShipPreparationInfo.Types.PILLAR
, or
ShipPreparationInfo.Types.USER_DEFINED
.
Only curves or bodies are allowed. Curves will be projected normal to the target body for imprint.
imprintData
- The objects that will be imprinted onto the plate system.NXException
RemoteException
boolean removeBlends() throws NXException, RemoteException
blendRadius()
and setBlendRadius(double)
will be removed from plate systems.
Only used when Type is
ShipPreparationInfo.Types.PLATE_DIVIDE
.
NXException
RemoteException
void setRemoveBlends(boolean removeBlends) throws NXException, RemoteException
removeBlends
- NXException
RemoteException
double blendRadius() throws NXException, RemoteException
removeBlends()
and setRemoveBlends(boolean)
is true then blends that
that are less than or equal to this radius will be removed from plate systems. Only used when Type is
ShipPreparationInfo.Types.PLATE_DIVIDE
.
NXException
RemoteException
void setBlendRadius(double blendRadius) throws NXException, RemoteException
blendRadius
- NXException
RemoteException
boolean removeOpenings() throws NXException, RemoteException
holeDiameter()
and setHoleDiameter(double)
will be removed from plate systems.
Only used when Type is
ShipPreparationInfo.Types.PLATE_DIVIDE
.
NXException
RemoteException
void setRemoveOpenings(boolean removeOpenings) throws NXException, RemoteException
removeOpenings
- NXException
RemoteException
double holeDiameter() throws NXException, RemoteException
removeOpenings()
and setRemoveOpenings(boolean)
is true then openings that
fit inside a circle with this diameter will be removed from plate systems. Only used when Type is
ShipPreparationInfo.Types.PLATE_DIVIDE
.
NXException
RemoteException
void setHoleDiameter(double holeDiameter) throws NXException, RemoteException
holeDiameter
- NXException
RemoteException
boolean extendImprints() throws NXException, RemoteException
ShipPreparationInfo.Types.PLATE_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_BY_SUPPORT_DIVIDE
,
ShipPreparationInfo.Types.STANDARD_PART_BRACKET_DIVIDE
,
ShipPreparationInfo.Types.BRACKET_DIVIDE
, or
ShipPreparationInfo.Types.USER_DEFINED
.
NXException
RemoteException
void setExtendImprints(boolean extendImprints) throws NXException, RemoteException
extendImprints
- NXException
RemoteException
double maximumExtensionDistance() throws NXException, RemoteException
extendImprints()
and setExtendImprints(boolean)
is true and
Type is
ShipPreparationInfo.Types.PLATE_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_DIVIDE
,
ShipPreparationInfo.Types.STIFFENER_BY_SUPPORT_DIVIDE
,
ShipPreparationInfo.Types.STANDARD_PART_BRACKET_DIVIDE
,
ShipPreparationInfo.Types.BRACKET_DIVIDE
, or
ShipPreparationInfo.Types.USER_DEFINED
.
NXException
RemoteException
void setMaximumExtensionDistance(double maximumExtensionDistance) throws NXException, RemoteException
maximumExtensionDistance
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.