BasicEffectivityBuilder Class

class NXOpen.BasicEffectivityBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represent an interface class for basic effectivity block to assign or edit discrete effectivity unit values.

Also provides method to apply all units or no units effectivity.

New in version NX8.5.0.

Properties

Property	Description
EffectivityFormula	Returns the string representation of effectivity
Tag	Returns the Tag for this object.
UnitEffectivityValue	Returns or sets the unit effectivity value
ValidationBasisEffectivityFormula	Returns the string representation of validation basis effectivity

Methods

Method	Description
UpdateBuilderDetails	Update this builder with new NXOpen.CollaborativeDesign and effectivity formula
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

EffectivityFormula

BasicEffectivityBuilder.EffectivityFormula

Returns the string representation of effectivity

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

Getter Method

Signature EffectivityFormula

Returns: Return type:str

New in version NX8.5.0.

License requirements: None.

UnitEffectivityValue

BasicEffectivityBuilder.UnitEffectivityValue

Returns or sets the unit effectivity value

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

Getter Method

Signature UnitEffectivityValue

Returns: Return type:int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature UnitEffectivityValue

Parameters:unitEffectivity (int) –

New in version NX8.5.0.

License requirements: None.

ValidationBasisEffectivityFormula

BasicEffectivityBuilder.ValidationBasisEffectivityFormula

Returns the string representation of validation basis effectivity

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

Getter Method

Signature ValidationBasisEffectivityFormula

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

Method Detail

UpdateBuilderDetails

BasicEffectivityBuilder.UpdateBuilderDetails

Overloaded method UpdateBuilderDetails

• UpdateBuilderDetails(cd, effectivityFormulae)
• UpdateBuilderDetails(cd, validationBasisFormula, effectivityFormulae)

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

Update this builder with new NXOpen.CollaborativeDesign and effectivity formula

Signature UpdateBuilderDetails(cd, effectivityFormulae)

Parameters:

• cd (NXOpen.CollaborativeDesign) –
• effectivityFormulae (list of str) –

New in version NX8.5.0.

License requirements: None.

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

Update 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: None.

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

Validate

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