NXOpen::BasicEffectivityBuilder Class Reference

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

Inheritance diagram for NXOpen::BasicEffectivityBuilder:

Public Member Functions
NXString	EffectivityFormula ()
	Returns the string representation of effectivity Created in NX8.5.0. More...
void	SetUnitEffectivityValue (int unitEffectivity)
	Sets the unit effectivity value Created in NX8.5.0. More...
int	UnitEffectivityValue ()
	Returns the unit effectivity value Created in NX8.5.0. More...
void	UpdateBuilderDetails (NXOpen::CollaborativeDesign *cd, const std::vector< NXString > &effectivityFormulae)
	Update this builder with new NXOpen::CollaborativeDesign and effectivity formula Created in NX8.5.0. More...
void	UpdateBuilderDetails (NXOpen::CollaborativeDesign *cd, const NXString &validationBasisFormula, const std::vector< NXString > &effectivityFormulae)
	Update this builder with new NXOpen::CollaborativeDesign , validation basis formula and effectivity formulae to edit. More...
void	UpdateBuilderDetails (NXOpen::CollaborativeDesign *cd, const char *validationBasisFormula, const std::vector< NXString > &effectivityFormulae)
	Update this builder with new NXOpen::CollaborativeDesign , validation basis formula and effectivity formulae to edit. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
NXString	ValidationBasisEffectivityFormula ()
	Returns the string representation of validation basis effectivity Created in NX9.0.0. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

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.

Created in NX8.5.0.

Member Function Documentation

NXString NXOpen::BasicEffectivityBuilder::EffectivityFormula

(

)

Returns the string representation of effectivity
Created in NX8.5.0.

License requirements : None

void NXOpen::BasicEffectivityBuilder::SetUnitEffectivityValue

(

int

unitEffectivity

)

Sets the unit effectivity value
Created in NX8.5.0.

License requirements : None

Parameters

unitEffectivity

uniteffectivity

int NXOpen::BasicEffectivityBuilder::UnitEffectivityValue

(

)

Returns the unit effectivity value
Created in NX8.5.0.

License requirements : None

void NXOpen::BasicEffectivityBuilder::UpdateBuilderDetails	(	NXOpen::CollaborativeDesign *	cd,
		const std::vector< NXString > &	effectivityFormulae
	)

Update this builder with new NXOpen::CollaborativeDesign and effectivity formula
Created in NX8.5.0.

License requirements : None

Parameters

cd	cd
effectivityFormulae	effectivityformulae

void NXOpen::BasicEffectivityBuilder::UpdateBuilderDetails	(	NXOpen::CollaborativeDesign *	cd,
		const NXString &	validationBasisFormula,
		const std::vector< NXString > &	effectivityFormulae
	)

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.

Created in NX9.0.0.

License requirements : None

Parameters

cd	cd
validationBasisFormula	validationbasisformula
effectivityFormulae	effectivityformulae

void NXOpen::BasicEffectivityBuilder::UpdateBuilderDetails	(	NXOpen::CollaborativeDesign *	cd,
		const char *	validationBasisFormula,
		const std::vector< NXString > &	effectivityFormulae
	)

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.

Created in NX9.0.0.

License requirements : None

Parameters

cd	cd
validationBasisFormula	validationbasisformula
effectivityFormulae	effectivityformulae

virtual bool NXOpen::BasicEffectivityBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

NXString NXOpen::BasicEffectivityBuilder::ValidationBasisEffectivityFormula

(

)

Returns the string representation of validation basis effectivity
Created in NX9.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• BasicEffectivityBuilder.hxx