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

Represents a NXOpen::Features::PartModule builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePartModuleBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Features::PartModuleBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool ActivatePartModule ()
 Returns the option indicating whether part module is to be activated. More...
 
NXOpen::GeometricUtilities::PartModuleReferencesBuilderInputReferences ()
 Returns the part module input references. More...
 
bool IsDesignGroup ()
 Returns a flag indicating if part module is a design group. More...
 
NXString Name ()
 Returns the part module name
This API is now deprecated. More...
 
NXString Name1 ()
 Returns the part module name
Created in NX9.0.0. More...
 
void SetActivatePartModule (bool activate)
 Sets the option indicating whether part module is to be activated. More...
 
void SetDesignGroup (bool isDesignGroup)
 Sets a flag indicating if part module is a design group. More...
 
void SetName (const NXString &name)
 Sets the part module name
This API is now deprecated. More...
 
void SetName (const char *name)
 Sets the part module name
This API is now deprecated. More...
 
void SetName1 (const NXString &name)
 Sets the part module name
Created in NX9.0.0. More...
 
void SetName1 (const char *name)
 Sets the part module name
Created in NX9.0.0. More...
 
void SetShowOnlyPartModule (bool showOnly)
 Sets the option indicating whether only part module contents are to be shown. More...
 
bool ShowOnlyPartModule ()
 Returns the option indicating whether only part module contents are to be shown. More...
 
- Public Member Functions inherited from NXOpen::Features::FeatureBuilder
NXOpen::Features::FeatureCommitFeature ()
 Commits the feature parameters and creates the feature. More...
 
NXOpen::Features::FeatureGetFeature ()
 Returns the feature currently being edited by this builder. More...
 
void HideInternalParentFeatureAfterEdit (NXOpen::Features::Feature *parentFeature)
 Re-suppress an internal parent feature (a slave feature) after it has been edited. More...
 
bool ParentFeatureInternal ()
 Returns whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
bool PatchSolutionFlag ()
 Returns the patch solution flag
Created in NX8.0.1. More...
 
NXString PatchSurfaceFilename ()
 Returns the patch surface filename
Created in NX8.0.1. More...
 
void SetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the parent features which would be internal or slaves to the feature being created or commited
Created in NX6.0.0. More...
 
void SetParentFeatureInternal (bool isInternal)
 Sets whether or not the latest timestamped parent feature of this feature should be made internal
Created in NX5.0.0. More...
 
void SetPatchSolutionFlag (bool optionValue)
 Sets the patch solution flag
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const NXString &surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetPatchSurfaceFilename (const char *surfaceFilename)
 Sets the patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const NXString &surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void SetSurroundingPatchSurfaceFilename (const char *surroundingSurfaceFilename)
 Sets the surrounding patch surface filename
Created in NX8.0.1. More...
 
void ShowInternalParentFeatureForEdit (NXOpen::Features::Feature *parentFeature)
 Unsuppress an internal parent feature (a slave feature) so it can be edited. More...
 
NXString SurroundingPatchSurfaceFilename ()
 Returns the surrounding patch surface filename
Created in NX8.0.1. More...
 
void UnsetParentFeatureInternal (NXOpen::Features::Feature *parentFeature)
 Set the internal parent feature of the feature being edited to external
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 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::NXObjectGetObject ()
 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::Features::PartModule builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreatePartModuleBuilder

Created in NX8.0.0.


Member Function Documentation

bool NXOpen::Features::PartModuleBuilder::ActivatePartModule ( )

Returns the option indicating whether part module is to be activated.

If true, the part module will be activated, else, part module will be deactivated
Created in NX8.0.0.

License requirements : None

NXOpen::GeometricUtilities::PartModuleReferencesBuilder* NXOpen::Features::PartModuleBuilder::InputReferences ( )

Returns the part module input references.


This API is now deprecated. Please use GeometricUtilities::PartModuleInputBuilder::InputReferences instead.


Deprecated:
Deprecated in NX9.0.0. Please use GeometricUtilities::PartModuleInputBuilder::InputReferences instead.


Created in NX8.0.0.

License requirements : None

bool NXOpen::Features::PartModuleBuilder::IsDesignGroup ( )

Returns a flag indicating if part module is a design group.


Created in NX12.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")

NXString NXOpen::Features::PartModuleBuilder::Name ( )

Returns the part module name
This API is now deprecated.

Please use Features::PartModuleBuilder::Name1 instead.


Deprecated:
Deprecated in NX9.0.0. Please use Features::PartModuleBuilder::Name1 instead.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::Features::PartModuleBuilder::Name1 ( )

Returns the part module name
Created in NX9.0.0.



License requirements : None

void NXOpen::Features::PartModuleBuilder::SetActivatePartModule ( bool  activate)

Sets the option indicating whether part module is to be activated.

If true, the part module will be activated, else, part module will be deactivated
Created in NX8.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
activateactivate
void NXOpen::Features::PartModuleBuilder::SetDesignGroup ( bool  isDesignGroup)

Sets a flag indicating if part module is a design group.


Created in NX12.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
isDesignGroupisdesigngroup
void NXOpen::Features::PartModuleBuilder::SetName ( const NXString name)

Sets the part module name
This API is now deprecated.

Please use Features::PartModuleBuilder::Name1 instead.


Deprecated:
Deprecated in NX9.0.0. Please use Features::PartModuleBuilder::Name1 instead.


Created in NX8.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
namename
void NXOpen::Features::PartModuleBuilder::SetName ( const char *  name)

Sets the part module name
This API is now deprecated.

Please use Features::PartModuleBuilder::Name1 instead.


Deprecated:
Deprecated in NX9.0.0. Please use Features::PartModuleBuilder::Name1 instead.


Created in NX8.0.0.

License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
namename
void NXOpen::Features::PartModuleBuilder::SetName1 ( const NXString name)

Sets the part module name
Created in NX9.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
namename
void NXOpen::Features::PartModuleBuilder::SetName1 ( const char *  name)

Sets the part module name
Created in NX9.0.0.



License requirements : usr_defined_features ("USER DEFINED FEATURES")

Parameters
namename
void NXOpen::Features::PartModuleBuilder::SetShowOnlyPartModule ( bool  showOnly)

Sets the option indicating whether only part module contents are to be shown.

If true, only displayable objects in the part module will be shown. Else, no action is taken.
This API is now deprecated. Please use NXOpen::Features::PartModule::ShowOnly instead.


Deprecated:
Deprecated in NX9.0.0. Please use NXOpen::Features::PartModule::ShowOnly instead.


Created in NX8.0.0.

License requirements : solid_modeling ("SOLIDS MODELING")

Parameters
showOnlyshowonly
bool NXOpen::Features::PartModuleBuilder::ShowOnlyPartModule ( )

Returns the option indicating whether only part module contents are to be shown.

If true, only displayable objects in the part module will be shown. Else, no action is taken.
This API is now deprecated. Please use NXOpen::Features::PartModule::ShowOnly instead.


Deprecated:
Deprecated in NX9.0.0. Please use NXOpen::Features::PartModule::ShowOnly instead.


Created in NX8.0.0.

License requirements : None


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