CAEConnectionBuilder Class¶
-
class
NXOpen.CAE.CAEConnectionBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.CAE.CAEConnectionBuilderwhich can be used to create 1D connections.The commit call on the builder returns connection recipe.
There are following two connections which don’t create connection recipe and the builder returns NULL pointer in these cases:
- Node to Node
- Element Edge to Element Face
Any call to methods like
Builder.GetCommittedObjects()orBuilder.GetObject()returns NULL for the above mentioned two connection types.To create a new instance of this class, use
NXOpen.CAE.CAEConnectionCollection.CreateConnectionBuilder()New in version NX6.0.0.
Properties¶
| Property | Description |
|---|---|
| EdgeToEdgeConnectionMethodType | Returns or sets the method type for edge-to-edge connection |
| EdgeTolerance | Returns or sets the option to tune edge tolerance. |
| ElementEdge | Returns the selected element edge(s) |
| ElementFace | Returns the selected element face(s) |
| ElementType | Returns the element type to be created |
| ElementTypeRbe3 | Returns the element type to be created |
| Isedgeprojectableonface | Returns the check is edgbe projectable on face or not before commit at UI level |
| Label | Returns or sets the labeling of elements |
| MethodType | Returns or sets the method type for point-point or node-node connections |
| MidNode | Returns or sets the mid node option |
| PointToEdgeConnectionMethodType | Returns or sets the method type for point-to-edge connection |
| SourceGroup | Returns or sets the source group referenced by this connection |
| SourceGroupFilterType | Returns or sets the filter type for source group selection |
| SourceGroupReferenceState | Returns the state defining whether the source of this connection is defined with a group |
| SourceNodes | Returns the source Node(s) |
| SourceSelection | Returns the selected source object(s) |
| Tag | Returns the Tag for this object. |
| TargetGroup | Returns or sets the target group referenced by this connection |
| TargetGroupFilterType | Returns or sets the filter type for target group selection |
| TargetGroupReferenceState | Returns the state defining whether the target of this connection is defined with a group |
| TargetNodes | Returns the target Node(s) |
| TargetSelection | Returns the selected target object(s) |
| Type | Returns or sets the connection type |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| 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. |
| GetObject | Returns the object currently being edited by this builder. |
| MeshDensity | The mesh density setting |
| ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| CAEConnectionBuilderConnectionTypeEnum Enumeration | the type of connection to be created |
| CAEConnectionBuilderEdgeToEdgeConnectionMethodTypeEnum Enumeration | the method of edge to edge connection to be created |
| CAEConnectionBuilderMethodTypeEnum Enumeration | the method of connection to be created |
| CAEConnectionBuilderPointToEdgeConnectionMethodTypeEnum Enumeration | the method of point to edge connection to be created |
Property Detail¶
EdgeToEdgeConnectionMethodType¶
-
CAEConnectionBuilder.EdgeToEdgeConnectionMethodType¶ Returns or sets the method type for edge-to-edge connection
-------------------------------------Getter Method
Signature
EdgeToEdgeConnectionMethodTypeReturns: Return type: NXOpen.CAE.CAEConnectionBuilderEdgeToEdgeConnectionMethodTypeEnumNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
EdgeToEdgeConnectionMethodTypeParameters: edgeToEdgeConnectionMethodType ( NXOpen.CAE.CAEConnectionBuilderEdgeToEdgeConnectionMethodTypeEnum) –New in version NX8.5.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
EdgeTolerance¶
-
CAEConnectionBuilder.EdgeTolerance¶ Returns or sets the option to tune edge tolerance.
-------------------------------------Getter Method
Signature
EdgeToleranceReturns: Return type: float New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
EdgeToleranceParameters: edgeTolerance (float) – New in version NX8.0.1.
License requirements: None.
ElementEdge¶
-
CAEConnectionBuilder.ElementEdge¶ Returns the selected element edge(s)
-------------------------------------Getter Method
Signature
ElementEdgeReturns: Return type: NXOpen.CAE.SelectElementsBuilderNew in version NX6.0.0.
License requirements: None.
ElementFace¶
-
CAEConnectionBuilder.ElementFace¶ Returns the selected element face(s)
-------------------------------------Getter Method
Signature
ElementFaceReturns: Return type: NXOpen.CAE.SelectElementsBuilderNew in version NX6.0.0.
License requirements: None.
ElementType¶
-
CAEConnectionBuilder.ElementType¶ Returns the element type to be created
-------------------------------------Getter Method
Signature
ElementTypeReturns: Return type: NXOpen.CAE.ElementTypeBuilderNew in version NX6.0.0.
License requirements: None.
ElementTypeRbe3¶
-
CAEConnectionBuilder.ElementTypeRbe3¶ Returns the element type to be created
-------------------------------------Getter Method
Signature
ElementTypeRbe3Returns: Return type: NXOpen.CAE.ElementTypeBuilderNew in version NX6.0.1.
License requirements: None.
Isedgeprojectableonface¶
-
CAEConnectionBuilder.Isedgeprojectableonface¶ Returns the check is edgbe projectable on face or not before commit at UI level
-------------------------------------Getter Method
Signature
IsedgeprojectableonfaceReturns: Return type: int New in version NX12.0.0.
License requirements: None.
Label¶
-
CAEConnectionBuilder.Label¶ Returns or sets the labeling of elements
-------------------------------------Getter Method
Signature
LabelReturns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LabelParameters: label (int) – New in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
MethodType¶
-
CAEConnectionBuilder.MethodType¶ Returns or sets the method type for point-point or node-node connections
-------------------------------------Getter Method
Signature
MethodTypeReturns: Return type: NXOpen.CAE.CAEConnectionBuilderMethodTypeEnumNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MethodTypeParameters: methodType ( NXOpen.CAE.CAEConnectionBuilderMethodTypeEnum) –New in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
MidNode¶
-
CAEConnectionBuilder.MidNode¶ Returns or sets the mid node option
-------------------------------------Getter Method
Signature
MidNodeReturns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MidNodeParameters: midNode (bool) – New in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
PointToEdgeConnectionMethodType¶
-
CAEConnectionBuilder.PointToEdgeConnectionMethodType¶ Returns or sets the method type for point-to-edge connection
-------------------------------------Getter Method
Signature
PointToEdgeConnectionMethodTypeReturns: Return type: NXOpen.CAE.CAEConnectionBuilderPointToEdgeConnectionMethodTypeEnumNew in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PointToEdgeConnectionMethodTypeParameters: pointToEdgeConnectionMethodType ( NXOpen.CAE.CAEConnectionBuilderPointToEdgeConnectionMethodTypeEnum) –New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SourceGroup¶
-
CAEConnectionBuilder.SourceGroup¶ Returns or sets the source group referenced by this connection
-------------------------------------Getter Method
Signature
SourceGroupReturns: Return type: NXOpen.CAE.CaeGroupNew in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------Setter Method
Signature
SourceGroupParameters: groupToRef ( NXOpen.CAE.CaeGroup) –New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SourceGroupFilterType¶
-
CAEConnectionBuilder.SourceGroupFilterType¶ Returns or sets the filter type for source group selection
-------------------------------------Getter Method
Signature
SourceGroupFilterTypeReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SourceGroupFilterTypeParameters: sourceGroupFiltertype (int) – New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SourceGroupReferenceState¶
-
CAEConnectionBuilder.SourceGroupReferenceState¶ Returns the state defining whether the source of this connection is defined with a group
-------------------------------------Getter Method
Signature
SourceGroupReferenceStateReturns: Return type: bool New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
SourceNodes¶
-
CAEConnectionBuilder.SourceNodes¶ Returns the source Node(s)
-------------------------------------Getter Method
Signature
SourceNodesReturns: Return type: NXOpen.CAE.SelectFENodeListNew in version NX6.0.0.
License requirements: None.
SourceSelection¶
-
CAEConnectionBuilder.SourceSelection¶ Returns the selected source object(s)
-------------------------------------Getter Method
Signature
SourceSelectionReturns: Return type: NXOpen.SelectTaggedObjectListNew in version NX6.0.0.
License requirements: None.
TargetGroup¶
-
CAEConnectionBuilder.TargetGroup¶ Returns or sets the target group referenced by this connection
-------------------------------------Getter Method
Signature
TargetGroupReturns: Return type: NXOpen.CAE.CaeGroupNew in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
-------------------------------------Setter Method
Signature
TargetGroupParameters: groupToRef ( NXOpen.CAE.CaeGroup) –New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
TargetGroupFilterType¶
-
CAEConnectionBuilder.TargetGroupFilterType¶ Returns or sets the filter type for target group selection
-------------------------------------Getter Method
Signature
TargetGroupFilterTypeReturns: Return type: int New in version NX12.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TargetGroupFilterTypeParameters: targetGroupFiltertype (int) – New in version NX12.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
TargetGroupReferenceState¶
-
CAEConnectionBuilder.TargetGroupReferenceState¶ Returns the state defining whether the target of this connection is defined with a group
-------------------------------------Getter Method
Signature
TargetGroupReferenceStateReturns: Return type: bool New in version NX11.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
TargetNodes¶
-
CAEConnectionBuilder.TargetNodes¶ Returns the target Node(s)
-------------------------------------Getter Method
Signature
TargetNodesReturns: Return type: NXOpen.CAE.SelectFENodeListNew in version NX6.0.0.
License requirements: None.
TargetSelection¶
-
CAEConnectionBuilder.TargetSelection¶ Returns the selected target object(s)
-------------------------------------Getter Method
Signature
TargetSelectionReturns: Return type: NXOpen.SelectTaggedObjectListNew in version NX6.0.0.
License requirements: None.
Type¶
-
CAEConnectionBuilder.Type¶ Returns or sets the connection type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.CAE.CAEConnectionBuilderConnectionTypeEnumNew in version NX6.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TypeParameters: connectionType ( NXOpen.CAE.CAEConnectionBuilderConnectionTypeEnum) –New in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Method Detail¶
MeshDensity¶
-
CAEConnectionBuilder.MeshDensity¶ The mesh density setting
Signature
MeshDensity()New in version NX6.0.0.
License requirements: nx_masterfem (“Finite Element Modeling”)
Validate¶
-
CAEConnectionBuilder.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.