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

Represents a NXOpen::GeometricUtilities::AlongSpineBuilder. More...

Inheritance diagram for NXOpen::GeometricUtilities::AlongSpineBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  RetainSpineOption { RetainSpineOptionKeepOriginal, RetainSpineOptionReplace }
 Represents the Spine option. More...
 

Public Member Functions

NXOpen::GeometricUtilities::OnPathDimWithValueBuilderCreateSpinePoint ()
 Creates a new spine point. More...
 
NXOpen::SectionFeatureSpine ()
 Returns the Spine set by the owning feature of the law
Created in NX5.0.0. More...
 
void GetSpinePoints (std::vector< NXOpen::GeometricUtilities::OnPathDimWithValueBuilder * > &spPoints)
 Returns the all SpinePointData objects
Created in NX5.0.0. More...
 
void ResetSpine ()
 Reset the spine
Created in NX5.0.0. More...
 
void SetFeatureSpine (NXOpen::Section *featureSpine)
 Set the spine sent by the owning feaure dynamically into builder
Created in NX5.0.0. More...
 
void SetSpineOption (NXOpen::GeometricUtilities::AlongSpineBuilder::RetainSpineOption spineOption)
 Sets the alongSpineOption. More...
 
NXOpen::SectionSpine ()
 Returns the Spine
Created in NX5.0.0. More...
 
NXOpen::GeometricUtilities::AlongSpineBuilder::RetainSpineOption SpineOption ()
 Returns the alongSpineOption. More...
 
NXOpen::ObjectListSpinePointList ()
 Returns the list of spine points. 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::GeometricUtilities::AlongSpineBuilder.


Created in NX5.0.0.

Member Enumeration Documentation

Represents the Spine option.

This option will be used while editing the lagecy feaures (Feaures having profile without section in it).

Enumerator
RetainSpineOptionKeepOriginal 

Keeps the original profile as it is during edit of pre NX3 parms.

RetainSpineOptionReplace 

Deletes the old profile, so that user has to select new one during edit of pre NX3 parms.

Member Function Documentation

NXOpen::GeometricUtilities::OnPathDimWithValueBuilder* NXOpen::GeometricUtilities::AlongSpineBuilder::CreateSpinePoint ( )

Creates a new spine point.

Returns
OnPathDimWithValueBuilder Object
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")
NXOpen::Section* NXOpen::GeometricUtilities::AlongSpineBuilder::FeatureSpine ( )

Returns the Spine set by the owning feature of the law
Created in NX5.0.0.



License requirements : None

void NXOpen::GeometricUtilities::AlongSpineBuilder::GetSpinePoints ( std::vector< NXOpen::GeometricUtilities::OnPathDimWithValueBuilder * > &  spPoints)

Returns the all SpinePointData objects
Created in NX5.0.0.



License requirements : None

Parameters
spPointsArray of SpinePointData Objects
void NXOpen::GeometricUtilities::AlongSpineBuilder::ResetSpine ( )

Reset the spine
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

void NXOpen::GeometricUtilities::AlongSpineBuilder::SetFeatureSpine ( NXOpen::Section featureSpine)

Set the spine sent by the owning feaure dynamically into builder
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters
featureSpineSet the Spine into builder
void NXOpen::GeometricUtilities::AlongSpineBuilder::SetSpineOption ( NXOpen::GeometricUtilities::AlongSpineBuilder::RetainSpineOption  spineOption)

Sets the alongSpineOption.

This will be used only during the edit of Pre NX3 feature Parms
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters
spineOptionspine option
NXOpen::Section* NXOpen::GeometricUtilities::AlongSpineBuilder::Spine ( )

Returns the Spine
Created in NX5.0.0.



License requirements : None

NXOpen::GeometricUtilities::AlongSpineBuilder::RetainSpineOption NXOpen::GeometricUtilities::AlongSpineBuilder::SpineOption ( )

Returns the alongSpineOption.

This will be used only during the edit of Pre NX3 feature Parms
Created in NX5.0.0.

License requirements : None

NXOpen::ObjectList* NXOpen::GeometricUtilities::AlongSpineBuilder::SpinePointList ( )

Returns the list of spine points.


Created in NX5.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::AlongSpineBuilder::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.