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

Represents a NXOpen::FeatureGeneralPropertiesBuilder to be used for modifying the names of features and general objects. More...

Inheritance diagram for NXOpen::FeatureGeneralPropertiesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

bool ApplyToWorkPart ()
 Returns the option to apply the name change to the work part. More...
 
void DeleteFeatureName ()
 Delete the name of the feature. More...
 
void DeleteGeneralName ()
 Delete the name of the general object. More...
 
NXString FeatureName ()
 Returns the feature name. More...
 
NXOpen::NXObjectFeatureObject ()
 Returns the feature. More...
 
NXString GeneralName ()
 Returns the general name. More...
 
NXOpen::NXObjectGeneralObject ()
 Returns the general object. More...
 
NXOpen::Point3d GetNameLocation ()
 Gets the name location. More...
 
bool NameLocationSpecified ()
 Returns the name location specified. More...
 
NXOpen::SelectNXObjectListSelectedObjects ()
 Returns the selected object(s) list. More...
 
void SetApplyToWorkPart (bool applyToWorkPart)
 Sets the option to apply the name change to the work part. More...
 
void SetFeatureName (const NXString &featureName)
 Sets the feature name. More...
 
void SetFeatureName (const char *featureName)
 Sets the feature name. More...
 
void SetFeatureObject (NXOpen::NXObject *featureObject)
 Sets the feature. More...
 
void SetGeneralName (const NXString &generalName)
 Sets the general name. More...
 
void SetGeneralName (const char *generalName)
 Sets the general name. More...
 
void SetGeneralObject (NXOpen::NXObject *generalObject)
 Sets the general object. More...
 
void SetNameLocation (const NXOpen::Point3d &nameLocation)
 Sets the name location. More...
 
void SetNameLocationSpecified (bool nameLocationSpecified)
 Sets the name location specified. 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::FeatureGeneralPropertiesBuilder to be used for modifying the names of features and general objects.


To create a new instance of this class, use NXOpen::PropertiesManager::CreateFeatureGeneralPropertiesBuilder

Created in NX8.0.0.

Member Function Documentation

bool NXOpen::FeatureGeneralPropertiesBuilder::ApplyToWorkPart ( )

Returns the option to apply the name change to the work part.


Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::DeleteFeatureName ( )

Delete the name of the feature.


Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::DeleteGeneralName ( )

Delete the name of the general object.


Created in NX8.0.0.

License requirements : None

NXString NXOpen::FeatureGeneralPropertiesBuilder::FeatureName ( )

Returns the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::FeatureGeneralPropertiesBuilder::FeatureObject ( )

Returns the feature.

This is the feature object to be modified.
Created in NX8.0.0.

License requirements : None

NXString NXOpen::FeatureGeneralPropertiesBuilder::GeneralName ( )

Returns the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

NXOpen::NXObject* NXOpen::FeatureGeneralPropertiesBuilder::GeneralObject ( )

Returns the general object.

This is the general object to be modified.
Created in NX8.0.0.

License requirements : None

NXOpen::Point3d NXOpen::FeatureGeneralPropertiesBuilder::GetNameLocation ( )

Gets the name location.

Returns

Created in NX8.0.0.

License requirements : None
bool NXOpen::FeatureGeneralPropertiesBuilder::NameLocationSpecified ( )

Returns the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

NXOpen::SelectNXObjectList* NXOpen::FeatureGeneralPropertiesBuilder::SelectedObjects ( )

Returns the selected object(s) list.

This list should only contain one object
Created in NX8.0.0.

License requirements : None

void NXOpen::FeatureGeneralPropertiesBuilder::SetApplyToWorkPart ( bool  applyToWorkPart)

Sets the option to apply the name change to the work part.


Created in NX8.0.0.

License requirements : None

Parameters
applyToWorkPartapplytoworkpart
void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureName ( const NXString featureName)

Sets the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

Parameters
featureNamefeaturename
void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureName ( const char *  featureName)

Sets the feature name.

This is the new name of the feature.
Created in NX8.0.0.

License requirements : None

Parameters
featureNamefeaturename
void NXOpen::FeatureGeneralPropertiesBuilder::SetFeatureObject ( NXOpen::NXObject featureObject)

Sets the feature.

This is the feature object to be modified.
Created in NX8.0.0.

License requirements : None

Parameters
featureObjectfeatureobject
void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralName ( const NXString generalName)

Sets the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

Parameters
generalNamegeneralname
void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralName ( const char *  generalName)

Sets the general name.

This is the new name of the general object.
Created in NX8.0.0.

License requirements : None

Parameters
generalNamegeneralname
void NXOpen::FeatureGeneralPropertiesBuilder::SetGeneralObject ( NXOpen::NXObject generalObject)

Sets the general object.

This is the general object to be modified.
Created in NX8.0.0.

License requirements : None

Parameters
generalObjectgeneralobject
void NXOpen::FeatureGeneralPropertiesBuilder::SetNameLocation ( const NXOpen::Point3d nameLocation)

Sets the name location.

If name location specified is true, this value will be used to change the name location of the general object.
Created in NX8.0.0.

License requirements : None

Parameters
nameLocationthe name location
void NXOpen::FeatureGeneralPropertiesBuilder::SetNameLocationSpecified ( bool  nameLocationSpecified)

Sets the name location specified.

This states whether the name location will be changed.
Created in NX8.0.0.

License requirements : None

Parameters
nameLocationSpecifiednamelocationspecified

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