NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::PDM::EffectivityTableBuilder Class Reference

Represents a builder class for effectivity configuration. More...

Inheritance diagram for NXOpen::PDM::EffectivityTableBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

void AddEffectivityRow (NXOpen::PDM::EffectivityTableRow *effectivityRow)
 Adds the given effectivity row to NXOpen::PDM::EffectivityTableBuilder
Created in NX9.0.0. More...
 
void Commit ()
 Commit the modified effectivity rows
Created in NX9.0.0. More...
 
NXOpen::PDM::EffectivityTableRowCreateNewEffectivityRow ()
 Creates new effectivity row in NXOpen::PDM::EffectivityTableBuilder object. More...
 
void GetEffectivityRows (std::vector< NXOpen::PDM::EffectivityTableRow * > &effectivityRows)
 Gets the existing effectivity rows from effectivity table
Created in NX9.0.0. More...
 
void RemoveEffectivityRows (const std::vector< NXOpen::PDM::EffectivityTableRow * > &effectivityRows)
 Removes the given effectivity rows from NXOpen::PDM::EffectivityTableBuilder
Created in NX9.0.0. More...
 
void UpdateBuilderDetails (NXOpen::CollaborativeDesign *cd, const NXString &validationBasisFormula, const std::vector< NXString > &effectivityFormulae)
 Updates 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)
 Updates 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...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a builder class for effectivity configuration.


Created in NX9.0.0.

Member Function Documentation

void NXOpen::PDM::EffectivityTableBuilder::AddEffectivityRow ( NXOpen::PDM::EffectivityTableRow effectivityRow)

Adds the given effectivity row to NXOpen::PDM::EffectivityTableBuilder
Created in NX9.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
effectivityRoweffectivityrow
void NXOpen::PDM::EffectivityTableBuilder::Commit ( )

Commit the modified effectivity rows
Created in NX9.0.0.



License requirements : assemblies ("ASSEMBLIES MODULE")

NXOpen::PDM::EffectivityTableRow* NXOpen::PDM::EffectivityTableBuilder::CreateNewEffectivityRow ( )

Creates new effectivity row in NXOpen::PDM::EffectivityTableBuilder object.

Returns
newly created empty effectivity row
Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")
void NXOpen::PDM::EffectivityTableBuilder::GetEffectivityRows ( std::vector< NXOpen::PDM::EffectivityTableRow * > &  effectivityRows)

Gets the existing effectivity rows from effectivity table
Created in NX9.0.0.



License requirements : None

Parameters
effectivityRowseffectivityrows
void NXOpen::PDM::EffectivityTableBuilder::RemoveEffectivityRows ( const std::vector< NXOpen::PDM::EffectivityTableRow * > &  effectivityRows)

Removes the given effectivity rows from NXOpen::PDM::EffectivityTableBuilder
Created in NX9.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
effectivityRowseffectivity rows to be removed
void NXOpen::PDM::EffectivityTableBuilder::UpdateBuilderDetails ( NXOpen::CollaborativeDesign cd,
const NXString validationBasisFormula,
const std::vector< NXString > &  effectivityFormulae 
)

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.


Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
cdcd
validationBasisFormulavalidationbasisformula
effectivityFormulaeeffectivityformulae
void NXOpen::PDM::EffectivityTableBuilder::UpdateBuilderDetails ( NXOpen::CollaborativeDesign cd,
const char *  validationBasisFormula,
const std::vector< NXString > &  effectivityFormulae 
)

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.


Created in NX9.0.0.

License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
cdcd
validationBasisFormulavalidationbasisformula
effectivityFormulaeeffectivityformulae
virtual bool NXOpen::PDM::EffectivityTableBuilder::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.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.