NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
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 More...

Inheritance diagram for NXOpen.CAE.DeleteUnreferencedEntitiesBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  FileScopeType { SimOnly, SimandRelatedFEMsandAFEMs }
 The scope within which unreferenced entites are considered for deletion More...
 
enum  SolutionSearchFilterType { UnusedbyActive, UnusedbyAll }
 The option based on which entities are considered unreferenced More...
 

Public Member Functions

unsafe int GenerateAndQueryNumberOfDeletionCandidates ()
 The number of deletion candidiates is generated and returned More...
 
unsafe NXOpen.NXObject QueryDeletionCandidateWithIndex (int index)
 Returns the deletion candidate with for the index passed in More...
 
unsafe void SetDeleteCandidateExceptions (NXOpen.NXObject[] deletionExceptions)
 The candidates passed in will not be deleted More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe bool AllOptionsToggle [get, set]
 Returns or sets the toggle that turns ON/OFF all of the other toggles More...
 
unsafe bool ConditionSequenceParametersToggle [get, set]
 Returns or sets the Condition Sequence Parameters Toggle More...
 
unsafe bool ConstraintFoldersToggle [get, set]
 Returns or sets the constraint folders toggle More...
 
unsafe bool ConstraintsToggle [get, set]
 Returns or sets the constraints toggle More...
 
unsafe bool CsysToggle [get, set]
 Returns or sets the CSYS Toggle More...
 
unsafe bool FieldsToggle [get, set]
 Returns or sets the Fields Toggle More...
 
unsafe
NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.FileScopeType 
FileScopeEnum [get, set]
 Returns or sets the File Scope Enum More...
 
unsafe bool GroupsToggle [get, set]
 Returns or sets the Groups Toggle More...
 
unsafe bool LoadFoldersToggle [get, set]
 Returns or sets the load folders toggle More...
 
unsafe bool LoadsToggle [get, set]
 Returns or sets the loads toggle More...
 
unsafe bool MaterialsToggle [get, set]
 Returns or sets the Materials Toggle More...
 
unsafe bool ModelingObjectsToggle [get, set]
 Returns or sets the Modeling Objects Toggle More...
 
unsafe bool PhysicalPropertiesToggle [get, set]
 Returns or sets the Physical Properties Toggle More...
 
unsafe bool RegionsToggle [get, set]
 Returns or sets the Regions Toggle More...
 
unsafe bool SelectionRecipesToggle [get, set]
 Returns or sets the Selection Recipes Toggle More...
 
unsafe bool SimulationObjectFoldersToggle [get, set]
 Returns or sets the Simulation Object Folders Toggle More...
 
unsafe bool SimulationObjectsToggle [get, set]
 Returns or sets the Simulation Objects Toggle More...
 
unsafe
NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SolutionSearchFilterType 
SolutionSearchFilterEnum [get, set]
 Returns or sets the Solution Search Filter Enum More...
 
unsafe bool SolverSetsToggle [get, set]
 Returns or sets the Solver Sets Toggle More...
 
unsafe bool UserDefinedExpressionsToggle [get, set]
 Returns or sets the User Defined Expressions Toggle More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> 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

The scope within which unreferenced entites are considered for deletion

Enumerator
SimOnly 

TO DO

SimandRelatedFEMsandAFEMs 

The option based on which entities are considered unreferenced

Enumerator
UnusedbyActive 

TO DO

UnusedbyAll 

TO DO

Member Function Documentation

unsafe int NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.GenerateAndQueryNumberOfDeletionCandidates ( )
inline

The number of deletion candidiates is generated and returned

Created in NX1847.0.0

License requirements: None.

Returns
unsafe NXOpen.NXObject NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.QueryDeletionCandidateWithIndex ( int  index)
inline

Returns the deletion candidate with for the index passed in

Created in NX1847.0.0

License requirements: None.

Parameters
index
Returns
unsafe void NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SetDeleteCandidateExceptions ( NXOpen.NXObject[]  deletionExceptions)
inline

The candidates passed in will not be deleted

Created in NX1847.0.0

License requirements: None.

Parameters
deletionExceptions

Property Documentation

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.AllOptionsToggle
getset

Returns or sets the toggle that turns ON/OFF all of the other toggles

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.ConditionSequenceParametersToggle
getset

Returns or sets the Condition Sequence Parameters Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.ConstraintFoldersToggle
getset

Returns or sets the constraint folders toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.ConstraintsToggle
getset

Returns or sets the constraints toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.CsysToggle
getset

Returns or sets the CSYS Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.FieldsToggle
getset

Returns or sets the Fields Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.FileScopeType NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.FileScopeEnum
getset

Returns or sets the File Scope Enum

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.GroupsToggle
getset

Returns or sets the Groups Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.LoadFoldersToggle
getset

Returns or sets the load folders toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.LoadsToggle
getset

Returns or sets the loads toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.MaterialsToggle
getset

Returns or sets the Materials Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.ModelingObjectsToggle
getset

Returns or sets the Modeling Objects Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.PhysicalPropertiesToggle
getset

Returns or sets the Physical Properties Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.RegionsToggle
getset

Returns or sets the Regions Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SelectionRecipesToggle
getset

Returns or sets the Selection Recipes Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SimulationObjectFoldersToggle
getset

Returns or sets the Simulation Object Folders Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SimulationObjectsToggle
getset

Returns or sets the Simulation Objects Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SolutionSearchFilterType NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SolutionSearchFilterEnum
getset

Returns or sets the Solution Search Filter Enum

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.SolverSetsToggle
getset

Returns or sets the Solver Sets Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.CAE.DeleteUnreferencedEntitiesBuilder.UserDefinedExpressionsToggle
getset

Returns or sets the User Defined Expressions Toggle

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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