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

Inheritance diagram for NXOpen.PID.EquipmentBuilder:

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

unsafe void	GetInlineSymbolLocation (out NXOpen.PID.Pipe pipe, out string connectionId, out int segementId, out double percent)
	Gets connection location for the inline symbol. More...

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

unsafe void	GetNewInlineConnection (out NXOpen.PID.Pipe pipe, out string connectionId)
	Gets new connection after inserting an inline symbol. More...

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

unsafe void	SetAttachedSymbol (string fromPortId, NXOpen.NXObject toSymbol, string toSymbolNodeSidId, string toSymbolPortId)
	Sets the attached symbol. More...

unsafe void	SetFulfillment (string symbolID)
	Sets the fulfillment data of the symbol. More...

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

unsafe void	SetLocation (NXOpen.Point2d location)
	Sets the symbol location. 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 NXOpen.Diagramming.Node	ExistingSymbol `[get, set]`
	Returns or sets the symbol from foundation window. More...

unsafe NXOpen.PID.Equipment	ExistingSymbolLogicalElementRevision `[get, set]`
	Returns or sets the Logical Element Revision for the symbol. More...

unsafe bool	FlipHorizontal `[get, set]`
	Returns or sets the option to flip the symbol horizontally. More...

unsafe bool	FlipVertical `[get, set]`
	Returns or sets the option to flip the symbol vertically. More...

unsafe string	Label `[get]`
	Returns the tag of this equipment. More...

unsafe bool	LockAspectRatio `[get, set]`
	Returns or sets the option to lock the aspect ratio. More...

unsafe NXOpen.NXObject	NeedAttrOwner `[get]`
	Returns the owner of need attributes group. More...

unsafe string	NodeId `[get, set]`
	Returns or sets the current node ID of this equipment. More...

unsafe NXOpen.PID.Sheet	OwningSheet `[get, set]`
	Returns or sets the owning sheet of this sheet element. More...

unsafe NXOpen.PID.RotateAngleOption	Rotate `[get, set]`
	Returns or sets the symbol rotation angle. More...

unsafe double	Scale `[get, set]`
	Returns or sets the scale value. More...

unsafe double	ScaleX `[get, set]`
	Returns or sets the x scale value. More...

unsafe double	ScaleY `[get, set]`
	Returns or sets the y scale value. More...

unsafe string	SymbolId `[get, set]`
	Returns or sets the symbol ID of this equipment. More...

unsafe NXOpen.PID.SymbolSourceOption	SymbolSourceType `[get, set]`
	Returns or sets the symbol source type More...

unsafe bool	UseExistingID `[get, set]`
	Returns or sets the option to place a duplicate symbol. 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

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

unsafe void NXOpen.PID.EquipmentBuilder.DetachAllConnections ( )

inline

Detaches the equipment from all attached connections.

Created in NX11.0.1

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

unsafe void NXOpen.PID.EquipmentBuilder.GetInlineSymbolLocation	(	out NXOpen.PID.Pipe	pipe,
		out string	connectionId,
		out int	segementId,
		out double	percent
	)

inline

Gets connection location for the inline symbol.

Created in NX11.0.1

License requirements: None.

Parameters

pipe
connectionId
segementId
percent

unsafe NXOpen.Point2d NXOpen.PID.EquipmentBuilder.GetLocation ( )

inline

Gets the symbol location.

Created in NX11.0.1

License requirements: None.

Returns: the symbol location.

unsafe void NXOpen.PID.EquipmentBuilder.GetNewInlineConnection	(	out NXOpen.PID.Pipe	pipe,
		out string	connectionId
	)

inline

Gets new connection after inserting an inline symbol.

Created in NX11.0.1

License requirements: None.

Parameters

pipe
connectionId

unsafe NXOpen.Diagramming.Node NXOpen.PID.EquipmentBuilder.GetNode ( )

inline

Get the node object of the equipment builder.

Created in NX11.0.1

License requirements: None.

Returns

unsafe void NXOpen.PID.EquipmentBuilder.SetAttachedSymbol	(	string	fromPortId,
		NXOpen.NXObject	toSymbol,
		string	toSymbolNodeSidId,
		string	toSymbolPortId
	)

inline

Sets the attached symbol.

Created in NX1847.0.0

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

Parameters

fromPortId	the port id of this equipment symbol for the attachment.
toSymbol	NXOpen.PID.Equipment or NXOpen.PID.NativeEquipment
toSymbolNodeSidId	the node id of the toSymbol.
toSymbolPortId	the port id of the toSymbol for the attachment.

unsafe void NXOpen.PID.EquipmentBuilder.SetFulfillment ( string symbolID )

inline

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

unsafe void NXOpen.PID.EquipmentBuilder.SetInlineSymbolLocation	(	NXOpen.PID.Pipe	pipe,
		string	connectionId,
		int	segementId,
		double	percent
	)

inline

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
connectionId
segementId
percent

unsafe void NXOpen.PID.EquipmentBuilder.SetLocation ( NXOpen.Point2d location )

inline

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.

Property Documentation

unsafe NXOpen.Diagramming.Node NXOpen.PID.EquipmentBuilder.ExistingSymbol

getset

Returns or sets the symbol from foundation window.

It is only applicable when PID.EquipmentBuilder.SymbolSourceType is PID.SymbolSourceOption.ExistingSymbol .

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.Equipment NXOpen.PID.EquipmentBuilder.ExistingSymbolLogicalElementRevision

getset

Returns or sets the Logical Element Revision for the symbol.

It is only applicable when PID.EquipmentBuilder.SymbolSourceType is PID.SymbolSourceOption.LogicalElementRevision .

Created in NX12.0.0

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.EquipmentBuilder.FlipHorizontal

getset

Returns or sets the option to flip the symbol horizontally.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.EquipmentBuilder.FlipVertical

getset

Returns or sets the option to flip the symbol vertically.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe string NXOpen.PID.EquipmentBuilder.Label

get

Returns the tag of this equipment.

Created in NX11.0.1

License requirements: None.

unsafe bool NXOpen.PID.EquipmentBuilder.LockAspectRatio

getset

Returns or sets the option to lock the aspect ratio.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.NXObject NXOpen.PID.EquipmentBuilder.NeedAttrOwner

get

Returns the owner of need attributes group.

Created in NX11.0.1

License requirements: None.

unsafe string NXOpen.PID.EquipmentBuilder.NodeId

getset

Returns or 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 to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.Sheet NXOpen.PID.EquipmentBuilder.OwningSheet

getset

Returns or sets the owning sheet of this sheet element.

Its setting method works only in creation mode.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.RotateAngleOption NXOpen.PID.EquipmentBuilder.Rotate

getset

Returns or sets the symbol rotation angle.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe double NXOpen.PID.EquipmentBuilder.Scale

getset

Returns or sets the scale value.

It is only applicable when PID.EquipmentBuilder.LockAspectRatio is true.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe double NXOpen.PID.EquipmentBuilder.ScaleX

getset

Returns or sets the x scale value.

It is only applicable when PID.EquipmentBuilder.LockAspectRatio is false.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe double NXOpen.PID.EquipmentBuilder.ScaleY

getset

Returns or sets the y scale value.

It is only applicable when PID.EquipmentBuilder.LockAspectRatio is false.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe string NXOpen.PID.EquipmentBuilder.SymbolId

getset

Returns or sets the symbol ID of this equipment.

It is only applicable when NXOpen.PID.EquipmentBuilder.SymbolSourceType is NXOpen.PID.SymbolSourceOption.ReuseLibrary .

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe NXOpen.PID.SymbolSourceOption NXOpen.PID.EquipmentBuilder.SymbolSourceType

getset

Returns or sets the symbol source type

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

unsafe bool NXOpen.PID.EquipmentBuilder.UseExistingID

getset

Returns or sets the option to place a duplicate symbol.

It is only applicable when NXOpen.PID.EquipmentBuilder.SymbolSourceType is NXOpen.PID.SymbolSourceOption.ExistingSymbol .

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: nx_pid_design_author ("NX P and ID Design Author")

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

PID_EquipmentBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation