EffectivityTableBuilder Class¶
-
class
NXOpen.PDM.
EffectivityTableBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a builder class for effectivity configuration.
New in version NX9.0.0.
Methods¶
Method | Description |
---|---|
AddEffectivityRow | Adds the given effectivity row to NXOpen.PDM.EffectivityTableBuilder |
Commit | Commit the modified effectivity rows |
CreateNewEffectivityRow | Creates new effectivity row in NXOpen.PDM.EffectivityTableBuilder object |
GetEffectivityRows | Gets the existing effectivity rows from effectivity table |
RemoveEffectivityRows | Removes the given effectivity rows from NXOpen.PDM.EffectivityTableBuilder |
UpdateBuilderDetails | Updates this builder with new NXOpen.CollaborativeDesign , validation basis formula and effectivity formulae to edit. |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Method Detail¶
AddEffectivityRow¶
-
EffectivityTableBuilder.
AddEffectivityRow
¶ Adds the given effectivity row to
NXOpen.PDM.EffectivityTableBuilder
Signature
AddEffectivityRow(effectivityRow)
Parameters: effectivityRow ( NXOpen.PDM.EffectivityTableRow
) –New in version NX9.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
Commit¶
-
EffectivityTableBuilder.
Commit
¶ Commit the modified effectivity rows
Signature
Commit()
New in version NX9.0.0.
License requirements: assemblies (“ASSEMBLIES MODULE”)
CreateNewEffectivityRow¶
-
EffectivityTableBuilder.
CreateNewEffectivityRow
¶ Creates new effectivity row in
NXOpen.PDM.EffectivityTableBuilder
objectSignature
CreateNewEffectivityRow()
Returns: newly created empty effectivity row Return type: NXOpen.PDM.EffectivityTableRow
New in version NX9.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
GetEffectivityRows¶
-
EffectivityTableBuilder.
GetEffectivityRows
¶ Gets the existing effectivity rows from effectivity table
Signature
GetEffectivityRows()
Returns: Return type: list of NXOpen.PDM.EffectivityTableRow
New in version NX9.0.0.
License requirements: None.
RemoveEffectivityRows¶
-
EffectivityTableBuilder.
RemoveEffectivityRows
¶ Removes the given effectivity rows from
NXOpen.PDM.EffectivityTableBuilder
Signature
RemoveEffectivityRows(effectivityRows)
Parameters: effectivityRows (list of NXOpen.PDM.EffectivityTableRow
) – effectivity rows to be removedNew in version NX9.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
UpdateBuilderDetails¶
-
EffectivityTableBuilder.
UpdateBuilderDetails
¶ Updates this builder with new
NXOpen.CollaborativeDesign
, validation basis formula and effectivity formulae to edit.Effectivity formulae will be validated against provided validation basis formula.
Signature
UpdateBuilderDetails(cd, validationBasisFormula, effectivityFormulae)
Parameters: - cd (
NXOpen.CollaborativeDesign
) – - validationBasisFormula (str) –
- effectivityFormulae (list of str) –
New in version NX9.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
- cd (
Validate¶
-
EffectivityTableBuilder.
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.