Builder used to model a piece of Off Sheet Connector. More...

Inheritance diagram for NXOpen::PID::OffSheetConnectorBuilder:

Public Types
enum	StyleOption { StyleOptionSmallFilledArrowOut, StyleOptionSmallFilledArrowIn, StyleOptionBox, StyleOptionChevronOut, StyleOptionChevronIn }
	the style of OSC elements. More...

Public Member Functions
NXString	ElementId ()
	Returns the current element ID of this OSC. More...

void	FlipHorizontally ()
	To flip a off sheet connector horizonally Created in NX11.0.1. More...

void	FlipVertically ()
	To flip a off sheet connector vertically Created in NX11.0.1. More...

void	GetConnection (NXOpen::PID::ConnectionEndType type, NXOpen::PID::Pipe connection, NXString connectionId)
	To get the connection connecting to the OSC sheet element. More...

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

NXOpen::Diagramming::Node *	GetNode ()
	Get the node object of the off sheet connector builder. More...

bool	Horizontal ()
	Returns the option to flip the symbol horizontally. More...

void	LinkOSC (NXOpen::PID::OffSheetConnector *desObject)
	Links to the destination OSC. More...

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

void	Rotate ()
	To rotate a off sheet connector Created in NX11.0.1. More...

NXOpen::PID::RotateAngleOption	RotateOption ()
	Returns the symbol rotation angle. More...

void	SetConnection (NXOpen::PID::ConnectionEndType type, NXOpen::PID::Pipe *connection, const NXString &connectionId)
	To set the connection connecting to the OSC sheet element. More...

void	SetConnection (NXOpen::PID::ConnectionEndType type, NXOpen::PID::Pipe connection, const char connectionId)
	To set the connection connecting to the OSC sheet element. More...

void	SetElementId (const NXString &elementId)
	Sets the current element ID of this OSC. More...

void	SetElementId (const char *elementId)
	Sets the current element ID of this OSC. More...

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

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

void	SetRotateOption (NXOpen::PID::RotateAngleOption rotate)
	Sets the symbol rotation angle. More...

void	SetStyle (NXOpen::PID::OffSheetConnectorBuilder::StyleOption style)
	Sets the style of OSC Created in NX11.0.1. More...

NXOpen::PID::OffSheetConnectorBuilder::StyleOption	Style ()
	Returns the style of OSC Created in NX11.0.1. More...

NXOpen::Diagramming::TextStyleBuilder *	TextStyleBuilder ()
	Returns the text style of the OSC. More...

bool	Vertical ()
	Returns the option to flip the symbol vertically. 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 Off Sheet Connector.

To create a new instance of this class, use NXOpen::PID::PidManager::CreateOffSheetConnectorBuilder
Default values.

Property

Value

RotateOption

Zero

Created in NX11.0.1.

Member Enumeration Documentation

enum NXOpen::PID::OffSheetConnectorBuilder::StyleOption

the style of OSC elements.

Enumerator
StyleOptionSmallFilledArrowOut	small filled arrow out
StyleOptionSmallFilledArrowIn	small filled arrow in
StyleOptionBox	box
StyleOptionChevronOut	chevron out
StyleOptionChevronIn	chevron in

Member Function Documentation

NXString NXOpen::PID::OffSheetConnectorBuilder::ElementId ( )

Returns the current element ID of this OSC.

It works only in edit mode, it's optional and the first element ID stored in the OSC 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")

void NXOpen::PID::OffSheetConnectorBuilder::FlipHorizontally ( )

To flip a off sheet connector horizonally
Created in NX11.0.1.

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

void NXOpen::PID::OffSheetConnectorBuilder::FlipVertically ( )

To flip a off sheet connector vertically
Created in NX11.0.1.

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

void NXOpen::PID::OffSheetConnectorBuilder::GetConnection	(	NXOpen::PID::ConnectionEndType *	type,
		NXOpen::PID::Pipe **	connection,
		NXString *	connectionId
	)

To get the connection connecting to the OSC sheet element.

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

type	type
connection	connection
connectionId	connectionid

NXOpen::Point2d NXOpen::PID::OffSheetConnectorBuilder::GetLocation ( )

Gets the symbol location.

Returns: the symbol location.
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::Diagramming::Node* NXOpen::PID::OffSheetConnectorBuilder::GetNode ( )

Get the node object of the off sheet connector 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")

bool NXOpen::PID::OffSheetConnectorBuilder::Horizontal ( )

Returns the option to flip the symbol horizontally.

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::OffSheetConnectorBuilder::LinkOSC ( NXOpen::PID::OffSheetConnector * desObject )

Links to the destination OSC.

If the input OffSheetConnector is NULL, it means break the existing link.
Created in NX11.0.1.

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

Parameters

desObject desobject

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

void NXOpen::PID::OffSheetConnectorBuilder::Rotate ( )

To rotate a off sheet connector
Created in NX11.0.1.

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

NXOpen::PID::RotateAngleOption NXOpen::PID::OffSheetConnectorBuilder::RotateOption ( )

Returns the symbol rotation angle.

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::OffSheetConnectorBuilder::SetConnection	(	NXOpen::PID::ConnectionEndType	type,
		NXOpen::PID::Pipe *	connection,
		const NXString &	connectionId
	)

To set the connection connecting to the OSC sheet element.

Created in NX11.0.1.

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

Parameters

type	type
connection	connection
connectionId	connectionid

void NXOpen::PID::OffSheetConnectorBuilder::SetConnection	(	NXOpen::PID::ConnectionEndType	type,
		NXOpen::PID::Pipe *	connection,
		const char *	connectionId
	)

To set the connection connecting to the OSC sheet element.

Created in NX11.0.1.

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

Parameters

type	type
connection	connection
connectionId	connectionid

void NXOpen::PID::OffSheetConnectorBuilder::SetElementId ( const NXString & elementId )

Sets the current element ID of this OSC.

It works only in edit mode, it's optional and the first element ID stored in the OSC will be used as default.
Created in NX11.0.1.

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

Parameters

elementId elementid

void NXOpen::PID::OffSheetConnectorBuilder::SetElementId ( const char * elementId )

Sets the current element ID of this OSC.

It works only in edit mode, it's optional and the first element ID stored in the OSC will be used as default.
Created in NX11.0.1.

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

Parameters

elementId elementid

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

Sets the symbol location.

Created in NX11.0.1.

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

Parameters

location the osc location.

void NXOpen::PID::OffSheetConnectorBuilder::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::OffSheetConnectorBuilder::SetRotateOption ( NXOpen::PID::RotateAngleOption rotate )

Sets the symbol rotation angle.

Created in NX11.0.1.

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

Parameters

rotate rotate

void NXOpen::PID::OffSheetConnectorBuilder::SetStyle ( NXOpen::PID::OffSheetConnectorBuilder::StyleOption style )

Sets the style of OSC
Created in NX11.0.1.

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

Parameters

style style

NXOpen::PID::OffSheetConnectorBuilder::StyleOption NXOpen::PID::OffSheetConnectorBuilder::Style ( )

Returns the style of OSC
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::Diagramming::TextStyleBuilder* NXOpen::PID::OffSheetConnectorBuilder::TextStyleBuilder ( )

Returns the text style of the OSC.

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::OffSheetConnectorBuilder::Vertical ( )

Returns the option to flip the symbol vertically.

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

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation