Represents a PID::InstrumentationSymbol and PID::Instrumentation builder
To create a new instance of this class, use NXOpen::PID::PidManager::CreateInstrumentationBuilder
Default values. More...

Inheritance diagram for NXOpen::PID::InstrumentationBuilder:

Public Member Functions
NXString	ControlLoopName ()
	Returns the control loop name. More...

void	Detach ()
	Detaches the instrumentation from its attachments. More...

NXString	FunctionId ()
	Returns the function Created in NX1847.0.0. More...

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

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

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

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

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

NXOpen::PID::InstrumentationType	InstrumentationType ()
	Returns the instrumentation type Created in NX1847.0.0. More...

NXOpen::Diagramming::DiagrammingArrowtype	LeaderArrowhead ()
	Returns the arrow type of the end arrow. More...

double	LeaderStubLength ()
	Returns the stub length of this leader line. More...

NXOpen::Diagramming::DiagrammingStubsides	LeaderStubSide ()
	Returns the stub sides of this leader line. More...

bool	LeaderUsed ()
	Returns the option to use leader. More...

NXString	MeasurementVariable ()
	Returns the measured variable Created in NX1847.0.0. More...

NXOpen::PLAS::Run *	OwningControlLoop ()
	Returns the control loop. More...

NXOpen::PID::InstrumentationControlLoopType	OwningControlLoopType ()
	Returns the owning control loop option Created in NX1847.0.0. More...

void	SetAttachedInstrumentSymbol (const NXString &fromPortId, NXOpen::NXObject *toInstrumentSymbol, const NXString &toPortId)
	Set the attached instrument symbol. More...

void	SetAttachedInstrumentSymbol (const char fromPortId, NXOpen::NXObject toInstrumentSymbol, const char *toPortId)
	Set the attached instrument symbol. More...

void	SetControlLoopName (const NXString &controlLoopName)
	Sets the control loop name. More...

void	SetControlLoopName (const char *controlLoopName)
	Sets the control loop name. More...

void	SetFunctionId (const NXString &functionId)
	Sets the function Created in NX1847.0.0. More...

void	SetFunctionId (const char *functionId)
	Sets the function Created in NX1847.0.0. More...

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

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

void	SetInstrumentationType (NXOpen::PID::InstrumentationType type)
	Sets the instrumentation type Created in NX1847.0.0. More...

void	SetLeaderArrowhead (NXOpen::Diagramming::DiagrammingArrowtype arrowTypeOption)
	Sets the arrow type of the end arrow. More...

void	SetLeaderStubLength (double stubLength)
	Sets the stub length of this leader line. More...

void	SetLeaderStubSide (NXOpen::Diagramming::DiagrammingStubsides stubSides)
	Sets the stub sides of this leader line. More...

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

void	SetLeaderUsed (bool isLeaderUsed)
	Sets the option to use leader. More...

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

void	SetMeasurementVariable (const NXString &measurementVariable)
	Sets the measured variable Created in NX1847.0.0. More...

void	SetMeasurementVariable (const char *measurementVariable)
	Sets the measured variable Created in NX1847.0.0. More...

void	SetOwningControlLoop (NXOpen::PLAS::Run *controlLoop)
	Sets the control loop. More...

void	SetOwningControlLoopType (NXOpen::PID::InstrumentationControlLoopType type)
	Sets the owning control loop option Created in NX1847.0.0. More...

void	SetSymbolSize (double symbolSize)
	Sets the symbol size Created in NX1847.0.0. More...

void	SetSymbolType (NXOpen::PID::InstrumentationSymbolType symbolType)
	Sets the symbol type Created in NX1847.0.0. More...

double	SymbolSize ()
	Returns the symbol size Created in NX1847.0.0. More...

NXOpen::PID::InstrumentationSymbolType	SymbolType ()
	Returns the symbol type Created in NX1847.0.0. More...

NXOpen::Diagramming::TextStyleBuilder *	TextStyle ()
	Returns the text style Created in NX1847.0.0. 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

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

NXString NXOpen::PID::InstrumentationBuilder::ControlLoopName ( )

Returns the control loop name.

Used under native mode or instrumentation lightweight mode.
Created in NX1847.0.0.

License requirements : None

void NXOpen::PID::InstrumentationBuilder::Detach ( )

Detaches the instrumentation from its attachments.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol
Created in NX1847.0.0.

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

NXString NXOpen::PID::InstrumentationBuilder::FunctionId ( )

Returns the function
Created in NX1847.0.0.

License requirements : None

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

Gets connection location for the inline symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol 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	connectionid
segementId	segementid
percent	percent

void NXOpen::PID::InstrumentationBuilder::GetLeaderTerminator	(	NXOpen::Diagramming::SheetElement **	reference,
		NXOpen::Point2d *	point,
		int *	connectionSegementId
	)

Gets the reference object and point of the instrumentation annotation.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

License requirements : None

Parameters

reference	reference
point	the instrumentation annotation's leader point.
connectionSegementId	connectionsegementid

NXOpen::Point2d NXOpen::PID::InstrumentationBuilder::GetLocation ( )

Gets the instrumentation location.

Returns: the instrumentation location.
Created in NX1847.0.0.

License requirements : None

void NXOpen::PID::InstrumentationBuilder::GetNewInlineConnection	(	NXOpen::NXObject **	pipe,
		NXString *	connectionId
	)

Gets new pipe after inserting an inline symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol 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	connectionid

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

Get the node object of the instrumentation.

Created in NX1847.0.0.

License requirements : None

NXOpen::PID::InstrumentationType NXOpen::PID::InstrumentationBuilder::InstrumentationType ( )

Returns the instrumentation type
Created in NX1847.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingArrowtype NXOpen::PID::InstrumentationBuilder::LeaderArrowhead ( )

Returns the arrow type of the end arrow.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

License requirements : None

double NXOpen::PID::InstrumentationBuilder::LeaderStubLength ( )

Returns the stub length of this leader line.

The negative value is not expected, and only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingStubsides NXOpen::PID::InstrumentationBuilder::LeaderStubSide ( )

Returns the stub sides of this leader line.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

License requirements : None

bool NXOpen::PID::InstrumentationBuilder::LeaderUsed ( )

Returns the option to use leader.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

License requirements : None

NXString NXOpen::PID::InstrumentationBuilder::MeasurementVariable ( )

Returns the measured variable
Created in NX1847.0.0.

License requirements : None

NXOpen::PLAS::Run* NXOpen::PID::InstrumentationBuilder::OwningControlLoop ( )

Returns the control loop.

Used under manager mode or instrumentation non-lightweight mode.
Created in NX1847.0.0.

License requirements : None

NXOpen::PID::InstrumentationControlLoopType NXOpen::PID::InstrumentationBuilder::OwningControlLoopType ( )

Returns the owning control loop option
Created in NX1847.0.0.

License requirements : None

void NXOpen::PID::InstrumentationBuilder::SetAttachedInstrumentSymbol	(	const NXString &	fromPortId,
		NXOpen::NXObject *	toInstrumentSymbol,
		const NXString &	toPortId
	)

Set the attached instrument symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol
Created in NX1847.0.0.

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

Parameters

fromPortId	fromportid
toInstrumentSymbol	NXOpen::PID::InstrumentationSymbol or NXOpen::PID::Instrumentation
toPortId	toportid

void NXOpen::PID::InstrumentationBuilder::SetAttachedInstrumentSymbol	(	const char *	fromPortId,
		NXOpen::NXObject *	toInstrumentSymbol,
		const char *	toPortId
	)

Set the attached instrument symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol
Created in NX1847.0.0.

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

Parameters

fromPortId	fromportid
toInstrumentSymbol	NXOpen::PID::InstrumentationSymbol or NXOpen::PID::Instrumentation
toPortId	toportid

void NXOpen::PID::InstrumentationBuilder::SetControlLoopName ( const NXString & controlLoopName )

Sets the control loop name.

Used under native mode or instrumentation lightweight mode.
Created in NX1847.0.0.

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

Parameters

controlLoopName controlloopname

void NXOpen::PID::InstrumentationBuilder::SetControlLoopName ( const char * controlLoopName )

Sets the control loop name.

Used under native mode or instrumentation lightweight mode.
Created in NX1847.0.0.

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

Parameters

controlLoopName controlloopname

void NXOpen::PID::InstrumentationBuilder::SetFunctionId ( const NXString & functionId )

Sets the function
Created in NX1847.0.0.

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

Parameters

functionId functionid

void NXOpen::PID::InstrumentationBuilder::SetFunctionId ( const char * functionId )

Sets the function
Created in NX1847.0.0.

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

Parameters

functionId functionid

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

Sets connection location for the inline symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol 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	connectionid
segementId	segementid
percent	percent

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

Sets connection location for the inline symbol.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeSymbol 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	connectionid
segementId	segementid
percent	percent

void NXOpen::PID::InstrumentationBuilder::SetInstrumentationType ( NXOpen::PID::InstrumentationType type )

Sets the instrumentation type
Created in NX1847.0.0.

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

Parameters

type type

void NXOpen::PID::InstrumentationBuilder::SetLeaderArrowhead ( NXOpen::Diagramming::DiagrammingArrowtype arrowTypeOption )

Sets the arrow type of the end arrow.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

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

Parameters

arrowTypeOption arrowtypeoption

void NXOpen::PID::InstrumentationBuilder::SetLeaderStubLength ( double stubLength )

Sets the stub length of this leader line.

The negative value is not expected, and only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

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

Parameters

stubLength stublength

void NXOpen::PID::InstrumentationBuilder::SetLeaderStubSide ( NXOpen::Diagramming::DiagrammingStubsides stubSides )

Sets the stub sides of this leader line.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

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

Parameters

stubSides stubsides

void NXOpen::PID::InstrumentationBuilder::SetLeaderTerminator	(	NXOpen::Diagramming::SheetElement *	reference,
		const NXOpen::Point2d &	point,
		int	connectionSegementId
	)

Sets the reference object and point of the instrumentation annotation.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

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

Parameters

reference	reference
point	the instrumentation annotation's leader point.
connectionSegementId	connectionsegementid

void NXOpen::PID::InstrumentationBuilder::SetLeaderUsed ( bool isLeaderUsed )

Sets the option to use leader.

Only used when the instrumentation type is NXOpen::PID::InstrumentationTypeAnnotation
Created in NX1847.0.0.

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

Parameters

isLeaderUsed isleaderused

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

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.

void NXOpen::PID::InstrumentationBuilder::SetMeasurementVariable ( const NXString & measurementVariable )

Sets the measured variable
Created in NX1847.0.0.

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

Parameters

measurementVariable measurementvariable

void NXOpen::PID::InstrumentationBuilder::SetMeasurementVariable ( const char * measurementVariable )

Sets the measured variable
Created in NX1847.0.0.

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

Parameters

measurementVariable measurementvariable

void NXOpen::PID::InstrumentationBuilder::SetOwningControlLoop ( NXOpen::PLAS::Run * controlLoop )

Sets the control loop.

Used under manager mode or instrumentation non-lightweight mode.
Created in NX1847.0.0.

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

Parameters

controlLoop controlloop

void NXOpen::PID::InstrumentationBuilder::SetOwningControlLoopType ( NXOpen::PID::InstrumentationControlLoopType type )

Sets the owning control loop option
Created in NX1847.0.0.

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

Parameters

type type

void NXOpen::PID::InstrumentationBuilder::SetSymbolSize ( double symbolSize )

Sets the symbol size
Created in NX1847.0.0.

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

Parameters

symbolSize symbolsize

void NXOpen::PID::InstrumentationBuilder::SetSymbolType ( NXOpen::PID::InstrumentationSymbolType symbolType )

Sets the symbol type
Created in NX1847.0.0.

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

Parameters

symbolType symboltype

double NXOpen::PID::InstrumentationBuilder::SymbolSize ( )

Returns the symbol size
Created in NX1847.0.0.

License requirements : None

NXOpen::PID::InstrumentationSymbolType NXOpen::PID::InstrumentationBuilder::SymbolType ( )

Returns the symbol type
Created in NX1847.0.0.

License requirements : None

NXOpen::Diagramming::TextStyleBuilder* NXOpen::PID::InstrumentationBuilder::TextStyle ( )

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

Public Member Functions

Detailed Description

Member Function Documentation