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

Represents Generator which wrap the ship api for china More...

Inheritance diagram for NXOpen.ShipDesign.Generator:
NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

class  _GeneratorShipCustomerEnterApplicationAdapter
 
class  _GeneratorShipCustomerExitApplicationAdapter
 

Public Types

enum  ClashType {
  None, AInB, BInA, Exists,
  AbutNoClass, AbutBInA, AbutBOutA, Interfere
}
 Clash status to indicate to show space position relation between two bodies 1. More...
 

Public Member Functions

unsafe void AdvanceProgress (int stepNumber)
 Advances the progress bar. More...
 
unsafe void AskIntersectionPlates (NXOpen.TaggedObject plate, NXOpen.TaggedObject[] inSheets, double tolerence, out NXOpen.TaggedObject[] outElements)
 Gets all intersected plates with the given plates. More...
 
unsafe void AskPlatesSpatialRelations (NXOpen.TaggedObject hull, NXOpen.TaggedObject[] inSheets, double tolerence, out int[] elementIndex, out NXOpen.TaggedObject[] outElements)
 Gets the spatial relations of the plates based on its positions. More...
 
unsafe
NXOpen.ShipDesign.Generator.ClashType 
CheckBodyClash (NXOpen.DisplayableObject bodyA, NXOpen.DisplayableObject bodyB)
 Check the clash between two bodys. More...
 
unsafe void CreateCargo (NXOpen.TaggedObject[] inSheets, double tolerence, out NXOpen.TaggedObject[] outElements)
 Creates the ship cargo body based on the input boundary sheets. More...
 
unsafe void CreateProgress (int numSteps, string operationName)
 Creates a progress bar with given title and number of total steps. More...
 
unsafe void DeleteProgress ()
 Deletes the progress bar. More...
 
unsafe NXOpen.Body GetOutlineSheetbody (NXOpen.Body[] bodies, NXOpen.DatumPlane datumPlane)
 Get the outline sheet body of input bodies. More...
 
unsafe void GetSheetsEdgesLaidOnTargetSheet (NXOpen.TaggedObject outSheet, NXOpen.TaggedObject[] inSheets, double tolerence, out NXOpen.TaggedObject[] outElements)
 Gets the edges of tool sheet bodies which are laid on a target sheet body More...
 
unsafe void RegisterApplicationCallback (string name, NXOpen.ShipDesign.Generator.ShipCustomerEnterApplication enterCallback, NXOpen.ShipDesign.Generator.ShipCustomerExitApplication exitCallback)
 Register application callback when application is entered or exited. More...
 
delegate int ShipCustomerEnterApplication ()
 Defines the callback function whenever an NX application is entered. More...
 
delegate int ShipCustomerExitApplication ()
 Defines the callback function whenever an NX application is exited. 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

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.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 

Detailed Description

Represents Generator which wrap the ship api for china

To obtain an instance of this class, refer to NXOpen.ShipDesign.ShipSession

Created in NX11.0.0

Member Enumeration Documentation

Clash status to indicate to show space position relation between two bodies 1.

Clashes in entities of the same dimension Clash_interfere Two solid bodies interfere if they share a common volume Two faces interfere if they share a common area, or they intersect. Two edges interfere if they share a common length, or they intersect.

Clash_abut_no_class Two solid bodies abut when they touch, but do not share a common volume. Two faces abut when they share a common curve or point in space which lies on the bounding topology of at least one of the faces. Two edges abut when they share a common point in space which lies on the bounding topology of at least one of the edges.

Clash_a_in_b Clash_b_in_a For solids, faces, and edges, one entity is contained when it lies entirely inside the other entity, and their bounding topologies do not touch. 2.Clashes in bodies of different dimensions Clash_interfere If there is a common point in space that lies within the bounding topology of the two bodies, then the bodies are said to interfere. Clash_abut_no_class If no common point exists, but the bounding topologies of the two bodies touch, then the bodies are said to abut. Clash_a_in_b Clash_b_in_a If one body lies entirely within the bounding topology of the other, and the bounding topology of the two bodies do not touch then the entity is contained.

Enumerator
None 

There is no clash between two bodies.

AInB 

Body a is completly in body b, without abut.

BInA 

Body b is completly in body a, without abut.

Exists 

Clash exists; only this is requested.

AbutNoClass 

Bounding topologies abut, in/outside unknown.

AbutBInA 

Bounding b topology abuts bounding a topology on the inside.

AbutBOutA 

Bounding b topology abuts bounding a topology on the outside.

Interfere 

Bounding topologies interfere.

Member Function Documentation

unsafe void NXOpen.ShipDesign.Generator.AdvanceProgress ( int  stepNumber)
inline

Advances the progress bar.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
stepNumber
unsafe void NXOpen.ShipDesign.Generator.AskIntersectionPlates ( NXOpen.TaggedObject  plate,
NXOpen.TaggedObject[]  inSheets,
double  tolerence,
out NXOpen.TaggedObject[]  outElements 
)
inline

Gets all intersected plates with the given plates.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
plate
inSheets
tolerence
outElements
unsafe void NXOpen.ShipDesign.Generator.AskPlatesSpatialRelations ( NXOpen.TaggedObject  hull,
NXOpen.TaggedObject[]  inSheets,
double  tolerence,
out int[]  elementIndex,
out NXOpen.TaggedObject[]  outElements 
)
inline

Gets the spatial relations of the plates based on its positions.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
hull
inSheets
tolerence
elementIndex
outElements
unsafe NXOpen.ShipDesign.Generator.ClashType NXOpen.ShipDesign.Generator.CheckBodyClash ( NXOpen.DisplayableObject  bodyA,
NXOpen.DisplayableObject  bodyB 
)
inline

Check the clash between two bodys.

Created in NX11.0.0

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
bodyA
bodyB
Returns
O: clash status for body a and body b
unsafe void NXOpen.ShipDesign.Generator.CreateCargo ( NXOpen.TaggedObject[]  inSheets,
double  tolerence,
out NXOpen.TaggedObject[]  outElements 
)
inline

Creates the ship cargo body based on the input boundary sheets.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
inSheets
tolerence
outElements
unsafe void NXOpen.ShipDesign.Generator.CreateProgress ( int  numSteps,
string  operationName 
)
inline

Creates a progress bar with given title and number of total steps.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
numSteps
operationName
unsafe void NXOpen.ShipDesign.Generator.DeleteProgress ( )
inline

Deletes the progress bar.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

unsafe NXOpen.Body NXOpen.ShipDesign.Generator.GetOutlineSheetbody ( NXOpen.Body[]  bodies,
NXOpen.DatumPlane  datumPlane 
)
inline

Get the outline sheet body of input bodies.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
bodies
datumPlane
Returns
O: output outline sheet body
unsafe void NXOpen.ShipDesign.Generator.GetSheetsEdgesLaidOnTargetSheet ( NXOpen.TaggedObject  outSheet,
NXOpen.TaggedObject[]  inSheets,
double  tolerence,
out NXOpen.TaggedObject[]  outElements 
)
inline

Gets the edges of tool sheet bodies which are laid on a target sheet body

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
outSheet
inSheets
tolerence
outElements
unsafe void NXOpen.ShipDesign.Generator.RegisterApplicationCallback ( string  name,
NXOpen.ShipDesign.Generator.ShipCustomerEnterApplication  enterCallback,
NXOpen.ShipDesign.Generator.ShipCustomerExitApplication  exitCallback 
)
inline

Register application callback when application is entered or exited.

It is specific for ship customers.

Created in NX11.0.2

License requirements: nx_ship_basic ("Ship Basic Design") OR nx_ship_detail ("Ship Detail Design")

Parameters
nameThe name of the application.
enterCallbackThe method called when entering the application
exitCallbackThe method called when exiting the application
delegate int NXOpen.ShipDesign.Generator.ShipCustomerEnterApplication ( )

Defines the callback function whenever an NX application is entered.

Created in NX11.0.2

License requirements: None.

delegate int NXOpen.ShipDesign.Generator.ShipCustomerExitApplication ( )

Defines the callback function whenever an NX application is exited.

Created in NX11.0.2

License requirements: None.

Property Documentation

Tag NXOpen.ShipDesign.Generator.Tag
get

Returns the tag of this object.


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