ForceCalculationBuilder Class¶
-
class
NXOpen.Tooling.
ForceCalculationBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Tooling.ForceCalculationBuilder
Force Calculation Design is to calculate force of processTo create a new instance of this class, use
NXOpen.Tooling.ForceCalculationCollection.CreateForceCalculationBuilder()
Default values.
Property Value CalculationType Normal DecimalPlaces 3 ProcessType AngularBlanking New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
CalculationType | Returns or sets the calculation method. |
CuttingPerimeter | Returns or sets the cutting perimeter length for EDM of the process. |
DecimalPlaces | Returns or sets the decimal places of the calculated force result. |
ForceProcess | Returns the process used to calculate force. |
GravityCenter | Returns or sets the gravity center of the process. |
HoldingForce | Returns or sets the pressure-pad-force of the process. |
Parameter | Returns or sets the parameter expression to calculate the process force. |
ParameterText | Returns or sets the parameter text. |
ProcessFace | Returns the face of the process. |
ProcessForce | Returns or sets the process force of the calculated result. |
ProcessName | Returns or sets the process name. |
ProcessType | Returns or sets the process type. |
Tag | Returns the Tag for this object. |
TotalForce | Returns or sets the total force of the calculated processes . |
TotalForceCenter | Returns or sets the total force center of the calculated processes . |
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¶
ForceCalculationBuilderCalculationTypes Enumeration | The calculation type. |
ForceCalculationBuilderProcessTypes Enumeration | The process type. |
Property Detail¶
CalculationType¶
-
ForceCalculationBuilder.
CalculationType
¶ Returns or sets the calculation method.
-------------------------------------
Getter Method
Signature
CalculationType
Returns: Return type: NXOpen.Tooling.ForceCalculationBuilderCalculationTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalculationType
Parameters: calculationType ( NXOpen.Tooling.ForceCalculationBuilderCalculationTypes
) –New in version NX7.5.0.
License requirements: None.
CuttingPerimeter¶
-
ForceCalculationBuilder.
CuttingPerimeter
¶ Returns or sets the cutting perimeter length for EDM of the process.
-------------------------------------
Getter Method
Signature
CuttingPerimeter
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CuttingPerimeter
Parameters: cuttingPerimeter (str) – Indicates the string of cutting perimeter length New in version NX7.5.0.
License requirements: None.
DecimalPlaces¶
-
ForceCalculationBuilder.
DecimalPlaces
¶ Returns or sets the decimal places of the calculated force result.
-------------------------------------
Getter Method
Signature
DecimalPlaces
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DecimalPlaces
Parameters: decimalPlaces (int) – New in version NX7.5.0.
License requirements: None.
ForceProcess¶
-
ForceCalculationBuilder.
ForceProcess
¶ Returns the process used to calculate force.
-------------------------------------
Getter Method
Signature
ForceProcess
Returns: Return type: NXOpen.SelectFaceList
New in version NX7.5.0.
License requirements: None.
GravityCenter¶
-
ForceCalculationBuilder.
GravityCenter
¶ Returns or sets the gravity center of the process.
-------------------------------------
Getter Method
Signature
GravityCenter
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GravityCenter
Parameters: gravityCenter (str) – Indicates the string of process gravity center New in version NX7.5.0.
License requirements: None.
HoldingForce¶
-
ForceCalculationBuilder.
HoldingForce
¶ Returns or sets the pressure-pad-force of the process.
-------------------------------------
Getter Method
Signature
HoldingForce
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HoldingForce
Parameters: holdingForce (str) – Indicates the string of holding force New in version NX7.5.0.
License requirements: None.
Parameter¶
-
ForceCalculationBuilder.
Parameter
¶ Returns or sets the parameter expression to calculate the process force.
-------------------------------------
Getter Method
Signature
Parameter
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Parameter
Parameters: parameterExp (str) – New in version NX7.5.0.
License requirements: None.
ParameterText¶
-
ForceCalculationBuilder.
ParameterText
¶ Returns or sets the parameter text.
-------------------------------------
Getter Method
Signature
ParameterText
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParameterText
Parameters: parameterText (str) – New in version NX10.0.0.
License requirements: None.
ProcessFace¶
-
ForceCalculationBuilder.
ProcessFace
¶ Returns the face of the process.
-------------------------------------
Getter Method
Signature
ProcessFace
Returns: Return type: NXOpen.ScCollector
New in version NX7.5.0.
License requirements: None.
ProcessForce¶
-
ForceCalculationBuilder.
ProcessForce
¶ Returns or sets the process force of the calculated result.
-------------------------------------
Getter Method
Signature
ProcessForce
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProcessForce
Parameters: processForce (str) – Indicates the string of process force New in version NX7.5.0.
License requirements: None.
ProcessName¶
-
ForceCalculationBuilder.
ProcessName
¶ Returns or sets the process name.
-------------------------------------
Getter Method
Signature
ProcessName
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProcessName
Parameters: processName (str) – New in version NX7.5.0.
License requirements: None.
ProcessType¶
-
ForceCalculationBuilder.
ProcessType
¶ Returns or sets the process type.
-------------------------------------
Getter Method
Signature
ProcessType
Returns: Return type: NXOpen.Tooling.ForceCalculationBuilderProcessTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProcessType
Parameters: processType ( NXOpen.Tooling.ForceCalculationBuilderProcessTypes
) –New in version NX7.5.0.
License requirements: None.
TotalForce¶
-
ForceCalculationBuilder.
TotalForce
¶ Returns or sets the total force of the calculated processes .
-------------------------------------
Getter Method
Signature
TotalForce
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TotalForce
Parameters: totalForce (str) – Indicates the string of total process force New in version NX7.5.0.
License requirements: None.
TotalForceCenter¶
-
ForceCalculationBuilder.
TotalForceCenter
¶ Returns or sets the total force center of the calculated processes .
-------------------------------------
Getter Method
Signature
TotalForceCenter
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TotalForceCenter
Parameters: totalForceCenter (str) – Indicates the string of total process force center New in version NX7.5.0.
License requirements: None.
Method Detail¶
Validate¶
-
ForceCalculationBuilder.
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.