NXOpen::CAE::DeleteUnreferencedEntitiesBuilder Class Reference

Represents a NXOpen::CAE::DeleteUnreferencedEntitiesBuilder builder which can be used to delete entites (by category) that are not referenced by the active solution of the simulation
To create a new instance of this class, use NXOpen::CAE::SimSimulation::CreateDeleteUnreferencedEntitiesBuilder
Default values. More...

Inheritance diagram for NXOpen::CAE::DeleteUnreferencedEntitiesBuilder:

Public Types
enum	FileScopeType { FileScopeTypeSimOnly, FileScopeTypeSimandRelatedFEMsandAFEMs }
	The scope within which unreferenced entites are considered for deletion. More...
enum	SolutionSearchFilterType { SolutionSearchFilterTypeUnusedbyActive, SolutionSearchFilterTypeUnusedbyAll }
	The option based on which entities are considered unreferenced. More...

Public Member Functions
bool	AllOptionsToggle ()
	Returns the toggle that turns ON/OFF all of the other toggles Created in NX1847.0.0. More...
bool	ConditionSequenceParametersToggle ()
	Returns the Condition Sequence Parameters Toggle Created in NX1847.0.0. More...
bool	ConstraintFoldersToggle ()
	Returns the constraint folders toggle Created in NX1847.0.0. More...
bool	ConstraintsToggle ()
	Returns the constraints toggle Created in NX1847.0.0. More...
bool	CsysToggle ()
	Returns the CSYS Toggle Created in NX1847.0.0. More...
bool	FieldsToggle ()
	Returns the Fields Toggle Created in NX1847.0.0. More...
NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeType	FileScopeEnum ()
	Returns the File Scope Enum Created in NX1847.0.0. More...
int	GenerateAndQueryNumberOfDeletionCandidates ()
	The number of deletion candidiates is generated and returned Created in NX1847.0.0. More...
bool	GroupsToggle ()
	Returns the Groups Toggle Created in NX1847.0.0. More...
bool	LoadFoldersToggle ()
	Returns the load folders toggle Created in NX1847.0.0. More...
bool	LoadsToggle ()
	Returns the loads toggle Created in NX1847.0.0. More...
bool	MaterialsToggle ()
	Returns the Materials Toggle Created in NX1847.0.0. More...
bool	ModelingObjectsToggle ()
	Returns the Modeling Objects Toggle Created in NX1847.0.0. More...
bool	PhysicalPropertiesToggle ()
	Returns the Physical Properties Toggle Created in NX1847.0.0. More...
NXOpen::NXObject *	QueryDeletionCandidateWithIndex (int index)
	Returns the deletion candidate with for the index passed in Created in NX1847.0.0. More...
bool	RegionsToggle ()
	Returns the Regions Toggle Created in NX1847.0.0. More...
bool	SelectionRecipesToggle ()
	Returns the Selection Recipes Toggle Created in NX1847.0.0. More...
void	SetAllOptionsToggle (bool allOptionsToggle)
	Sets the toggle that turns ON/OFF all of the other toggles Created in NX1847.0.0. More...
void	SetConditionSequenceParametersToggle (bool conditionSequenceParametersToggle)
	Sets the Condition Sequence Parameters Toggle Created in NX1847.0.0. More...
void	SetConstraintFoldersToggle (bool constraintfoldersToggle)
	Sets the constraint folders toggle Created in NX1847.0.0. More...
void	SetConstraintsToggle (bool constraintsToggle)
	Sets the constraints toggle Created in NX1847.0.0. More...
void	SetCsysToggle (bool csysToggle)
	Sets the CSYS Toggle Created in NX1847.0.0. More...
void	SetDeleteCandidateExceptions (const std::vector< NXOpen::NXObject * > &deletionExceptions)
	The candidates passed in will not be deleted Created in NX1847.0.0. More...
void	SetFieldsToggle (bool fieldsToggle)
	Sets the Fields Toggle Created in NX1847.0.0. More...
void	SetFileScopeEnum (NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeType fileScopeEnum)
	Sets the File Scope Enum Created in NX1847.0.0. More...
void	SetGroupsToggle (bool groupsToggle)
	Sets the Groups Toggle Created in NX1847.0.0. More...
void	SetLoadFoldersToggle (bool loadfoldersToggle)
	Sets the load folders toggle Created in NX1847.0.0. More...
void	SetLoadsToggle (bool loadsToggle)
	Sets the loads toggle Created in NX1847.0.0. More...
void	SetMaterialsToggle (bool materialsToggle)
	Sets the Materials Toggle Created in NX1847.0.0. More...
void	SetModelingObjectsToggle (bool modelingObjectsToggle)
	Sets the Modeling Objects Toggle Created in NX1847.0.0. More...
void	SetPhysicalPropertiesToggle (bool physicalPropertiesToggle)
	Sets the Physical Properties Toggle Created in NX1847.0.0. More...
void	SetRegionsToggle (bool regionsToggle)
	Sets the Regions Toggle Created in NX1847.0.0. More...
void	SetSelectionRecipesToggle (bool selectionRecipesToggle)
	Sets the Selection Recipes Toggle Created in NX1847.0.0. More...
void	SetSimulationObjectFoldersToggle (bool simulationObjectfoldersToggle)
	Sets the Simulation Object Folders Toggle Created in NX1847.0.0. More...
void	SetSimulationObjectsToggle (bool simulationObjectsToggle)
	Sets the Simulation Objects Toggle Created in NX1847.0.0. More...
void	SetSolutionSearchFilterEnum (NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterType solutionSearchFilterEnum)
	Sets the Solution Search Filter Enum Created in NX1847.0.0. More...
void	SetSolverSetsToggle (bool solverSetsToggle)
	Sets the Solver Sets Toggle Created in NX1847.0.0. More...
void	SetUserDefinedExpressionsToggle (bool userDefinedExpressionsToggle)
	Sets the User Defined Expressions Toggle Created in NX1847.0.0. More...
bool	SimulationObjectFoldersToggle ()
	Returns the Simulation Object Folders Toggle Created in NX1847.0.0. More...
bool	SimulationObjectsToggle ()
	Returns the Simulation Objects Toggle Created in NX1847.0.0. More...
NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterType	SolutionSearchFilterEnum ()
	Returns the Solution Search Filter Enum Created in NX1847.0.0. More...
bool	SolverSetsToggle ()
	Returns the Solver Sets Toggle Created in NX1847.0.0. More...
bool	UserDefinedExpressionsToggle ()
	Returns the User Defined Expressions Toggle Created in NX1847.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 NXOpen::CAE::DeleteUnreferencedEntitiesBuilder builder which can be used to delete entites (by category) that are not referenced by the active solution of the simulation
To create a new instance of this class, use NXOpen::CAE::SimSimulation::CreateDeleteUnreferencedEntitiesBuilder
Default values.

Property	Value
AllOptionsToggle	1
ConditionSequenceParametersToggle	1
ConstraintFoldersToggle	1
ConstraintsToggle	1
CsysToggle	1
FieldsToggle	1
FileScopeEnum	SimOnly
GroupsToggle	1
LoadFoldersToggle	1
LoadsToggle	1
MaterialsToggle	1
ModelingObjectsToggle	1
PhysicalPropertiesToggle	1
RegionsToggle	1
SelectionRecipesToggle	1
SimulationObjectFoldersToggle	1
SimulationObjectsToggle	1
SolutionSearchFilterEnum	UnusedbyAll
SolverSetsToggle	1
UserDefinedExpressionsToggle	1

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeType

The scope within which unreferenced entites are considered for deletion.

Enumerator
FileScopeTypeSimOnly	TO DO.
FileScopeTypeSimandRelatedFEMsandAFEMs	simand related femsand afems

enum NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterType

The option based on which entities are considered unreferenced.

Enumerator
SolutionSearchFilterTypeUnusedbyActive	TO DO.
SolutionSearchFilterTypeUnusedbyAll	TO DO.

Member Function Documentation

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::AllOptionsToggle

(

)

Returns the toggle that turns ON/OFF all of the other toggles
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::ConditionSequenceParametersToggle

(

)

Returns the Condition Sequence Parameters Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::ConstraintFoldersToggle

(

)

Returns the constraint folders toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::ConstraintsToggle

(

)

Returns the constraints toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::CsysToggle

(

)

Returns the CSYS Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FieldsToggle

(

)

Returns the Fields Toggle
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeType NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeEnum

(

)

Returns the File Scope Enum
Created in NX1847.0.0.

License requirements : None

int NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::GenerateAndQueryNumberOfDeletionCandidates

(

)

The number of deletion candidiates is generated and returned
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::GroupsToggle

(

)

Returns the Groups Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::LoadFoldersToggle

(

)

Returns the load folders toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::LoadsToggle

(

)

Returns the loads toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::MaterialsToggle

(

)

Returns the Materials Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::ModelingObjectsToggle

(

)

Returns the Modeling Objects Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::PhysicalPropertiesToggle

(

)

Returns the Physical Properties Toggle
Created in NX1847.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::QueryDeletionCandidateWithIndex

(

int

index

)

Returns the deletion candidate with for the index passed in
Created in NX1847.0.0.

License requirements : None

Parameters

index

index

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::RegionsToggle

(

)

Returns the Regions Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SelectionRecipesToggle

(

)

Returns the Selection Recipes Toggle
Created in NX1847.0.0.

License requirements : None

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetAllOptionsToggle

(

bool

allOptionsToggle

)

Sets the toggle that turns ON/OFF all of the other toggles
Created in NX1847.0.0.

License requirements : None

Parameters

allOptionsToggle

alloptionstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetConditionSequenceParametersToggle

(

bool

conditionSequenceParametersToggle

)

Sets the Condition Sequence Parameters Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

conditionSequenceParametersToggle

conditionsequenceparameterstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetConstraintFoldersToggle

(

bool

constraintfoldersToggle

)

Sets the constraint folders toggle
Created in NX1847.0.0.

License requirements : None

Parameters

constraintfoldersToggle

constraintfolderstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetConstraintsToggle

(

bool

constraintsToggle

)

Sets the constraints toggle
Created in NX1847.0.0.

License requirements : None

Parameters

constraintsToggle

constraintstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetCsysToggle

(

bool

csysToggle

)

Sets the CSYS Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

csysToggle

csystoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetDeleteCandidateExceptions

(

const std::vector< NXOpen::NXObject * > &

deletionExceptions

)

The candidates passed in will not be deleted
Created in NX1847.0.0.

License requirements : None

Parameters

deletionExceptions

deletionexceptions

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetFieldsToggle

(

bool

fieldsToggle

)

Sets the Fields Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

fieldsToggle

fieldstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetFileScopeEnum

(

NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::FileScopeType

fileScopeEnum

)

Sets the File Scope Enum
Created in NX1847.0.0.

License requirements : None

Parameters

fileScopeEnum

filescopeenum

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetGroupsToggle

(

bool

groupsToggle

)

Sets the Groups Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

groupsToggle

groupstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetLoadFoldersToggle

(

bool

loadfoldersToggle

)

Sets the load folders toggle
Created in NX1847.0.0.

License requirements : None

Parameters

loadfoldersToggle

loadfolderstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetLoadsToggle

(

bool

loadsToggle

)

Sets the loads toggle
Created in NX1847.0.0.

License requirements : None

Parameters

loadsToggle

loadstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetMaterialsToggle

(

bool

materialsToggle

)

Sets the Materials Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

materialsToggle

materialstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetModelingObjectsToggle

(

bool

modelingObjectsToggle

)

Sets the Modeling Objects Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

modelingObjectsToggle

modelingobjectstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetPhysicalPropertiesToggle

(

bool

physicalPropertiesToggle

)

Sets the Physical Properties Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

physicalPropertiesToggle

physicalpropertiestoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetRegionsToggle

(

bool

regionsToggle

)

Sets the Regions Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

regionsToggle

regionstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetSelectionRecipesToggle

(

bool

selectionRecipesToggle

)

Sets the Selection Recipes Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

selectionRecipesToggle

selectionrecipestoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetSimulationObjectFoldersToggle

(

bool

simulationObjectfoldersToggle

)

Sets the Simulation Object Folders Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

simulationObjectfoldersToggle

simulationobjectfolderstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetSimulationObjectsToggle

(

bool

simulationObjectsToggle

)

Sets the Simulation Objects Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

simulationObjectsToggle

simulationobjectstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetSolutionSearchFilterEnum

(

NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterType

solutionSearchFilterEnum

)

Sets the Solution Search Filter Enum
Created in NX1847.0.0.

License requirements : None

Parameters

solutionSearchFilterEnum

solutionsearchfilterenum

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetSolverSetsToggle

(

bool

solverSetsToggle

)

Sets the Solver Sets Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

solverSetsToggle

solversetstoggle

void NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SetUserDefinedExpressionsToggle

(

bool

userDefinedExpressionsToggle

)

Sets the User Defined Expressions Toggle
Created in NX1847.0.0.

License requirements : None

Parameters

userDefinedExpressionsToggle

userdefinedexpressionstoggle

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SimulationObjectFoldersToggle

(

)

Returns the Simulation Object Folders Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SimulationObjectsToggle

(

)

Returns the Simulation Objects Toggle
Created in NX1847.0.0.

License requirements : None

NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterType NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolutionSearchFilterEnum

(

)

Returns the Solution Search Filter Enum
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::SolverSetsToggle

(

)

Returns the Solver Sets Toggle
Created in NX1847.0.0.

License requirements : None

bool NXOpen::CAE::DeleteUnreferencedEntitiesBuilder::UserDefinedExpressionsToggle

(

)

Returns the User Defined Expressions Toggle
Created in NX1847.0.0.

License requirements : None

---

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

• CAE_DeleteUnreferencedEntitiesBuilder.hxx