ControlInputPortBuilder Class¶
-
class
NXOpen.Motion.ControlInputPortBuilder¶ Bases:
NXOpen.Motion.MotionBuilder,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
Motion.ControlPortbuilder specific to control input element.To create a new instance of this class, use
NXOpen.Motion.ControlInputBuilder.CreateControlInputPortBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| Component | Returns or sets the component that is measured by the control input element for the selected variable. |
| Digital | Returns or sets a logical flag to specify whether the element is digital (sampled) or analog. |
| DisplayScale | Returns or sets the icon display scale |
| GroupName | Returns or sets the group name |
| GroupType | Returns or sets the group type |
| Name | Returns or sets the control input port name. |
| SampleRate | Returns the Sample Rate specifies the sampling frequency in samples per second for this element. |
| Tag | Returns the Tag for this object. |
| Variable | Returns or sets the variable that is measured by the control input element. |
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¶
| ControlInputPortBuilderMeasuredComponent Enumeration | the types of components that can be measured by the control input element for the selected variable. |
| ControlInputPortBuilderMeasuredVariable Enumeration | the types of variables that can be measured by the control input element. |
Property Detail¶
Component¶
-
ControlInputPortBuilder.Component¶ Returns or sets the component that is measured by the control input element for the selected variable.
-------------------------------------Getter Method
Signature
ComponentReturns: Return type: NXOpen.Motion.ControlInputPortBuilderMeasuredComponentNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
ComponentParameters: component ( NXOpen.Motion.ControlInputPortBuilderMeasuredComponent) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Digital¶
-
ControlInputPortBuilder.Digital¶ Returns or sets a logical flag to specify whether the element is digital (sampled) or analog.
If TRUE, the element will be considered digital and will require a sample rate.
-------------------------------------Getter Method
Signature
DigitalReturns: Return type: bool New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
DigitalParameters: digital (bool) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Name¶
-
ControlInputPortBuilder.Name¶ Returns or sets the control input port name.
Must be unique across all motion elements.
-------------------------------------Getter Method
Signature
NameReturns: Return type: str New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
NameParameters: name (str) – New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
SampleRate¶
-
ControlInputPortBuilder.SampleRate¶ Returns the Sample Rate specifies the sampling frequency in samples per second for this element.
A value is required if Digital flag is set to TRUE.
-------------------------------------Getter Method
Signature
SampleRateReturns: Return type: NXOpen.ExpressionNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Variable¶
-
ControlInputPortBuilder.Variable¶ Returns or sets the variable that is measured by the control input element.
-------------------------------------Getter Method
Signature
VariableReturns: Return type: NXOpen.Motion.ControlInputPortBuilderMeasuredVariableNew in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
-------------------------------------Setter Method
Signature
VariableParameters: variable ( NXOpen.Motion.ControlInputPortBuilderMeasuredVariable) –New in version NX11.0.0.
License requirements: mechanisms (“MECHANISMS”)
Method Detail¶
Validate¶
-
ControlInputPortBuilder.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.