TransmitterExitBuilder Class¶
-
class
NXOpen.Mechatronics.
TransmitterExitBuilder
¶ Bases:
NXOpen.Mechatronics.PhysicsConstraintBuilder
Represents a
NXOpen.Mechatronics.TransmitterExit
builder.To create a new instance of this class, use
NXOpen.Mechatronics.TransmitterExitCollection.CreateTransmitterExitBuilder()
New in version NX12.0.0.
Properties¶
Property | Description |
---|---|
Name | Returns or sets the name. |
Orientation | Returns or sets the initial orientation of receiving objects. |
Port | Returns or sets the port of the receiver. |
Position | Returns or sets the initial position of receiving objects. |
RigidBody | Returns the referenced moving rigid body. This can be a NXOpen.Mechatronics.RigidBody . |
Tag | Returns the Tag for this object. |
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. |
QueryPorts | Query the available ports in the owning part. |
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. |
Property Detail¶
Orientation¶
-
TransmitterExitBuilder.
Orientation
¶ Returns or sets the initial orientation of receiving objects.
-------------------------------------
Getter Method
Signature
Orientation
Returns: Return type: NXOpen.CoordinateSystem
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Orientation
Parameters: orientation ( NXOpen.CoordinateSystem
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Port¶
-
TransmitterExitBuilder.
Port
¶ Returns or sets the port of the receiver.
-------------------------------------
Getter Method
Signature
Port
Returns: Return type: int New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Port
Parameters: port (int) – New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Position¶
-
TransmitterExitBuilder.
Position
¶ Returns or sets the initial position of receiving objects.
-------------------------------------
Getter Method
Signature
Position
Returns: Return type: NXOpen.Point
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Position
Parameters: position ( NXOpen.Point
) –New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
RigidBody¶
-
TransmitterExitBuilder.
RigidBody
¶ Returns the referenced moving rigid body. This can be a
NXOpen.Mechatronics.RigidBody
.-------------------------------------
Getter Method
Signature
RigidBody
Returns: Return type: NXOpen.Mechatronics.SelectRigidBody
New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
QueryPorts¶
-
TransmitterExitBuilder.
QueryPorts
¶ Query the available ports in the owning part.
Signature
QueryPorts()
Returns: Array of available ports. Return type: list of int New in version NX12.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
TransmitterExitBuilder.
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.