Represents a PID.InstrumentationSymbol and PID.Instrumentation builder More...

Inheritance diagram for NXOpen.PID.InstrumentationBuilder:

Public Member Functions
unsafe void	Detach ()
	Detaches the instrumentation from its attachments. More...

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

unsafe void	GetLeaderTerminator (out NXOpen.Diagramming.SheetElement reference, out NXOpen.Point2d point, out int connectionSegementId)
	Gets the reference object and point of the instrumentation annotation. More...

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

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

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

unsafe void	SetAttachedInstrumentSymbol (string fromPortId, NXOpen.NXObject toInstrumentSymbol, string toPortId)
	Set the attached instrument symbol. More...

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

unsafe void	SetLeaderTerminator (NXOpen.Diagramming.SheetElement reference, NXOpen.Point2d point, int connectionSegementId)
	Sets the reference object and point of the instrumentation annotation. More...

unsafe void	SetLocation (NXOpen.Point2d location)
	Sets the instrumentation 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 string	ControlLoopName `[get, set]`
	Returns or sets the control loop name. More...

unsafe string	FunctionId `[get, set]`
	Returns or sets the function More...

unsafe NXOpen.PID.InstrumentationType	InstrumentationType `[get, set]`
	Returns or sets the instrumentation type More...

unsafe NXOpen.Diagramming.DiagrammingArrowtype	LeaderArrowhead `[get, set]`
	Returns or sets the arrow type of the end arrow. More...

unsafe double	LeaderStubLength `[get, set]`
	Returns or sets the stub length of this leader line. More...

unsafe NXOpen.Diagramming.DiagrammingStubsides	LeaderStubSide `[get, set]`
	Returns or sets the stub sides of this leader line. More...

unsafe bool	LeaderUsed `[get, set]`
	Returns or sets the option to use leader. More...

unsafe string	MeasurementVariable `[get, set]`
	Returns or sets the measured variable More...

unsafe NXOpen.PLAS.Run	OwningControlLoop `[get, set]`
	Returns or sets the control loop. More...

unsafe NXOpen.PID.InstrumentationControlLoopType	OwningControlLoopType `[get, set]`
	Returns or sets the owning control loop option More...

unsafe double	SymbolSize `[get, set]`
	Returns or sets the symbol size More...

unsafe NXOpen.PID.InstrumentationSymbolType	SymbolType `[get, set]`
	Returns or sets the symbol type More...

unsafe NXOpen.Diagramming.TextStyleBuilder	TextStyle `[get]`
	Returns the text style 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

Represents a PID.InstrumentationSymbol and PID.Instrumentation builder

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

Default values.

Property

Value

SymbolSize

15

Created in NX1847.0.0

Member Function Documentation

unsafe void NXOpen.PID.InstrumentationBuilder.Detach ( )

inline

Detaches the instrumentation from its attachments.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Symbol

Created in NX1847.0.0

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

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

inline

Gets connection location for the inline symbol.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Symbol and the instrument is inserted into one pipe.

Created in NX1847.0.0

License requirements: None.

Parameters

pipe	NXOpen.PID.NativePipe or NXOpen.PID.Pipe
connectionId
segementId
percent

unsafe void NXOpen.PID.InstrumentationBuilder.GetLeaderTerminator	(	out NXOpen.Diagramming.SheetElement	reference,
		out NXOpen.Point2d	point,
		out int	connectionSegementId
	)

inline

Gets the reference object and point of the instrumentation annotation.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.0.0

License requirements: None.

Parameters

reference
point	the instrumentation annotation's leader point.
connectionSegementId

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

inline

Gets the instrumentation location.

Created in NX1847.0.0

License requirements: None.

Returns: the instrumentation location.

unsafe void NXOpen.PID.InstrumentationBuilder.GetNewInlineConnection	(	out NXOpen.NXObject	pipe,
		out string	connectionId
	)

inline

Gets new pipe after inserting an inline symbol.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Symbol and the instrument is inserted into one pipe.

Created in NX1847.0.0

License requirements: None.

Parameters

pipe	NXOpen.PID.NativePipe or NXOpen.PID.Pipe
connectionId

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

inline

Get the node object of the instrumentation.

Created in NX1847.0.0

License requirements: None.

Returns

unsafe void NXOpen.PID.InstrumentationBuilder.SetAttachedInstrumentSymbol	(	string	fromPortId,
		NXOpen.NXObject	toInstrumentSymbol,
		string	toPortId
	)

inline

Set the attached instrument symbol.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Symbol

Created in NX1847.0.0

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

Parameters

fromPortId
toInstrumentSymbol	NXOpen.PID.InstrumentationSymbol or NXOpen.PID.Instrumentation
toPortId

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

inline

Sets connection location for the inline symbol.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Symbol and the instrument is inserted into one pipe.

Created in NX1847.0.0

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

Parameters

pipe	NXOpen.PID.NativePipe or NXOpen.PID.Pipe
connectionId
segementId
percent

unsafe void NXOpen.PID.InstrumentationBuilder.SetLeaderTerminator	(	NXOpen.Diagramming.SheetElement	reference,
		NXOpen.Point2d	point,
		int	connectionSegementId
	)

inline

Sets the reference object and point of the instrumentation annotation.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.0.0

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

Parameters

reference
point	the instrumentation annotation's leader point.
connectionSegementId

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

inline

Sets the instrumentation location.

Created in NX1847.0.0

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

Parameters

location the instrumentation location.

Property Documentation

unsafe string NXOpen.PID.InstrumentationBuilder.ControlLoopName

getset

Returns or sets the control loop name.

Used under native mode or instrumentation lightweight mode.

Created in NX1847.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 string NXOpen.PID.InstrumentationBuilder.FunctionId

getset

Returns or sets the function

Created in NX1847.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 NXOpen.PID.InstrumentationType NXOpen.PID.InstrumentationBuilder.InstrumentationType

getset

Returns or sets the instrumentation type

Created in NX1847.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 NXOpen.Diagramming.DiagrammingArrowtype NXOpen.PID.InstrumentationBuilder.LeaderArrowhead

getset

Returns or sets the arrow type of the end arrow.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.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 double NXOpen.PID.InstrumentationBuilder.LeaderStubLength

getset

Returns or sets the stub length of this leader line.

The negative value is not expected, and only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.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 NXOpen.Diagramming.DiagrammingStubsides NXOpen.PID.InstrumentationBuilder.LeaderStubSide

getset

Returns or sets the stub sides of this leader line.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.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.InstrumentationBuilder.LeaderUsed

getset

Returns or sets the option to use leader.

Only used when the instrumentation type is NXOpen.PID.InstrumentationType.Annotation

Created in NX1847.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 string NXOpen.PID.InstrumentationBuilder.MeasurementVariable

getset

Returns or sets the measured variable

Created in NX1847.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 NXOpen.PLAS.Run NXOpen.PID.InstrumentationBuilder.OwningControlLoop

getset

Returns or sets the control loop.

Used under manager mode or instrumentation non-lightweight mode.

Created in NX1847.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 NXOpen.PID.InstrumentationControlLoopType NXOpen.PID.InstrumentationBuilder.OwningControlLoopType

getset

Returns or sets the owning control loop option

Created in NX1847.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 double NXOpen.PID.InstrumentationBuilder.SymbolSize

getset

Returns or sets the symbol size

Created in NX1847.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 NXOpen.PID.InstrumentationSymbolType NXOpen.PID.InstrumentationBuilder.SymbolType

getset

Returns or sets the symbol type

Created in NX1847.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 NXOpen.Diagramming.TextStyleBuilder NXOpen.PID.InstrumentationBuilder.TextStyle

get

Returns the text style

Created in NX1847.0.0

License requirements: None.

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

PID_InstrumentationBuilder.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation