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

Represents a NXOpen::Features::Cylinder builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateCylinderBuilder
Default values. More...

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

Public Types

enum  Types { TypesAxisDiameterAndHeight, TypesArcAndHeight }
 the cylinder types More...
 

Public Member Functions

NXOpen::SelectICurveArc ()
 Returns the arc
Created in NX5.0.0. More...
 
NXOpen::AxisAxis ()
 Returns the axis
Created in NX5.0.0. More...
 
NXOpen::GeometricUtilities::BooleanOperationBooleanOption ()
 Returns the boolean option
Created in NX5.0.0. More...
 
NXOpen::ExpressionDiameter ()
 Returns the diameter. More...
 
NXOpen::Vector3d Direction ()
 Returns the cylinder direction. More...
 
NXOpen::ExpressionHeight ()
 Returns the height
Created in NX5.0.0. More...
 
NXOpen::Point3d Origin ()
 Returns the cylinder origin. More...
 
bool ParentAssociativity ()
 Returns the option to keep associativity of the cylinder axis
Created in NX8.0.0. More...
 
bool ReverseDirection ()
 Returns the reverse direction. More...
 
void SetAxis (NXOpen::Axis *axis)
 Sets the axis
Created in NX5.0.0. More...
 
void SetDirection (const NXOpen::Vector3d &vector)
 Sets the cylinder direction. More...
 
void SetOrigin (const NXOpen::Point3d &origin)
 Sets the cylinder origin. More...
 
void SetParentAssociativity (bool parentAssociativity)
 Sets the option to keep associativity of the cylinder axis
Created in NX8.0.0. More...
 
void SetReverseDirection (bool reverse)
 Sets the reverse direction. More...
 
void SetType (NXOpen::Features::CylinderBuilder::Types type)
 Sets the type
Created in NX5.0.0. More...
 
NXOpen::Features::CylinderBuilder::Types Type ()
 Returns the type
Created in NX5.0.0. 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::Cylinder builder
To create a new instance of this class, use NXOpen::Features::FeatureCollection::CreateCylinderBuilder
Default values.

Property Value

BooleanOption.Type

Create

Diameter.Value

50.0 (millimeters part), 2.0 (inches part)

Height.Value

100.0 (millimeters part), 4.0 (inches part)

ReverseDirection

false

Type

AxisDiameterAndHeight


Created in NX5.0.0.

Member Enumeration Documentation

the cylinder types

Enumerator
TypesAxisDiameterAndHeight 

Axis, Diameter and Height.

TypesArcAndHeight 

Arc and Height.

Member Function Documentation

NXOpen::SelectICurve* NXOpen::Features::CylinderBuilder::Arc ( )

Returns the arc
Created in NX5.0.0.



License requirements : None

NXOpen::Axis* NXOpen::Features::CylinderBuilder::Axis ( )

Returns the axis
Created in NX5.0.0.



License requirements : None

NXOpen::GeometricUtilities::BooleanOperation* NXOpen::Features::CylinderBuilder::BooleanOption ( )

Returns the boolean option
Created in NX5.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Features::CylinderBuilder::Diameter ( )

Returns the diameter.

This will be used only when the law type is Axis, Diameter, and Height
Created in NX5.0.0.

License requirements : None

NXOpen::Vector3d NXOpen::Features::CylinderBuilder::Direction ( )

Returns the cylinder direction.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

NXOpen::Expression* NXOpen::Features::CylinderBuilder::Height ( )

Returns the height
Created in NX5.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Features::CylinderBuilder::Origin ( )

Returns the cylinder origin.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

bool NXOpen::Features::CylinderBuilder::ParentAssociativity ( )

Returns the option to keep associativity of the cylinder axis
Created in NX8.0.0.



License requirements : None

bool NXOpen::Features::CylinderBuilder::ReverseDirection ( )

Returns the reverse direction.


Created in NX5.0.0.

License requirements : None

void NXOpen::Features::CylinderBuilder::SetAxis ( NXOpen::Axis axis)

Sets the axis
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
axisaxis
void NXOpen::Features::CylinderBuilder::SetDirection ( const NXOpen::Vector3d vector)

Sets the cylinder direction.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
vectorvector
void NXOpen::Features::CylinderBuilder::SetOrigin ( const NXOpen::Point3d origin)

Sets the cylinder origin.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
originorigin
void NXOpen::Features::CylinderBuilder::SetParentAssociativity ( bool  parentAssociativity)

Sets the option to keep associativity of the cylinder axis
Created in NX8.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
parentAssociativityparentassociativity
void NXOpen::Features::CylinderBuilder::SetReverseDirection ( bool  reverse)

Sets the reverse direction.


Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
reversereverse
void NXOpen::Features::CylinderBuilder::SetType ( NXOpen::Features::CylinderBuilder::Types  type)

Sets the type
Created in NX5.0.0.



License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR insp_programming ("INSPECTION PROGRAMMING")

Parameters
typetype
NXOpen::Features::CylinderBuilder::Types NXOpen::Features::CylinderBuilder::Type ( )

Returns the type
Created in NX5.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.