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

Inheritance diagram for NXOpen.PID.PortEquipmentBuilder:

Public Member Functions
unsafe void	GetNode (out NXOpen.PID.Equipment equipment, out string nodeId)
	Get the node. More...

unsafe NXOpen.Diagramming.Port	GetPort ()
	Get the port object of the PortEquipment builder. More...

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

unsafe void	SetNode (NXOpen.PID.Equipment equipment, string nodeId)
	Set the node. 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.Port	ExistingSymbol `[get, set]`
	Returns or sets the symbol from foundation window. More...

unsafe string	Label `[get]`
	Returns the tag of this port 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 NXOpen.PID.Sheet	OwningSheet `[get, set]`
	Returns or sets the owning sheet of this sheet element. More...

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

unsafe double	RelativePercentX `[get, set]`
	Returns or sets the X percentage of location relative to the node. More...

unsafe double	RelativePercentY `[get, set]`
	Returns or sets the Y percentage of location relative to the node. More...

unsafe double	RelativeValueX `[get, set]`
	Returns or sets the X offset value of location relative to the node. More...

unsafe double	RelativeValueY `[get, set]`
	Returns or sets the Y offset value of location relative to the node. 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 port 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...

Additional Inherited Members
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Builder used to model a piece of PortEquipment.

To create a new instance of this class, use NXOpen.PID.PidManager.CreatePortEquipmentBuilder

Default values.

Property

Value

SymbolSourceType

ReuseLibrary

Created in NX11.0.1

Member Function Documentation

unsafe void NXOpen.PID.PortEquipmentBuilder.GetNode	(	out NXOpen.PID.Equipment	equipment,
		out string	nodeId
	)

inline

Get the node.

Created in NX11.0.1

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

Parameters

equipment
nodeId

unsafe NXOpen.Diagramming.Port NXOpen.PID.PortEquipmentBuilder.GetPort ( )

inline

Get the port object of the PortEquipment builder.

Created in NX12.0.0

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

Returns

unsafe void NXOpen.PID.PortEquipmentBuilder.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.1

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

Parameters

symbolID

unsafe void NXOpen.PID.PortEquipmentBuilder.SetNode	(	NXOpen.PID.Equipment	equipment,
		string	nodeId
	)

inline

Set the node.

Created in NX11.0.1

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

Parameters

equipment
nodeId

Property Documentation

unsafe NXOpen.Diagramming.Port NXOpen.PID.PortEquipmentBuilder.ExistingSymbol

getset

Returns or sets the symbol from foundation window.

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

Created in NX11.0.1

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

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

unsafe string NXOpen.PID.PortEquipmentBuilder.Label

get

Returns the tag of this port equipment.

Created in NX11.0.1

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

unsafe bool NXOpen.PID.PortEquipmentBuilder.LockAspectRatio

getset

Returns or sets the option to lock the aspect ratio.

Created in NX11.0.1

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

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

unsafe NXOpen.NXObject NXOpen.PID.PortEquipmentBuilder.NeedAttrOwner

get

Returns the owner of need attributes group.

Created in NX11.0.1

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

unsafe NXOpen.PID.Sheet NXOpen.PID.PortEquipmentBuilder.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: nx_pid_design_author ("NX P and ID Design Author")

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

unsafe string NXOpen.PID.PortEquipmentBuilder.PortId

getset

Returns or sets the current port ID of this port equipment.

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

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.RelativePercentX

getset

Returns or sets the X percentage of location relative to the node.

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.RelativePercentY

getset

Returns or sets the Y percentage of location relative to the node.

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.RelativeValueX

getset

Returns or sets the X offset value of location relative to the node.

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.RelativeValueY

getset

Returns or sets the Y offset value of location relative to the node.

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.Scale

getset

Returns or sets the scale value.

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

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.ScaleX

getset

Returns or sets the x scale value.

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

Created in NX11.0.1

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

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

unsafe double NXOpen.PID.PortEquipmentBuilder.ScaleY

getset

Returns or sets the y scale value.

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

Created in NX11.0.1

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

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

unsafe string NXOpen.PID.PortEquipmentBuilder.SymbolId

getset

Returns or sets the symbol ID of this port equipment.

It is only applicable when PID.PortEquipmentBuilder.SymbolSourceType is PID.SymbolSourceOption.ReuseLibrary .

Created in NX11.0.1

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

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

unsafe NXOpen.PID.SymbolSourceOption NXOpen.PID.PortEquipmentBuilder.SymbolSourceType

getset

Returns or sets the symbol source type

Created in NX11.0.1

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

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

unsafe bool NXOpen.PID.PortEquipmentBuilder.UseExistingID

getset

Returns or sets the option to place a duplicate symbol.

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

Created in NX11.0.1

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

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_PortEquipmentBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation