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. More...

Public Types
enum	ClashType { ClashTypeNone, ClashTypeAInB, ClashTypeBInA, ClashTypeExists, ClashTypeAbutNoClass, ClashTypeAbutBInA, ClashTypeAbutBOutA, ClashTypeInterfere }
	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. More...

typedef NXOpen::Callback0< int >	ShipCustomerEnterApplication
	Defines the callback function whenever an NX application is entered. More...

typedef NXOpen::Callback0< int >	ShipCustomerExitApplication
	Defines the callback function whenever an NX application is exited. More...

Public Member Functions
void	AdvanceProgress (int stepNumber)
	Advances the progress bar. More...

void	AskIntersectionPlates (NXOpen::TaggedObject plate, const std::vector< NXOpen::TaggedObject > &inSheets, double tolerence, std::vector< NXOpen::TaggedObject * > &outElements)
	Gets all intersected plates with the given plates. More...

void	AskPlatesSpatialRelations (NXOpen::TaggedObject hull, const std::vector< NXOpen::TaggedObject > &inSheets, double tolerence, std::vector< int > &elementIndex, std::vector< NXOpen::TaggedObject * > &outElements)
	Gets the spatial relations of the plates based on its positions. More...

NXOpen::ShipDesign::Generator::ClashType	CheckBodyClash (NXOpen::DisplayableObject bodyA, NXOpen::DisplayableObject bodyB)
	Check the clash between two bodys. More...

void	CreateCargo (const std::vector< NXOpen::TaggedObject * > &inSheets, double tolerence, std::vector< NXOpen::TaggedObject * > &outElements)
	Creates the ship cargo body based on the input boundary sheets. More...

void	CreateProgress (int numSteps, const NXString &operationName)
	Creates a progress bar with given title and number of total steps. More...

void	CreateProgress (int numSteps, const char *operationName)
	Creates a progress bar with given title and number of total steps. More...

void	DeleteProgress ()
	Deletes the progress bar. More...

NXOpen::Body *	GetOutlineSheetbody (const std::vector< NXOpen::Body * > &bodies, NXOpen::DatumPlane *datumPlane)
	Get the outline sheet body of input bodies. More...

void	GetSheetsEdgesLaidOnTargetSheet (NXOpen::TaggedObject outSheet, const std::vector< NXOpen::TaggedObject > &inSheets, double tolerence, std::vector< NXOpen::TaggedObject * > &outElements)
	Gets the edges of tool sheet bodies which are laid on a target sheet body Created in NX11.0.2. More...

void	RegisterApplicationCallback (const NXString &name, const NXOpen::ShipDesign::Generator::ShipCustomerEnterApplication &enterCallback, const NXOpen::ShipDesign::Generator::ShipCustomerExitApplication &exitCallback)
	Register application callback when application is entered or exited. More...

void	RegisterApplicationCallback (const char *name, const NXOpen::ShipDesign::Generator::ShipCustomerEnterApplication &enterCallback, const NXOpen::ShipDesign::Generator::ShipCustomerExitApplication &exitCallback)
	Register application callback when application is entered or exited. More...

tag_t	Tag () const
	Returns the tag of this object. 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 Typedef Documentation

typedef NXOpen::Callback0<int> NXOpen::ShipDesign::Generator::ShipCustomerEnterApplication

Defines the callback function whenever an NX application is entered.

Created in NX11.0.2.

License requirements : None

typedef NXOpen::Callback0<int> NXOpen::ShipDesign::Generator::ShipCustomerExitApplication

Defines the callback function whenever an NX application is exited.

Created in NX11.0.2.

License requirements : None

Member Enumeration Documentation

enum NXOpen::ShipDesign::Generator::ClashType

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
ClashTypeNone	There is no clash between two bodies.
ClashTypeAInB	Body a is completly in body b, without abut.
ClashTypeBInA	Body b is completly in body a, without abut.
ClashTypeExists	Clash exists; only this is requested.
ClashTypeAbutNoClass	Bounding topologies abut, in/outside unknown.
ClashTypeAbutBInA	Bounding b topology abuts bounding a topology on the inside.
ClashTypeAbutBOutA	Bounding b topology abuts bounding a topology on the outside.
ClashTypeInterfere	Bounding topologies interfere.

Member Function Documentation

void NXOpen::ShipDesign::Generator::AdvanceProgress ( int stepNumber )

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 stepnumber

void NXOpen::ShipDesign::Generator::AskIntersectionPlates	(	NXOpen::TaggedObject *	plate,
		const std::vector< NXOpen::TaggedObject * > &	inSheets,
		double	tolerence,
		std::vector< NXOpen::TaggedObject * > &	outElements
	)

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	plate
inSheets	insheets
tolerence	tolerence
outElements	outelements

void NXOpen::ShipDesign::Generator::AskPlatesSpatialRelations	(	NXOpen::TaggedObject *	hull,
		const std::vector< NXOpen::TaggedObject * > &	inSheets,
		double	tolerence,
		std::vector< int > &	elementIndex,
		std::vector< NXOpen::TaggedObject * > &	outElements
	)

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	hull
inSheets	insheets
tolerence	tolerence
elementIndex	elementindex
outElements	outelements

NXOpen::ShipDesign::Generator::ClashType NXOpen::ShipDesign::Generator::CheckBodyClash	(	NXOpen::DisplayableObject *	bodyA,
		NXOpen::DisplayableObject *	bodyB
	)

Check the clash between two bodys.

Returns: O: clash status for body a and body b
Created in NX11.0.0.

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

Parameters

bodyA	body a
bodyB	body b

void NXOpen::ShipDesign::Generator::CreateCargo	(	const std::vector< NXOpen::TaggedObject * > &	inSheets,
		double	tolerence,
		std::vector< NXOpen::TaggedObject * > &	outElements
	)

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	insheets
tolerence	tolerence
outElements	outelements

void NXOpen::ShipDesign::Generator::CreateProgress	(	int	numSteps,
		const NXString &	operationName
	)

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	numsteps
operationName	operationname

void NXOpen::ShipDesign::Generator::CreateProgress	(	int	numSteps,
		const char *	operationName
	)

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	numsteps
operationName	operationname

void NXOpen::ShipDesign::Generator::DeleteProgress ( )

Deletes the progress bar.

Created in NX11.0.2.

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

NXOpen::Body* NXOpen::ShipDesign::Generator::GetOutlineSheetbody	(	const std::vector< NXOpen::Body * > &	bodies,
		NXOpen::DatumPlane *	datumPlane
	)

Get the outline sheet body of input bodies.

Returns: O: output outline sheet body
Created in NX11.0.2.

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

Parameters

bodies	bodies
datumPlane	datum plane

void NXOpen::ShipDesign::Generator::GetSheetsEdgesLaidOnTargetSheet	(	NXOpen::TaggedObject *	outSheet,
		const std::vector< NXOpen::TaggedObject * > &	inSheets,
		double	tolerence,
		std::vector< NXOpen::TaggedObject * > &	outElements
	)

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	outsheet
inSheets	insheets
tolerence	tolerence
outElements	outelements

void NXOpen::ShipDesign::Generator::RegisterApplicationCallback	(	const NXString &	name,
		const NXOpen::ShipDesign::Generator::ShipCustomerEnterApplication &	enterCallback,
		const NXOpen::ShipDesign::Generator::ShipCustomerExitApplication &	exitCallback
	)

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

name	The name of the application.
enterCallback	The method called when entering the application
exitCallback	The method called when exiting the application

void NXOpen::ShipDesign::Generator::RegisterApplicationCallback	(	const char *	name,
		const NXOpen::ShipDesign::Generator::ShipCustomerEnterApplication &	enterCallback,
		const NXOpen::ShipDesign::Generator::ShipCustomerExitApplication &	exitCallback
	)

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

name	The name of the application.
enterCallback	The method called when entering the application
exitCallback	The method called when exiting the application

tag_t NXOpen::ShipDesign::Generator::Tag ( ) const

Returns the tag of this object.

The documentation for this class was generated from the following file:

ShipDesign_Generator.hxx

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Member Function Documentation