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

Represents a Flange Task feature builder. More...

Inheritance diagram for NXOpen::Die::FlangeTaskBuilder:
NXOpen::Features::FeatureBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  CamTypes {
  CamTypesDirect, CamTypesAerialConventional, CamTypesBaseConventional, CamTypesAerialRotary,
  CamTypesBellCrank
}
 Settings for the cam type of the flange task. More...
 
enum  PierceTypes { PierceTypesGage, PierceTypesCritical, PierceTypesStandard }
 Settings for the pierce type of the flange task. More...
 
enum  SpringbackTypes { SpringbackTypesConstant, SpringbackTypesLaw }
 Settings for the springback type of the flange task. More...
 

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance of the flange task
Created in NX4.0.0. More...
 
NXOpen::ILocationCamDirection ()
 Returns the cam direction of the flange task
Created in NX4.0.0. More...
 
NXOpen::Die::FlangeTaskBuilder::CamTypes CamType ()
 Returns the cam type of the flange task
Created in NX4.0.0. More...
 
bool DisplayRotatedItems ()
 Returns the display rotated items setting of the flange task. More...
 
double DistanceTolerance ()
 Returns the distance tolerance of the flange task
Created in NX4.0.0. More...
 
bool FinishOperation ()
 Returns the finish operation of the flange task
Created in NX4.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetAssociativeObjects ()
 Gets the associative objects of the flange task. More...
 
std::vector< NXStringGetCameraLayerAndXmlp (std::vector< NXString > &xmlpData)
 Gets the camera layer settings and xmlp data. More...
 
std::vector< NXStringGetCameraNames ()
 Gets the names of the camera. More...
 
std::vector< NXOpen::View * > GetCameraViews ()
 Gets the camera views of the flange task. More...
 
std::vector< NXStringGetDetails ()
 Gets the detailed description of the flange task. More...
 
std::vector< NXOpen::IProfile * > GetRegionBounds (NXOpen::Die::DirectionOption *direction)
 Gets the region bounds of the flange task. More...
 
std::vector< NXOpen::IProfile * > GetShapeDetail (NXOpen::Die::DirectionOption *direction)
 Gets the shape detail of the flange task for profiles. More...
 
std::vector< NXOpen::Body * > GetShapeDetail ()
 Gets the shape detail of the form task for bodies. More...
 
bool PierceAndExtrude ()
 Returns the pierce and extrude setting of the flange task. More...
 
NXOpen::Die::FlangeTaskBuilder::PierceTypes PierceType ()
 Returns the pierce type of the flange task
Created in NX4.0.0. More...
 
NXOpen::PointPointInRegion ()
 Returns the keep point in the region of the flange task
Created in NX4.0.0. More...
 
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance of the flange task
Created in NX4.0.0. More...
 
void SetAssociativeObjects (const std::vector< NXOpen::DisplayableObject * > &objects)
 Sets the associative objects of the flange task
Created in NX4.0.0. More...
 
void SetCamDirection (NXOpen::ILocation *camDirection)
 Sets the cam direction of the flange task
Created in NX4.0.0. More...
 
void SetCameraLayerAndXmlp (std::vector< NXString > &layerSettings, std::vector< NXString > &xmlpData)
 Sets the camera layer settings and xmlp data
Created in NX4.0.0. More...
 
void SetCameraNames (std::vector< NXString > &strings)
 Sets the names of the camera
Created in NX4.0.0. More...
 
void SetCameraViews (const std::vector< NXOpen::View * > &objects)
 Sets the camera views of the flange task
Created in NX4.0.0. More...
 
void SetCamType (NXOpen::Die::FlangeTaskBuilder::CamTypes camType)
 Sets the cam type of the flange task
Created in NX4.0.0. More...
 
void SetDetails (std::vector< NXString > &strings)
 Sets the detailed description of the flange task
Created in NX4.0.0. More...
 
void SetDisplayRotatedItems (bool displaySetting)
 Sets the display rotated items setting of the flange task. More...
 
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance of the flange task
Created in NX4.0.0. More...
 
void SetFinishOperation (bool finishOperation)
 Sets the finish operation of the flange task
Created in NX4.0.0. More...
 
void SetPierceAndExtrude (bool pierceAndExtrude)
 Sets the pierce and extrude setting of the flange task. More...
 
void SetPierceType (NXOpen::Die::FlangeTaskBuilder::PierceTypes pierceType)
 Sets the pierce type of the flange task
Created in NX4.0.0. More...
 
void SetPointInRegion (NXOpen::Point *pointInRegion)
 Sets the keep point in the region of the flange task
Created in NX4.0.0. More...
 
void SetRegionBounds (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the region bounds of the flange task
Created in NX4.0.0. More...
 
void SetShapeDetail (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the shape detail of the flange task for profiles
Created in NX4.0.0. More...
 
void SetShapeDetail (const std::vector< NXOpen::Body * > &bodies)
 Sets the shape detail of the form task for bodies
Created in NX4.0.0. More...
 
void SetSpringbackAngle (const NXString &springbackAngle)
 Sets the springback angle of the flange task
Created in NX4.0.0. More...
 
void SetSpringbackAngle (const char *springbackAngle)
 Sets the springback angle of the flange task
Created in NX4.0.0. More...
 
void SetSpringbackType (NXOpen::Die::FlangeTaskBuilder::SpringbackTypes springbackType)
 Sets the springback type of the flange task
Created in NX4.0.0. More...
 
void SetTippedProduct (NXOpen::Features::Feature *tippedProduct)
 Sets the tipped product of the flange task
Created in NX4.0.0. More...
 
NXString SpringbackAngle ()
 Returns the springback angle of the flange task
Created in NX4.0.0. More...
 
NXOpen::Die::FlangeTaskBuilder::SpringbackTypes SpringbackType ()
 Returns the springback type of the flange task
Created in NX4.0.0. More...
 
NXOpen::Features::FeatureTippedProduct ()
 Returns the tipped product of the flange task
Created in NX4.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 Flange Task feature builder.


This sub feature is created via the main feature builder.

Created in NX4.0.0.

Member Enumeration Documentation

Settings for the cam type of the flange task.

Enumerator
CamTypesDirect 

Direct.

CamTypesAerialConventional 

Aerial Cam - Conventional Fill.

CamTypesBaseConventional 

Base Mounted Cam - Conventional Fill.

CamTypesAerialRotary 

Aerial Cam - Rotary Fill.

CamTypesBellCrank 

Bell Crank.

Settings for the pierce type of the flange task.

Enumerator
PierceTypesGage 

Use Gage tolerance.

PierceTypesCritical 

Use Critical tolerance.

PierceTypesStandard 

Use Standard tolerance.

Settings for the springback type of the flange task.

Enumerator
SpringbackTypesConstant 

Constant.

SpringbackTypesLaw 

Law Controlled.

Member Function Documentation

double NXOpen::Die::FlangeTaskBuilder::AngleTolerance ( )

Returns the angle tolerance of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::ILocation* NXOpen::Die::FlangeTaskBuilder::CamDirection ( )

Returns the cam direction of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::Die::FlangeTaskBuilder::CamTypes NXOpen::Die::FlangeTaskBuilder::CamType ( )

Returns the cam type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

bool NXOpen::Die::FlangeTaskBuilder::DisplayRotatedItems ( )

Returns the display rotated items setting of the flange task.

True indicates that the reference point and cam direction objects should be created and displayed in the die face feature.
Created in NX5.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

double NXOpen::Die::FlangeTaskBuilder::DistanceTolerance ( )

Returns the distance tolerance of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

bool NXOpen::Die::FlangeTaskBuilder::FinishOperation ( )

Returns the finish operation of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

std::vector<NXOpen::DisplayableObject *> NXOpen::Die::FlangeTaskBuilder::GetAssociativeObjects ( )

Gets the associative objects of the flange task.

Returns

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXString> NXOpen::Die::FlangeTaskBuilder::GetCameraLayerAndXmlp ( std::vector< NXString > &  xmlpData)

Gets the camera layer settings and xmlp data.

Returns
1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters
xmlpDataxmlp data
std::vector<NXString> NXOpen::Die::FlangeTaskBuilder::GetCameraNames ( )

Gets the names of the camera.

Returns
each string contains the name of a camera object
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXOpen::View *> NXOpen::Die::FlangeTaskBuilder::GetCameraViews ( )

Gets the camera views of the flange task.

Returns

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXString> NXOpen::Die::FlangeTaskBuilder::GetDetails ( )

Gets the detailed description of the flange task.

Returns
detail strings
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXOpen::IProfile *> NXOpen::Die::FlangeTaskBuilder::GetRegionBounds ( NXOpen::Die::DirectionOption direction)

Gets the region bounds of the flange task.

Returns
Profile entries that make up the boundary of the flange task
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters
directionProfile direction
std::vector<NXOpen::IProfile *> NXOpen::Die::FlangeTaskBuilder::GetShapeDetail ( NXOpen::Die::DirectionOption direction)

Gets the shape detail of the flange task for profiles.

Returns
Profile entries
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
Parameters
directionProfile direction
std::vector<NXOpen::Body *> NXOpen::Die::FlangeTaskBuilder::GetShapeDetail ( )

Gets the shape detail of the form task for bodies.

Returns
bodies
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
bool NXOpen::Die::FlangeTaskBuilder::PierceAndExtrude ( )

Returns the pierce and extrude setting of the flange task.

True indicates that the flange task is a pierce and extrude type.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::Die::FlangeTaskBuilder::PierceTypes NXOpen::Die::FlangeTaskBuilder::PierceType ( )

Returns the pierce type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::Point* NXOpen::Die::FlangeTaskBuilder::PointInRegion ( )

Returns the keep point in the region of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

void NXOpen::Die::FlangeTaskBuilder::SetAngleTolerance ( double  angleTolerance)

Sets the angle tolerance of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
angleToleranceangle tolerance
void NXOpen::Die::FlangeTaskBuilder::SetAssociativeObjects ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Sets the associative objects of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
objectsobjects
void NXOpen::Die::FlangeTaskBuilder::SetCamDirection ( NXOpen::ILocation camDirection)

Sets the cam direction of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
camDirectioncam direction
void NXOpen::Die::FlangeTaskBuilder::SetCameraLayerAndXmlp ( std::vector< NXString > &  layerSettings,
std::vector< NXString > &  xmlpData 
)

Sets the camera layer settings and xmlp data
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
layerSettings1 layer setting string for each camera object. the string needs to be 256 characters long (one for each user layer) with either 0 for off or 1 for on.
xmlpDataxmlp data
void NXOpen::Die::FlangeTaskBuilder::SetCameraNames ( std::vector< NXString > &  strings)

Sets the names of the camera
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
stringseach string contains the name of a camera object
void NXOpen::Die::FlangeTaskBuilder::SetCameraViews ( const std::vector< NXOpen::View * > &  objects)

Sets the camera views of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
objectsobjects
void NXOpen::Die::FlangeTaskBuilder::SetCamType ( NXOpen::Die::FlangeTaskBuilder::CamTypes  camType)

Sets the cam type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
camTypecam type
void NXOpen::Die::FlangeTaskBuilder::SetDetails ( std::vector< NXString > &  strings)

Sets the detailed description of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
stringsdetail strings
void NXOpen::Die::FlangeTaskBuilder::SetDisplayRotatedItems ( bool  displaySetting)

Sets the display rotated items setting of the flange task.

True indicates that the reference point and cam direction objects should be created and displayed in the die face feature.
Created in NX5.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters
displaySettingdisplay setting
void NXOpen::Die::FlangeTaskBuilder::SetDistanceTolerance ( double  distanceTolerance)

Sets the distance tolerance of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
distanceTolerancedistance tolerance
void NXOpen::Die::FlangeTaskBuilder::SetFinishOperation ( bool  finishOperation)

Sets the finish operation of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
finishOperationfinish operation
void NXOpen::Die::FlangeTaskBuilder::SetPierceAndExtrude ( bool  pierceAndExtrude)

Sets the pierce and extrude setting of the flange task.

True indicates that the flange task is a pierce and extrude type.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters
pierceAndExtrudepierce and extrude
void NXOpen::Die::FlangeTaskBuilder::SetPierceType ( NXOpen::Die::FlangeTaskBuilder::PierceTypes  pierceType)

Sets the pierce type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
pierceTypepierce type
void NXOpen::Die::FlangeTaskBuilder::SetPointInRegion ( NXOpen::Point pointInRegion)

Sets the keep point in the region of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
pointInRegionpoint in region
void NXOpen::Die::FlangeTaskBuilder::SetRegionBounds ( NXOpen::Die::DirectionOption  direction,
const std::vector< NXOpen::IProfile * > &  profileEntries 
)

Sets the region bounds of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
directionProfile direction
profileEntriesProfile entries that make up the boundary of the flange task
void NXOpen::Die::FlangeTaskBuilder::SetShapeDetail ( NXOpen::Die::DirectionOption  direction,
const std::vector< NXOpen::IProfile * > &  profileEntries 
)

Sets the shape detail of the flange task for profiles
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
directionProfile direction
profileEntriesProfile entries
void NXOpen::Die::FlangeTaskBuilder::SetShapeDetail ( const std::vector< NXOpen::Body * > &  bodies)

Sets the shape detail of the form task for bodies
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
bodiesbodies
void NXOpen::Die::FlangeTaskBuilder::SetSpringbackAngle ( const NXString springbackAngle)

Sets the springback angle of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
springbackAngleexpression string
void NXOpen::Die::FlangeTaskBuilder::SetSpringbackAngle ( const char *  springbackAngle)

Sets the springback angle of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
springbackAngleexpression string
void NXOpen::Die::FlangeTaskBuilder::SetSpringbackType ( NXOpen::Die::FlangeTaskBuilder::SpringbackTypes  springbackType)

Sets the springback type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
springbackTypespringback type
void NXOpen::Die::FlangeTaskBuilder::SetTippedProduct ( NXOpen::Features::Feature tippedProduct)

Sets the tipped product of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters
tippedProductThe tip of the operation where the flange task resides.
NXString NXOpen::Die::FlangeTaskBuilder::SpringbackAngle ( )

Returns the springback angle of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::Die::FlangeTaskBuilder::SpringbackTypes NXOpen::Die::FlangeTaskBuilder::SpringbackType ( )

Returns the springback type of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

NXOpen::Features::Feature* NXOpen::Die::FlangeTaskBuilder::TippedProduct ( )

Returns the tipped product of the flange task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")


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