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

Inheritance diagram for NXOpen::PID::PortEquipmentBuilder:

Public Member Functions
NXOpen::Diagramming::Port *	ExistingSymbol ()
	Returns the symbol from foundation window. More...

void	GetNode (NXOpen::PID::Equipment *equipment, NXString nodeId)
	Get the node. More...

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

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

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

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

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

NXString	PortId ()
	Returns the current port ID of this port equipment. More...

double	RelativePercentX ()
	Returns the X percentage of location relative to the node. More...

double	RelativePercentY ()
	Returns the Y percentage of location relative to the node. More...

double	RelativeValueX ()
	Returns the X offset value of location relative to the node. More...

double	RelativeValueY ()
	Returns the Y offset value of location relative to the node. 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::Port *existingSymbol)
	Sets the symbol from foundation window. More...

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

void	SetNode (NXOpen::PID::Equipment *equipment, const NXString &nodeId)
	Set the node. More...

void	SetNode (NXOpen::PID::Equipment equipment, const char nodeId)
	Set the node. More...

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

void	SetPortId (const NXString &portId)
	Sets the current port ID of this port equipment. More...

void	SetPortId (const char *portId)
	Sets the current port ID of this port equipment. More...

void	SetRelativePercentX (double percentX)
	Sets the X percentage of location relative to the node. More...

void	SetRelativePercentY (double percentY)
	Sets the Y percentage of location relative to the node. More...

void	SetRelativeValueX (double valueX)
	Sets the X offset value of location relative to the node. More...

void	SetRelativeValueY (double valueY)
	Sets the Y offset value of location relative to the node. 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 port equipment. More...

void	SetSymbolId (const char *symbolId)
	Sets the symbol ID of this port 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 port 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 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

NXOpen::Diagramming::Port* NXOpen::PID::PortEquipmentBuilder::ExistingSymbol ( )

Returns the symbol from foundation window.

It is only applicable when PID::PortEquipmentBuilder::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")

void NXOpen::PID::PortEquipmentBuilder::GetNode	(	NXOpen::PID::Equipment **	equipment,
		NXString *	nodeId
	)

Get the node.

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

equipment	equipment
nodeId	nodeid

NXOpen::Diagramming::Port* NXOpen::PID::PortEquipmentBuilder::GetPort ( )

Get the port object of the PortEquipment builder.

Returns: 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")

NXString NXOpen::PID::PortEquipmentBuilder::Label ( )

Returns the tag of this port 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::PortEquipmentBuilder::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::PortEquipmentBuilder::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")

NXOpen::PID::Sheet* NXOpen::PID::PortEquipmentBuilder::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")

NXString NXOpen::PID::PortEquipmentBuilder::PortId ( )

Returns 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 : nx_pid_design_reader ("NX P and ID Design Reader") OR nx_pid_design_author ("NX P and ID Design Author")

double NXOpen::PID::PortEquipmentBuilder::RelativePercentX ( )

Returns the X percentage of location relative to the node.

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::PortEquipmentBuilder::RelativePercentY ( )

Returns the Y percentage of location relative to the node.

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::PortEquipmentBuilder::RelativeValueX ( )

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

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::PortEquipmentBuilder::RelativeValueY ( )

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

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::PortEquipmentBuilder::Scale ( )

Returns the scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::ScaleX ( )

Returns the x scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::ScaleY ( )

Returns the y scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::SetExistingSymbol ( NXOpen::Diagramming::Port * existingSymbol )

Sets the symbol from foundation window.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::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::PortEquipmentBuilder::SetNode	(	NXOpen::PID::Equipment *	equipment,
		const NXString &	nodeId
	)

Set the node.

Created in NX11.0.1.

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

Parameters

equipment	equipment
nodeId	nodeid

void NXOpen::PID::PortEquipmentBuilder::SetNode	(	NXOpen::PID::Equipment *	equipment,
		const char *	nodeId
	)

Set the node.

Created in NX11.0.1.

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

Parameters

equipment	equipment
nodeId	nodeid

void NXOpen::PID::PortEquipmentBuilder::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::PortEquipmentBuilder::SetPortId ( const NXString & portId )

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 : nx_pid_design_author ("NX P and ID Design Author")

Parameters

portId portid

void NXOpen::PID::PortEquipmentBuilder::SetPortId ( const char * portId )

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 : nx_pid_design_author ("NX P and ID Design Author")

Parameters

portId portid

void NXOpen::PID::PortEquipmentBuilder::SetRelativePercentX ( double percentX )

Sets the X percentage of location relative to the node.

Created in NX11.0.1.

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

Parameters

percentX percentx

void NXOpen::PID::PortEquipmentBuilder::SetRelativePercentY ( double percentY )

Sets the Y percentage of location relative to the node.

Created in NX11.0.1.

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

Parameters

percentY percenty

void NXOpen::PID::PortEquipmentBuilder::SetRelativeValueX ( double valueX )

Sets the X offset value of location relative to the node.

Created in NX11.0.1.

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

Parameters

valueX valuex

void NXOpen::PID::PortEquipmentBuilder::SetRelativeValueY ( double valueY )

Sets the Y offset value of location relative to the node.

Created in NX11.0.1.

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

Parameters

valueY valuey

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

Sets the scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::SetScaleX ( double scaleX )

Sets the x scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::SetScaleY ( double scaleY )

Sets the y scale value.

It is only applicable when PID::PortEquipmentBuilder::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::PortEquipmentBuilder::SetSymbolId ( const NXString & symbolId )

Sets the symbol ID of this port equipment.

It is only applicable when PID::PortEquipmentBuilder::SymbolSourceType is 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::PortEquipmentBuilder::SetSymbolId ( const char * symbolId )

Sets the symbol ID of this port equipment.

It is only applicable when PID::PortEquipmentBuilder::SymbolSourceType is 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::PortEquipmentBuilder::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::PortEquipmentBuilder::SetUseExistingID ( bool useExistingID )

Sets the option to place a duplicate symbol.

It is only applicable when PID::PortEquipmentBuilder::SymbolSourceType is 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::PortEquipmentBuilder::SymbolId ( )

Returns the symbol ID of this port equipment.

It is only applicable when PID::PortEquipmentBuilder::SymbolSourceType is 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::PortEquipmentBuilder::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::PortEquipmentBuilder::UseExistingID ( )

Returns the option to place a duplicate symbol.

It is only applicable when PID::PortEquipmentBuilder::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")

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

PID_PortEquipmentBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation