TransmitterEntryBuilder Class

class NXOpen.Mechatronics.TransmitterEntryBuilder

Bases: NXOpen.Mechatronics.PhysicsConstraintBuilder

Represents a NXOpen.Mechatronics.TransmitterEntry builder.

To create a new instance of this class, use NXOpen.Mechatronics.TransmitterEntryCollection.CreateTransmitterEntryBuilder()

New in version NX12.0.0.

Properties

Property	Description
Candidate	Returns the source selection. This can be a NXOpen.Mechatronics.RigidBody, NXOpen.Mechatronics.ObjectTransformer or NXOpen.Mechatronics.ObjectSource.
CandidateType	Returns or sets the type of candidate.
CollisionSensor	Returns the detector.
ExecuteOnce	Returns or sets the execute once per activation. If this is true, the transmission will only happen once.
Name	Returns or sets the name.
Port	Returns or sets the port of the sender.
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.
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

TransmitterEntryBuilderTransmitterEntryCandidateType Enumeration

represents the candidate option.

Property Detail

Candidate

TransmitterEntryBuilder.Candidate

Returns the source selection. This can be a NXOpen.Mechatronics.RigidBody, NXOpen.Mechatronics.ObjectTransformer or NXOpen.Mechatronics.ObjectSource.

-------------------------------------

Getter Method

Signature Candidate

Returns: Return type:NXOpen.SelectNXObjectList

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CandidateType

TransmitterEntryBuilder.CandidateType

Returns or sets the type of candidate.

-------------------------------------

Getter Method

Signature CandidateType

Returns: Return type:NXOpen.Mechatronics.TransmitterEntryBuilderTransmitterEntryCandidateType

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CandidateType

Parameters:candType (NXOpen.Mechatronics.TransmitterEntryBuilderTransmitterEntryCandidateType) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CollisionSensor

TransmitterEntryBuilder.CollisionSensor

Returns the detector.

-------------------------------------

Getter Method

Signature CollisionSensor

Returns: Return type:NXOpen.Mechatronics.SelectCollisionSensorList

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ExecuteOnce

TransmitterEntryBuilder.ExecuteOnce

Returns or sets the execute once per activation. If this is true, the transmission will only happen once.

-------------------------------------

Getter Method

Signature ExecuteOnce

Returns: Return type:bool

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature ExecuteOnce

Parameters:executeOnce (bool) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Port

TransmitterEntryBuilder.Port

Returns or sets the port of the sender.

-------------------------------------

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

Method Detail

Validate

TransmitterEntryBuilder.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.