Builder used to model a piece of Equipment. More...

Inheritance diagram for NXOpen::PID::EquipmentBuilder:

Public Member Functions
void	DetachAllConnections ()
	Detaches the equipment from all attached connections. More...

NXOpen::Diagramming::Node *	ExistingSymbol ()
	Returns the symbol from foundation window. More...

NXOpen::PID::Equipment *	ExistingSymbolLogicalElementRevision ()
	Returns the Logical Element Revision for the symbol. More...

bool	FlipHorizontal ()
	Returns the option to flip the symbol horizontally. More...

bool	FlipVertical ()
	Returns the option to flip the symbol vertically. More...

void	GetInlineSymbolLocation (NXOpen::PID::Pipe *pipe, NXString connectionId, int segementId, double percent)
	Gets connection location for the inline symbol. More...

NXOpen::Point2d	GetLocation ()
	Gets the symbol location. More...

void	GetNewInlineConnection (NXOpen::PID::Pipe *pipe, NXString connectionId)
	Gets new connection after inserting an inline symbol. More...

NXOpen::Diagramming::Node *	GetNode ()
	Get the node object of the equipment builder. More...

NXString	Label ()
	Returns the tag of this equipment. More...

bool	LockAspectRatio ()
	Returns the option to lock the aspect ratio. More...

NXOpen::NXObject *	NeedAttrOwner ()
	Returns the owner of need attributes group. More...

NXString	NodeId ()
	Returns the current node ID of this equipment. More...

NXOpen::PID::Sheet *	OwningSheet ()
	Returns the owning sheet of this sheet element. More...

NXOpen::PID::RotateAngleOption	Rotate ()
	Returns the symbol rotation angle. More...

double	Scale ()
	Returns the scale value. More...

double	ScaleX ()
	Returns the x scale value. More...

double	ScaleY ()
	Returns the y scale value. More...

void	SetExistingSymbol (NXOpen::Diagramming::Node *existingSymbol)
	Sets the symbol from foundation window. More...

void	SetExistingSymbolLogicalElementRevision (NXOpen::PID::Equipment *existingSymbolLogicalElementRevision)
	Sets the Logical Element Revision for the symbol. More...

void	SetFlipHorizontal (bool flipHorizontal)
	Sets the option to flip the symbol horizontally. More...

void	SetFlipVertical (bool flipVertical)
	Sets the option to flip the symbol vertically. More...

void	SetFulfillment (const NXString &symbolID)
	Sets the fulfillment data of the symbol. More...

void	SetFulfillment (const char *symbolID)
	Sets the fulfillment data of the symbol. More...

void	SetInlineSymbolLocation (NXOpen::PID::Pipe *pipe, const NXString &connectionId, int segementId, double percent)
	Sets connection location for the inline symbol. More...

void	SetInlineSymbolLocation (NXOpen::PID::Pipe pipe, const char connectionId, int segementId, double percent)
	Sets connection location for the inline symbol. More...

void	SetLocation (const NXOpen::Point2d &location)
	Sets the symbol location. More...

void	SetLockAspectRatio (bool lockAspectRatio)
	Sets the option to lock the aspect ratio. More...

void	SetNodeId (const NXString &nodeId)
	Sets the current node ID of this equipment. More...

void	SetNodeId (const char *nodeId)
	Sets the current node ID of this equipment. More...

void	SetOwningSheet (NXOpen::PID::Sheet *owningSheet)
	Sets the owning sheet of this sheet element. More...

void	SetRotate (NXOpen::PID::RotateAngleOption rotate)
	Sets the symbol rotation angle. More...

void	SetScale (double scale)
	Sets the scale value. More...

void	SetScaleX (double scaleX)
	Sets the x scale value. More...

void	SetScaleY (double scaleY)
	Sets the y scale value. More...

void	SetSymbolId (const NXString &symbolId)
	Sets the symbol ID of this equipment. More...

void	SetSymbolId (const char *symbolId)
	Sets the symbol ID of this equipment. More...

void	SetSymbolSourceType (NXOpen::PID::SymbolSourceOption symbolSourceType)
	Sets the symbol source type Created in NX11.0.1. More...

void	SetUseExistingID (bool useExistingID)
	Sets the option to place a duplicate symbol. More...

NXString	SymbolId ()
	Returns the symbol ID of this equipment. More...

NXOpen::PID::SymbolSourceOption	SymbolSourceType ()
	Returns the symbol source type Created in NX11.0.1. More...

bool	UseExistingID ()
	Returns the option to place a duplicate symbol. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Builder used to model a piece of Equipment.

To create a new instance of this class, use NXOpen::PID::PidManager::CreateEquipmentBuilder
Default values.

Property

Value

Rotate

Zero

SymbolSourceType

ReuseLibrary

Created in NX11.0.1.

Member Function Documentation

void NXOpen::PID::EquipmentBuilder::DetachAllConnections ( )

Detaches the equipment from all attached connections.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXOpen::Diagramming::Node* NXOpen::PID::EquipmentBuilder::ExistingSymbol ( )

Returns the symbol from foundation window.

It is only applicable when PID::EquipmentBuilder::SymbolSourceType is PID::SymbolSourceOptionExistingSymbol .
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::Equipment* NXOpen::PID::EquipmentBuilder::ExistingSymbolLogicalElementRevision ( )

Returns the Logical Element Revision for the symbol.

It is only applicable when PID::EquipmentBuilder::SymbolSourceType is PID::SymbolSourceOptionLogicalElementRevision .
Created in NX12.0.0.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

bool NXOpen::PID::EquipmentBuilder::FlipHorizontal ( )

Returns the option to flip the symbol horizontally.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

bool NXOpen::PID::EquipmentBuilder::FlipVertical ( )

Returns the option to flip the symbol vertically.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::EquipmentBuilder::GetInlineSymbolLocation	(	NXOpen::PID::Pipe **	pipe,
		NXString *	connectionId,
		int *	segementId,
		double *	percent
	)

Gets connection location for the inline symbol.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Parameters

pipe	pipe
connectionId	connectionid
segementId	segementid
percent	percent

NXOpen::Point2d NXOpen::PID::EquipmentBuilder::GetLocation ( )

Gets the symbol location.

Returns: the symbol location.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::EquipmentBuilder::GetNewInlineConnection	(	NXOpen::PID::Pipe **	pipe,
		NXString *	connectionId
	)

Gets new connection after inserting an inline symbol.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

Parameters

pipe	pipe
connectionId	connectionid

NXOpen::Diagramming::Node* NXOpen::PID::EquipmentBuilder::GetNode ( )

Get the node object of the equipment builder.

Returns: Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

NXString NXOpen::PID::EquipmentBuilder::Label ( )

Returns the tag of this equipment.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

bool NXOpen::PID::EquipmentBuilder::LockAspectRatio ( )

Returns the option to lock the aspect ratio.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::NXObject* NXOpen::PID::EquipmentBuilder::NeedAttrOwner ( )

Returns the owner of need attributes group.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXString NXOpen::PID::EquipmentBuilder::NodeId ( )

Returns the current node ID of this equipment.

It works only in edit mode, it's optional and the first node ID stored in the equipment will be used as default.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::Sheet* NXOpen::PID::EquipmentBuilder::OwningSheet ( )

Returns the owning sheet of this sheet element.

Its setting method works only in creation mode.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::RotateAngleOption NXOpen::PID::EquipmentBuilder::Rotate ( )

Returns the symbol rotation angle.

Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

double NXOpen::PID::EquipmentBuilder::Scale ( )

Returns the scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is true.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

double NXOpen::PID::EquipmentBuilder::ScaleX ( )

Returns the x scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is false.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

double NXOpen::PID::EquipmentBuilder::ScaleY ( )

Returns the y scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is false.
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

void NXOpen::PID::EquipmentBuilder::SetExistingSymbol ( NXOpen::Diagramming::Node * existingSymbol )

Sets the symbol from foundation window.

It is only applicable when PID::EquipmentBuilder::SymbolSourceType is PID::SymbolSourceOptionExistingSymbol .
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

existingSymbol existingsymbol

void NXOpen::PID::EquipmentBuilder::SetExistingSymbolLogicalElementRevision ( NXOpen::PID::Equipment * existingSymbolLogicalElementRevision )

Sets the Logical Element Revision for the symbol.

It is only applicable when PID::EquipmentBuilder::SymbolSourceType is PID::SymbolSourceOptionLogicalElementRevision .
Created in NX12.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

existingSymbolLogicalElementRevision existingsymbollogicalelementrevision

void NXOpen::PID::EquipmentBuilder::SetFlipHorizontal ( bool flipHorizontal )

Sets the option to flip the symbol horizontally.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

flipHorizontal fliphorizontal

void NXOpen::PID::EquipmentBuilder::SetFlipVertical ( bool flipVertical )

Sets the option to flip the symbol vertically.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

flipVertical flipvertical

void NXOpen::PID::EquipmentBuilder::SetFulfillment ( const NXString & symbolID )

Sets the fulfillment data of the symbol.

The input symbol should be a 3D one and in the same category with the entity of the builder
Created in NX12.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

symbolID symbolid

void NXOpen::PID::EquipmentBuilder::SetFulfillment ( const char * symbolID )

Sets the fulfillment data of the symbol.

The input symbol should be a 3D one and in the same category with the entity of the builder
Created in NX12.0.0.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

symbolID symbolid

void NXOpen::PID::EquipmentBuilder::SetInlineSymbolLocation	(	NXOpen::PID::Pipe *	pipe,
		const NXString &	connectionId,
		int	segementId,
		double	percent
	)

Sets connection location for the inline symbol.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

pipe	pipe
connectionId	connectionid
segementId	segementid
percent	percent

void NXOpen::PID::EquipmentBuilder::SetInlineSymbolLocation	(	NXOpen::PID::Pipe *	pipe,
		const char *	connectionId,
		int	segementId,
		double	percent
	)

Sets connection location for the inline symbol.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

pipe	pipe
connectionId	connectionid
segementId	segementid
percent	percent

void NXOpen::PID::EquipmentBuilder::SetLocation ( const NXOpen::Point2d & location )

Sets the symbol location.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

location the symbol location.

void NXOpen::PID::EquipmentBuilder::SetLockAspectRatio ( bool lockAspectRatio )

Sets the option to lock the aspect ratio.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

lockAspectRatio lockaspectratio

void NXOpen::PID::EquipmentBuilder::SetNodeId ( const NXString & nodeId )

Sets the current node ID of this equipment.

It works only in edit mode, it's optional and the first node ID stored in the equipment will be used as default.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

nodeId nodeid

void NXOpen::PID::EquipmentBuilder::SetNodeId ( const char * nodeId )

Sets the current node ID of this equipment.

It works only in edit mode, it's optional and the first node ID stored in the equipment will be used as default.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

nodeId nodeid

void NXOpen::PID::EquipmentBuilder::SetOwningSheet ( NXOpen::PID::Sheet * owningSheet )

Sets the owning sheet of this sheet element.

Its setting method works only in creation mode.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

owningSheet owningsheet

void NXOpen::PID::EquipmentBuilder::SetRotate ( NXOpen::PID::RotateAngleOption rotate )

Sets the symbol rotation angle.

Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

rotate rotate

void NXOpen::PID::EquipmentBuilder::SetScale ( double scale )

Sets the scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is true.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

scale scale

void NXOpen::PID::EquipmentBuilder::SetScaleX ( double scaleX )

Sets the x scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is false.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

scaleX scalex

void NXOpen::PID::EquipmentBuilder::SetScaleY ( double scaleY )

Sets the y scale value.

It is only applicable when PID::EquipmentBuilder::LockAspectRatio is false.
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

scaleY scaley

void NXOpen::PID::EquipmentBuilder::SetSymbolId ( const NXString & symbolId )

Sets the symbol ID of this equipment.

It is only applicable when NXOpen::PID::EquipmentBuilder::SymbolSourceType is NXOpen::PID::SymbolSourceOptionReuseLibrary .
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

symbolId symbolid

void NXOpen::PID::EquipmentBuilder::SetSymbolId ( const char * symbolId )

Sets the symbol ID of this equipment.

It is only applicable when NXOpen::PID::EquipmentBuilder::SymbolSourceType is NXOpen::PID::SymbolSourceOptionReuseLibrary .
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

symbolId symbolid

void NXOpen::PID::EquipmentBuilder::SetSymbolSourceType ( NXOpen::PID::SymbolSourceOption symbolSourceType )

Sets the symbol source type
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

symbolSourceType symbolsourcetype

void NXOpen::PID::EquipmentBuilder::SetUseExistingID ( bool useExistingID )

Sets the option to place a duplicate symbol.

It is only applicable when NXOpen::PID::EquipmentBuilder::SymbolSourceType is NXOpen::PID::SymbolSourceOptionExistingSymbol .
Created in NX11.0.1.

License requirements : nx_pid_design_author ("NX P and ID Design Author")

Parameters

useExistingID useexistingid

NXString NXOpen::PID::EquipmentBuilder::SymbolId ( )

Returns the symbol ID of this equipment.

It is only applicable when NXOpen::PID::EquipmentBuilder::SymbolSourceType is NXOpen::PID::SymbolSourceOptionReuseLibrary .
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

NXOpen::PID::SymbolSourceOption NXOpen::PID::EquipmentBuilder::SymbolSourceType ( )

Returns the symbol source type
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

bool NXOpen::PID::EquipmentBuilder::UseExistingID ( )

Returns the option to place a duplicate symbol.

It is only applicable when NXOpen::PID::EquipmentBuilder::SymbolSourceType is NXOpen::PID::SymbolSourceOptionExistingSymbol .
Created in NX11.0.1.

License requirements : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

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

PID_EquipmentBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation