NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PID::PreferencesConnectionBuilder Class Reference

Represents a PreferencesConnectionBuilder. More...

Inheritance diagram for NXOpen::PID::PreferencesConnectionBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool AllowNonOrthogonalConnections ()
 Returns the allow non-orthogonal connections. More...
 
double ArrowSize ()
 Returns the arrow size. More...
 
NXOpen::Diagramming::DiagrammingFlowdirectionarrowstyle ArrowStyle ()
 Returns the arrow style. More...
 
double JumperGap ()
 Returns the jumper gap. More...
 
NXOpen::Diagramming::DiagrammingJumperprioritytype JumperPriority ()
 Returns the jumper priority type. More...
 
bool JumperPriorityUseLineType ()
 Returns the jumper priority use line type. More...
 
NXOpen::Diagramming::DiagrammingJumpertype JumperType ()
 Returns the jumper type. More...
 
double MinimumSegmentLength ()
 Returns the minimum segment length. More...
 
void SetAllowNonOrthogonalConnections (bool allowNonOrthogonal)
 Sets the allow non-orthogonal connections. More...
 
void SetArrowSize (double size)
 Sets the arrow size. More...
 
void SetArrowStyle (NXOpen::Diagramming::DiagrammingFlowdirectionarrowstyle style)
 Sets the arrow style. More...
 
void SetJumperGap (double gap)
 Sets the jumper gap. More...
 
void SetJumperPriority (NXOpen::Diagramming::DiagrammingJumperprioritytype jumperPriorityType)
 Sets the jumper priority type. More...
 
void SetJumperPriorityUseLineType (bool useLineType)
 Sets the jumper priority use line type. More...
 
void SetJumperType (NXOpen::Diagramming::DiagrammingJumpertype jumperType)
 Sets the jumper type. More...
 
void SetMinimumSegmentLength (double length)
 Sets the minimum segment length. More...
 
void SetSnapAngle (double angle)
 Sets the snap angle
Created in NX11.0.1. More...
 
void SetTeeSize (double size)
 Sets the tee size. More...
 
double SnapAngle ()
 Returns the snap angle
Created in NX11.0.1. More...
 
double TeeSize ()
 Returns the tee size. 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 PreferencesConnectionBuilder.


Created in NX11.0.1.

Member Function Documentation

bool NXOpen::PID::PreferencesConnectionBuilder::AllowNonOrthogonalConnections ( )

Returns the allow non-orthogonal connections.


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::PreferencesConnectionBuilder::ArrowSize ( )

Returns the arrow size.


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::DiagrammingFlowdirectionarrowstyle NXOpen::PID::PreferencesConnectionBuilder::ArrowStyle ( )

Returns the arrow style.


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::PreferencesConnectionBuilder::JumperGap ( )

Returns the jumper gap.


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::DiagrammingJumperprioritytype NXOpen::PID::PreferencesConnectionBuilder::JumperPriority ( )

Returns the jumper priority 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::PreferencesConnectionBuilder::JumperPriorityUseLineType ( )

Returns the jumper priority use line 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")

NXOpen::Diagramming::DiagrammingJumpertype NXOpen::PID::PreferencesConnectionBuilder::JumperType ( )

Returns the jumper 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")

double NXOpen::PID::PreferencesConnectionBuilder::MinimumSegmentLength ( )

Returns the minimum segment length.


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::PreferencesConnectionBuilder::SetAllowNonOrthogonalConnections ( bool  allowNonOrthogonal)

Sets the allow non-orthogonal connections.


Created in NX11.0.1.

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

Parameters
allowNonOrthogonalallownonorthogonal
void NXOpen::PID::PreferencesConnectionBuilder::SetArrowSize ( double  size)

Sets the arrow size.


Created in NX11.0.1.

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

Parameters
sizesize
void NXOpen::PID::PreferencesConnectionBuilder::SetArrowStyle ( NXOpen::Diagramming::DiagrammingFlowdirectionarrowstyle  style)

Sets the arrow style.


Created in NX11.0.1.

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

Parameters
stylestyle
void NXOpen::PID::PreferencesConnectionBuilder::SetJumperGap ( double  gap)

Sets the jumper gap.


Created in NX11.0.1.

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

Parameters
gapgap
void NXOpen::PID::PreferencesConnectionBuilder::SetJumperPriority ( NXOpen::Diagramming::DiagrammingJumperprioritytype  jumperPriorityType)

Sets the jumper priority type.


Created in NX11.0.1.

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

Parameters
jumperPriorityTypejumperprioritytype
void NXOpen::PID::PreferencesConnectionBuilder::SetJumperPriorityUseLineType ( bool  useLineType)

Sets the jumper priority use line type.


Created in NX11.0.1.

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

Parameters
useLineTypeuselinetype
void NXOpen::PID::PreferencesConnectionBuilder::SetJumperType ( NXOpen::Diagramming::DiagrammingJumpertype  jumperType)

Sets the jumper type.


Created in NX11.0.1.

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

Parameters
jumperTypejumpertype
void NXOpen::PID::PreferencesConnectionBuilder::SetMinimumSegmentLength ( double  length)

Sets the minimum segment length.


Created in NX11.0.1.

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

Parameters
lengthlength
void NXOpen::PID::PreferencesConnectionBuilder::SetSnapAngle ( double  angle)

Sets the snap angle
Created in NX11.0.1.



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

Parameters
angleangle
void NXOpen::PID::PreferencesConnectionBuilder::SetTeeSize ( double  size)

Sets the tee size.


Created in NX11.0.1.

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

Parameters
sizesize
double NXOpen::PID::PreferencesConnectionBuilder::SnapAngle ( )

Returns the snap 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")

double NXOpen::PID::PreferencesConnectionBuilder::TeeSize ( )

Returns the tee size.


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

virtual bool NXOpen::PID::PreferencesConnectionBuilder::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.