TypedConnectorFeatureBuilder Class¶
-
class
NXOpen.LineDesigner.
TypedConnectorFeatureBuilder
¶ Bases:
NXOpen.Features.FeatureBuilder
Represents a
LineDesigner.TypedConnectorFeature
Features.FeatureBuilder
To create a new instance of this class, use
NXOpen.LineDesigner.LineDesignerManager.CreateTypedConnectorFeatureBuilder
Default values.
Property Value MismatchBehavior Dontcreatetheconnection New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
ConnectorCompatibleTypeName | Returns or sets the connector compatible type name |
ConnectorDirection | Returns or sets the connector direction |
ConnectorName | Returns or sets the connector name |
ConnectorParallelToObjectDirection | Returns or sets the connector parallel to object direction |
ConnectorPoint | Returns or sets the connector point |
ConnectorTypeName | Returns or sets the connector type name |
MismatchBehavior | Returns or sets the mismatch behavior |
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal |
PatchSolutionFlag | Returns or sets the patch solution flag |
PatchSurfaceFilename | Returns or sets the patch surface filename |
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
Commit | Commits any edits that have been applied to the builder. |
CommitFeature | Commits the feature parameters and creates the feature @return |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetConnectorCompatibleTypeList | Returns the enter text string @return |
GetConnectorExpressionPropagationList | Returns the enter text string @return |
GetFeature | Returns the feature currently being edited by this builder. |
GetObject | Returns the object currently being edited by this builder. |
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited. |
SelectPropagatedExpressions | TODO: fill in a description for this |
SetConnectorCompatibleTypeList | Sets the enter text string |
SetConnectorExpressionPropagationList | Returns the enter text string |
SetNthConnectorExpressionPropagationList | Returns the enter text string |
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited |
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited. |
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ConnectorCompatibleTypeName¶
-
TypedConnectorFeatureBuilder.
ConnectorCompatibleTypeName
¶ Returns or sets the connector compatible type name
-------------------------------------
Getter Method
Signature
ConnectorCompatibleTypeName()
Returns: Return type: str New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorCompatibleTypeName(connectorCompatibleTypeName)
Parameters: connectorCompatibleTypeName (str) – New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ConnectorDirection¶
-
TypedConnectorFeatureBuilder.
ConnectorDirection
¶ Returns or sets the connector direction
-------------------------------------
Getter Method
Signature
ConnectorDirection()
Returns: Return type: NXOpen.Direction
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorDirection(connectorDirection)
Parameters: connectorDirection ( NXOpen.Direction
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ConnectorName¶
-
TypedConnectorFeatureBuilder.
ConnectorName
¶ Returns or sets the connector name
-------------------------------------
Getter Method
Signature
ConnectorName()
Returns: Return type: str New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorName(connectorName)
Parameters: connectorName (str) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ConnectorParallelToObjectDirection¶
-
TypedConnectorFeatureBuilder.
ConnectorParallelToObjectDirection
¶ Returns or sets the connector parallel to object direction
-------------------------------------
Getter Method
Signature
ConnectorParallelToObjectDirection()
Returns: Return type: NXOpen.Direction
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorParallelToObjectDirection(connectorParallelToObjectDirection)
Parameters: connectorParallelToObjectDirection ( NXOpen.Direction
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ConnectorPoint¶
-
TypedConnectorFeatureBuilder.
ConnectorPoint
¶ Returns or sets the connector point
-------------------------------------
Getter Method
Signature
ConnectorPoint()
Returns: Return type: NXOpen.Point
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorPoint(connectorPoint)
Parameters: connectorPoint ( NXOpen.Point
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
ConnectorTypeName¶
-
TypedConnectorFeatureBuilder.
ConnectorTypeName
¶ Returns or sets the connector type name
-------------------------------------
Getter Method
Signature
ConnectorTypeName()
Returns: Return type: str New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
ConnectorTypeName(connectorTypeName)
Parameters: connectorTypeName (str) – New in version NX10.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
MismatchBehavior¶
-
TypedConnectorFeatureBuilder.
MismatchBehavior
¶ Returns or sets the mismatch behavior
-------------------------------------
Getter Method
Signature
MismatchBehavior()
Returns: Return type: NXOpen.LineDesigner.TypedConnectorFeatureBuilderBehaviorOnMismatch
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
-------------------------------------
Setter Method
Signature
MismatchBehavior(mismatchBehavior)
Parameters: mismatchBehavior ( NXOpen.LineDesigner.TypedConnectorFeatureBuilderBehaviorOnMismatch
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Method Detail¶
GetConnectorCompatibleTypeList¶
-
TypedConnectorFeatureBuilder.
GetConnectorCompatibleTypeList
¶ Returns the enter text string
Signature
GetConnectorCompatibleTypeList()
Returns: Return type: list of str New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
GetConnectorExpressionPropagationList¶
-
TypedConnectorFeatureBuilder.
GetConnectorExpressionPropagationList
¶ Returns the enter text string
Signature
GetConnectorExpressionPropagationList()
Returns: Return type: list of NXOpen.Expression
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SelectPropagatedExpressions¶
-
TypedConnectorFeatureBuilder.
SelectPropagatedExpressions
¶ TODO: fill in a description for this
Signature
SelectPropagatedExpressions()
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SetConnectorCompatibleTypeList¶
-
TypedConnectorFeatureBuilder.
SetConnectorCompatibleTypeList
¶ Sets the enter text string
Signature
SetConnectorCompatibleTypeList(connectorCompatibleTypeList)
Parameters: connectorCompatibleTypeList (list of str) – New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SetConnectorExpressionPropagationList¶
-
TypedConnectorFeatureBuilder.
SetConnectorExpressionPropagationList
¶ Returns the enter text string
Signature
SetConnectorExpressionPropagationList(connectorExpressionPropagationList)
Parameters: connectorExpressionPropagationList (list of NXOpen.Expression
) –New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
SetNthConnectorExpressionPropagationList¶
-
TypedConnectorFeatureBuilder.
SetNthConnectorExpressionPropagationList
¶ Returns the enter text string
Signature
SetNthConnectorExpressionPropagationList(nthExpressionPropagationList, connectorExpressionPropagationList)
Parameters: - nthExpressionPropagationList (int) –
- connectorExpressionPropagationList (
NXOpen.Expression
) –
New in version NX9.0.0.
License requirements: ld_line_designer (“FULL LINE DESIGNER”)
Validate¶
-
TypedConnectorFeatureBuilder.
Validate
¶ 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.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.