NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::CAE::CAEConnectionBuilder Class Reference

Represents a NXOpen::CAE::CAEConnectionBuilder which can be used to create 1D connections. More...

Inheritance diagram for NXOpen::CAE::CAEConnectionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  ConnectionTypeEnum {
  ConnectionTypeEnumNodeToNode, ConnectionTypeEnumElemedgeToElemface, ConnectionTypeEnumPointToPoint, ConnectionTypeEnumPointToEdge,
  ConnectionTypeEnumPointToFace, ConnectionTypeEnumEdgeToEdge, ConnectionTypeEnumEdgeToFace
}
 the type of connection to be created More...
 
enum  EdgeToEdgeConnectionMethodTypeEnum { EdgeToEdgeConnectionMethodTypeEnumNodeToNode, EdgeToEdgeConnectionMethodTypeEnumRbe2Rbe3ToElementEdge, EdgeToEdgeConnectionMethodTypeEnumRbe2Rbe3ToElementFace }
 the method of edge to edge connection to be created More...
 
enum  MethodTypeEnum {
  MethodTypeEnumProximity, MethodTypeEnumOrderOfSelection, MethodTypeEnumMeanVector, MethodTypeEnumSortXcoord,
  MethodTypeEnumSortYcoord, MethodTypeEnumSortZcoord, MethodTypeEnumRbe3ToEdgeNodes, MethodTypeEnumRbe3ToFaceNodes
}
 the method of connection to be created More...
 
enum  PointToEdgeConnectionMethodTypeEnum { PointToEdgeConnectionMethodTypeEnumPointToEdge, PointToEdgeConnectionMethodTypeEnumArcToCenter }
 the method of point to edge connection to be created More...
 

Public Member Functions

NXOpen::CAE::CAEConnectionBuilder::EdgeToEdgeConnectionMethodTypeEnum EdgeToEdgeConnectionMethodType ()
 Returns the method type for edge-to-edge connection
Created in NX8.5.0. More...
 
double EdgeTolerance ()
 Returns the option to tune edge tolerance. More...
 
NXOpen::CAE::SelectElementsBuilderElementEdge ()
 Returns the selected element edge(s)
Created in NX6.0.0. More...
 
NXOpen::CAE::SelectElementsBuilderElementFace ()
 Returns the selected element face(s)
Created in NX6.0.0. More...
 
NXOpen::CAE::ElementTypeBuilderElementType ()
 Returns the element type to be created
Created in NX6.0.0. More...
 
NXOpen::CAE::ElementTypeBuilderElementTypeRbe3 ()
 Returns the element type to be created
Created in NX6.0.1. More...
 
int Isedgeprojectableonface ()
 Returns the check is edgbe projectable on face or not before commit at UI level
Created in NX12.0.0. More...
 
int Label ()
 Returns the labeling of elements
Created in NX6.0.0. More...
 
void MeshDensity ()
 The mesh density setting
Created in NX6.0.0. More...
 
NXOpen::CAE::CAEConnectionBuilder::MethodTypeEnum MethodType ()
 Returns the method type for point-point or node-node connections
Created in NX6.0.0. More...
 
bool MidNode ()
 Returns the mid node option
Created in NX6.0.0. More...
 
NXOpen::CAE::CAEConnectionBuilder::PointToEdgeConnectionMethodTypeEnum PointToEdgeConnectionMethodType ()
 Returns the method type for point-to-edge connection
Created in NX12.0.0. More...
 
void SetEdgeToEdgeConnectionMethodType (NXOpen::CAE::CAEConnectionBuilder::EdgeToEdgeConnectionMethodTypeEnum edgeToEdgeConnectionMethodType)
 Sets the method type for edge-to-edge connection
Created in NX8.5.0. More...
 
void SetEdgeTolerance (double edgeTolerance)
 Sets the option to tune edge tolerance. More...
 
void SetLabel (int label)
 Sets the labeling of elements
Created in NX6.0.0. More...
 
void SetMethodType (NXOpen::CAE::CAEConnectionBuilder::MethodTypeEnum methodType)
 Sets the method type for point-point or node-node connections
Created in NX6.0.0. More...
 
void SetMidNode (bool midNode)
 Sets the mid node option
Created in NX6.0.0. More...
 
void SetPointToEdgeConnectionMethodType (NXOpen::CAE::CAEConnectionBuilder::PointToEdgeConnectionMethodTypeEnum pointToEdgeConnectionMethodType)
 Sets the method type for point-to-edge connection
Created in NX12.0.0. More...
 
void SetSourceGroup (NXOpen::CAE::CaeGroup *groupToRef)
 Sets the source group referenced by this connection
Created in NX11.0.0. More...
 
void SetSourceGroupFilterType (int sourceGroupFiltertype)
 Sets the filter type for source group selection
Created in NX12.0.0. More...
 
void SetTargetGroup (NXOpen::CAE::CaeGroup *groupToRef)
 Sets the target group referenced by this connection
Created in NX11.0.0. More...
 
void SetTargetGroupFilterType (int targetGroupFiltertype)
 Sets the filter type for target group selection
Created in NX12.0.0. More...
 
void SetType (NXOpen::CAE::CAEConnectionBuilder::ConnectionTypeEnum connectionType)
 Sets the connection type
Created in NX6.0.0. More...
 
NXOpen::CAE::CaeGroupSourceGroup ()
 Returns the source group referenced by this connection
Created in NX11.0.0. More...
 
int SourceGroupFilterType ()
 Returns the filter type for source group selection
Created in NX12.0.0. More...
 
bool SourceGroupReferenceState ()
 Returns the state defining whether the source of this connection is defined with a group
Created in NX11.0.0. More...
 
NXOpen::CAE::SelectFENodeListSourceNodes ()
 Returns the source Node(s)
Created in NX6.0.0. More...
 
NXOpen::SelectTaggedObjectListSourceSelection ()
 Returns the selected source object(s)
Created in NX6.0.0. More...
 
NXOpen::CAE::CaeGroupTargetGroup ()
 Returns the target group referenced by this connection
Created in NX11.0.0. More...
 
int TargetGroupFilterType ()
 Returns the filter type for target group selection
Created in NX12.0.0. More...
 
bool TargetGroupReferenceState ()
 Returns the state defining whether the target of this connection is defined with a group
Created in NX11.0.0. More...
 
NXOpen::CAE::SelectFENodeListTargetNodes ()
 Returns the target Node(s)
Created in NX6.0.0. More...
 
NXOpen::SelectTaggedObjectListTargetSelection ()
 Returns the selected target object(s)
Created in NX6.0.0. More...
 
NXOpen::CAE::CAEConnectionBuilder::ConnectionTypeEnum Type ()
 Returns the connection type
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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

Represents a NXOpen::CAE::CAEConnectionBuilder which 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:

  1. Node to Node
  2. Element Edge to Element Face

Any call to methods like Builder::GetCommittedObjects or Builder::GetObject returns NULL for the above mentioned two connection types.

To create a new instance of this class, use NXOpen::CAE::CAEConnectionCollection::CreateConnectionBuilder

Created in NX6.0.0.

Member Enumeration Documentation

the type of connection to be created

Enumerator
ConnectionTypeEnumNodeToNode 

between nodes

ConnectionTypeEnumElemedgeToElemface 

between element edges and faces

ConnectionTypeEnumPointToPoint 

between points

ConnectionTypeEnumPointToEdge 

between points and edges

ConnectionTypeEnumPointToFace 

between points and faces

ConnectionTypeEnumEdgeToEdge 

between edges

ConnectionTypeEnumEdgeToFace 

between edges and faces

the method of edge to edge connection to be created

Enumerator
EdgeToEdgeConnectionMethodTypeEnumNodeToNode 

Create elements between nodes on source and target edges.

EdgeToEdgeConnectionMethodTypeEnumRbe2Rbe3ToElementEdge 

Create RBE2 between source node and projected node, and RBE3 between projected node and target edge nodes.

EdgeToEdgeConnectionMethodTypeEnumRbe2Rbe3ToElementFace 

Create RBE2 bewteen source node and projected node, and RBE3 between projected node and target face nodes.

the method of connection to be created

Enumerator
MethodTypeEnumProximity 

Based on proximity.

MethodTypeEnumOrderOfSelection 

In order of selection.

MethodTypeEnumMeanVector 

Based on Mean Vector.

MethodTypeEnumSortXcoord 

Based on sorted X coordinates.

MethodTypeEnumSortYcoord 

Based on sorted Y coordinates.

MethodTypeEnumSortZcoord 

Based on sorted Z coordinates.

MethodTypeEnumRbe3ToEdgeNodes 

Create spider element using projected node and edge nodes.

MethodTypeEnumRbe3ToFaceNodes 

Create spider element using projected node and adjacent face nodes.

the method of point to edge connection to be created

Enumerator
PointToEdgeConnectionMethodTypeEnumPointToEdge 

Create connection between point on source and target edges.

PointToEdgeConnectionMethodTypeEnumArcToCenter 

Create connection between arc or circular edge and its center.

Member Function Documentation

NXOpen::CAE::CAEConnectionBuilder::EdgeToEdgeConnectionMethodTypeEnum NXOpen::CAE::CAEConnectionBuilder::EdgeToEdgeConnectionMethodType ( )

Returns the method type for edge-to-edge connection
Created in NX8.5.0.



License requirements : None

double NXOpen::CAE::CAEConnectionBuilder::EdgeTolerance ( )

Returns the option to tune edge tolerance.


Created in NX8.0.1.

License requirements : None

NXOpen::CAE::SelectElementsBuilder* NXOpen::CAE::CAEConnectionBuilder::ElementEdge ( )

Returns the selected element edge(s)
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::SelectElementsBuilder* NXOpen::CAE::CAEConnectionBuilder::ElementFace ( )

Returns the selected element face(s)
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::ElementTypeBuilder* NXOpen::CAE::CAEConnectionBuilder::ElementType ( )

Returns the element type to be created
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::ElementTypeBuilder* NXOpen::CAE::CAEConnectionBuilder::ElementTypeRbe3 ( )

Returns the element type to be created
Created in NX6.0.1.



License requirements : None

int NXOpen::CAE::CAEConnectionBuilder::Isedgeprojectableonface ( )

Returns the check is edgbe projectable on face or not before commit at UI level
Created in NX12.0.0.



License requirements : None

int NXOpen::CAE::CAEConnectionBuilder::Label ( )

Returns the labeling of elements
Created in NX6.0.0.



License requirements : None

void NXOpen::CAE::CAEConnectionBuilder::MeshDensity ( )

The mesh density setting
Created in NX6.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::CAEConnectionBuilder::MethodTypeEnum NXOpen::CAE::CAEConnectionBuilder::MethodType ( )

Returns the method type for point-point or node-node connections
Created in NX6.0.0.



License requirements : None

bool NXOpen::CAE::CAEConnectionBuilder::MidNode ( )

Returns the mid node option
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::CAEConnectionBuilder::PointToEdgeConnectionMethodTypeEnum NXOpen::CAE::CAEConnectionBuilder::PointToEdgeConnectionMethodType ( )

Returns the method type for point-to-edge connection
Created in NX12.0.0.



License requirements : None

void NXOpen::CAE::CAEConnectionBuilder::SetEdgeToEdgeConnectionMethodType ( NXOpen::CAE::CAEConnectionBuilder::EdgeToEdgeConnectionMethodTypeEnum  edgeToEdgeConnectionMethodType)

Sets the method type for edge-to-edge connection
Created in NX8.5.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
edgeToEdgeConnectionMethodTypeedgetoedgeconnectionmethodtype
void NXOpen::CAE::CAEConnectionBuilder::SetEdgeTolerance ( double  edgeTolerance)

Sets the option to tune edge tolerance.


Created in NX8.0.1.

License requirements : None

Parameters
edgeToleranceedgetolerance
void NXOpen::CAE::CAEConnectionBuilder::SetLabel ( int  label)

Sets the labeling of elements
Created in NX6.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
labellabel
void NXOpen::CAE::CAEConnectionBuilder::SetMethodType ( NXOpen::CAE::CAEConnectionBuilder::MethodTypeEnum  methodType)

Sets the method type for point-point or node-node connections
Created in NX6.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
methodTypemethodtype
void NXOpen::CAE::CAEConnectionBuilder::SetMidNode ( bool  midNode)

Sets the mid node option
Created in NX6.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
midNodemidnode
void NXOpen::CAE::CAEConnectionBuilder::SetPointToEdgeConnectionMethodType ( NXOpen::CAE::CAEConnectionBuilder::PointToEdgeConnectionMethodTypeEnum  pointToEdgeConnectionMethodType)

Sets the method type for point-to-edge connection
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
pointToEdgeConnectionMethodTypepointtoedgeconnectionmethodtype
void NXOpen::CAE::CAEConnectionBuilder::SetSourceGroup ( NXOpen::CAE::CaeGroup groupToRef)

Sets the source group referenced by this connection
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
groupToRefgrouptoref
void NXOpen::CAE::CAEConnectionBuilder::SetSourceGroupFilterType ( int  sourceGroupFiltertype)

Sets the filter type for source group selection
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
sourceGroupFiltertypesourcegroupfiltertype
void NXOpen::CAE::CAEConnectionBuilder::SetTargetGroup ( NXOpen::CAE::CaeGroup groupToRef)

Sets the target group referenced by this connection
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
groupToRefgrouptoref
void NXOpen::CAE::CAEConnectionBuilder::SetTargetGroupFilterType ( int  targetGroupFiltertype)

Sets the filter type for target group selection
Created in NX12.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
targetGroupFiltertypetargetgroupfiltertype
void NXOpen::CAE::CAEConnectionBuilder::SetType ( NXOpen::CAE::CAEConnectionBuilder::ConnectionTypeEnum  connectionType)

Sets the connection type
Created in NX6.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

Parameters
connectionTypeconnectiontype
NXOpen::CAE::CaeGroup* NXOpen::CAE::CAEConnectionBuilder::SourceGroup ( )

Returns the source group referenced by this connection
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

int NXOpen::CAE::CAEConnectionBuilder::SourceGroupFilterType ( )

Returns the filter type for source group selection
Created in NX12.0.0.



License requirements : None

bool NXOpen::CAE::CAEConnectionBuilder::SourceGroupReferenceState ( )

Returns the state defining whether the source of this connection is defined with a group
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::SelectFENodeList* NXOpen::CAE::CAEConnectionBuilder::SourceNodes ( )

Returns the source Node(s)
Created in NX6.0.0.



License requirements : None

NXOpen::SelectTaggedObjectList* NXOpen::CAE::CAEConnectionBuilder::SourceSelection ( )

Returns the selected source object(s)
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::CaeGroup* NXOpen::CAE::CAEConnectionBuilder::TargetGroup ( )

Returns the target group referenced by this connection
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

int NXOpen::CAE::CAEConnectionBuilder::TargetGroupFilterType ( )

Returns the filter type for target group selection
Created in NX12.0.0.



License requirements : None

bool NXOpen::CAE::CAEConnectionBuilder::TargetGroupReferenceState ( )

Returns the state defining whether the target of this connection is defined with a group
Created in NX11.0.0.



License requirements : nx_masterfem ("Finite Element Modeling")

NXOpen::CAE::SelectFENodeList* NXOpen::CAE::CAEConnectionBuilder::TargetNodes ( )

Returns the target Node(s)
Created in NX6.0.0.



License requirements : None

NXOpen::SelectTaggedObjectList* NXOpen::CAE::CAEConnectionBuilder::TargetSelection ( )

Returns the selected target object(s)
Created in NX6.0.0.



License requirements : None

NXOpen::CAE::CAEConnectionBuilder::ConnectionTypeEnum NXOpen::CAE::CAEConnectionBuilder::Type ( )

Returns the connection type
Created in NX6.0.0.



License requirements : None


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