NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Die::TrimTaskBuilder Class Reference

Represents a Trim Task feature builder. More...

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

List of all members.

Public Types

enum  CamTypes { CamTypesDirect = 2, CamTypesAerial = 0, CamTypesBaseMounted }
 Settings for the cam type of the trim task. More...
enum  MatchCutTypes { MatchCutTypesNone, MatchCutTypesAtStart, MatchCutTypesAtEnd, MatchCutTypesAtBoth }
 Settings for the match cut type of the trim task. More...

Public Member Functions

double AngleTolerance ()
 Returns the angle tolerance of the trim task
Created in NX4.0.0.
NXOpen::ILocationCamDirection ()
 Returns the cam direction of the trim task
Created in NX4.0.0.
NXOpen::Die::TrimTaskBuilder::CamTypes CamType ()
 Returns the cam type of the trim task
Created in NX4.0.0.
bool CreateScrap ()
 Returns the create scrap setting of the trim task.
double DistanceTolerance ()
 Returns the distance tolerance of the trim task
Created in NX4.0.0.
NXOpen::ISurfaceEndPlane ()
 Returns the end plane of the trim task
Created in NX4.0.0.
bool FinishOperation ()
 Returns the finish operation of the trim task True indicates the trim is to be a finish trim.
std::vector
< NXOpen::DisplayableObject * > 
GetAssociativeObjects ()
 Gets the associative objects of the trim task.
std::vector< NXStringGetCameraLayerAndXmlp (std::vector< NXString > &xmlpData)
 Gets the camera layer settings and xmlp data.
std::vector< NXStringGetCameraNames ()
 Gets the names of the camera.
std::vector< NXOpen::View * > GetCameraViews ()
 Gets the camera views of the trim task.
std::vector< NXStringGetDetails ()
 Gets the detailed description of the trim task.
std::vector< NXOpen::ISurface * > GetScrapCutters ()
 Gets the scrap cutters of the trim task.
std::vector< NXOpen::IProfile * > GetTrimBounds (NXOpen::Die::DirectionOption *direction)
 Gets the trim bounds of the trim task.
bool LayoutFlange ()
 Returns the layout flange setting of the trim task.
double MatchCutExtensionAngle ()
 Returns the match cut extension angle dimension of the trim task
Created in NX4.0.0.
double MatchCutFirstRadius ()
 Returns the match cut first radius dimension of the trim task
Created in NX4.0.0.
double MatchCutNotchOffset ()
 Returns the match cut notch offset dimension of the trim task
Created in NX4.0.0.
double MatchCutOffsetFromPlane ()
 Returns the match cut offset from plane dimension of the trim task
Created in NX4.0.0.
double MatchCutOffsetLength ()
 Returns the match cut offset length dimension of the trim task
Created in NX4.0.0.
double MatchCutScrapCutterLength ()
 Returns the match cut scrap cutter length dimension of the trim task
Created in NX4.0.0.
double MatchCutSecondRadius ()
 Returns the match cut second radius dimension of the trim task
Created in NX4.0.0.
double MatchCutThirdRadius ()
 Returns the match cut third radius dimension of the trim task
Created in NX4.0.0.
NXOpen::Die::TrimTaskBuilder::MatchCutTypes MatchCutType ()
 Returns the match cut type of the trim task
Created in NX4.0.0.
bool ReverseTrimSide ()
 Returns the reverse trim side setting of the trim task.
void SetAngleTolerance (double angleTolerance)
 Sets the angle tolerance of the trim task
Created in NX4.0.0.
void SetAssociativeObjects (const std::vector< NXOpen::DisplayableObject * > &objects)
 Sets the associative objects of the trim task
Created in NX4.0.0.
void SetCamDirection (NXOpen::ILocation *camDirection)
 Sets the cam direction of the trim task
Created in NX4.0.0.
void SetCameraLayerAndXmlp (std::vector< NXString > &layerSettings, std::vector< NXString > &xmlpData)
 Sets the camera layer settings and xmlp data
Created in NX4.0.0.
void SetCameraNames (std::vector< NXString > &strings)
 Sets the names of the camera
Created in NX4.0.0.
void SetCameraViews (const std::vector< NXOpen::View * > &objects)
 Sets the camera views of the trim task
Created in NX4.0.0.
void SetCamType (NXOpen::Die::TrimTaskBuilder::CamTypes camType)
 Sets the cam type of the trim task
Created in NX4.0.0.
void SetCreateScrap (bool createScrap)
 Sets the create scrap setting of the trim task.
void SetDetails (std::vector< NXString > &strings)
 Sets the detailed description of the trim task
Created in NX4.0.0.
void SetDistanceTolerance (double distanceTolerance)
 Sets the distance tolerance of the trim task
Created in NX4.0.0.
void SetEndPlane (NXOpen::ISurface *endPlane)
 Sets the end plane of the trim task
Created in NX4.0.0.
void SetFinishOperation (bool finishOperation)
 Sets the finish operation of the trim task True indicates the trim is to be a finish trim.
void SetLayoutFlange (bool layoutFlange)
 Sets the layout flange setting of the trim task.
void SetMatchCutExtensionAngle (double extensionAngle)
 Sets the match cut extension angle dimension of the trim task
Created in NX4.0.0.
void SetMatchCutFirstRadius (double firstRadius)
 Sets the match cut first radius dimension of the trim task
Created in NX4.0.0.
void SetMatchCutNotchOffset (double notchOffset)
 Sets the match cut notch offset dimension of the trim task
Created in NX4.0.0.
void SetMatchCutOffsetFromPlane (double offsetFromPlane)
 Sets the match cut offset from plane dimension of the trim task
Created in NX4.0.0.
void SetMatchCutOffsetLength (double offsetLength)
 Sets the match cut offset length dimension of the trim task
Created in NX4.0.0.
void SetMatchCutScrapCutterLength (double scrapCutterLength)
 Sets the match cut scrap cutter length dimension of the trim task
Created in NX4.0.0.
void SetMatchCutSecondRadius (double secondRadius)
 Sets the match cut second radius dimension of the trim task
Created in NX4.0.0.
void SetMatchCutThirdRadius (double thirdRadius)
 Sets the match cut third radius dimension of the trim task
Created in NX4.0.0.
void SetMatchCutType (NXOpen::Die::TrimTaskBuilder::MatchCutTypes matchCutType)
 Sets the match cut type of the trim task
Created in NX4.0.0.
void SetReverseTrimSide (bool reverse)
 Sets the reverse trim side setting of the trim task.
void SetScrapCutters (const std::vector< NXOpen::ISurface * > &planes)
 Sets the scrap cutters of the trim task
Created in NX4.0.0.
void SetStartPlane (NXOpen::ISurface *startPlane)
 Sets the start plane of the trim task
Created in NX4.0.0.
void SetTippedProduct (NXOpen::Features::Feature *tippedProduct)
 Sets the tipped product of the trim task
Created in NX4.0.0.
void SetTrimBounds (NXOpen::Die::DirectionOption direction, const std::vector< NXOpen::IProfile * > &profileEntries)
 Sets the trim bounds of the trim task.
NXOpen::ISurfaceStartPlane ()
 Returns the start plane of the trim task
Created in NX4.0.0.
NXOpen::Features::FeatureTippedProduct ()
 Returns the tipped product of the trim task
Created in NX4.0.0.

Detailed Description

Represents a Trim Task feature builder.


To create a new instance of this class, use Die::DieCollection::TrimTask

Created in NX4.0.0.


Member Enumeration Documentation

Settings for the cam type of the trim task.

Enumerator:
CamTypesBaseMounted 

Base Mounted Cam.

Settings for the match cut type of the trim task.

Enumerator:
MatchCutTypesNone 

No match cut.

MatchCutTypesAtStart 

At start plane only.

MatchCutTypesAtEnd 

At end plane only.

MatchCutTypesAtBoth 

At both start and end planes.


Member Function Documentation

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



License requirements : die_engineering ("DIE ENGINEERING")

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



License requirements : die_engineering ("DIE ENGINEERING")

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



License requirements : die_engineering ("DIE ENGINEERING")

Returns the create scrap setting of the trim task.

True indicates that the scrap is to be created.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

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



License requirements : die_engineering ("DIE ENGINEERING")

Returns the end plane of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the finish operation of the trim task True indicates the trim is to be a finish trim.

False indicates rough trim.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the associative objects of the trim task.

Returns:

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")
std::vector<NXString> NXOpen::Die::TrimTaskBuilder::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

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")

Gets the camera views of the trim task.

Returns:

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the detailed description of the trim task.

Returns:
detail strings
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the scrap cutters of the trim task.

Returns:

Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Gets the trim bounds of the trim task.

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

License requirements : die_engineering ("DIE ENGINEERING")
Parameters:
directionProfile direction

Returns the layout flange setting of the trim task.

True indicates that the trim curve is to be laid out on the flange.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut extension angle dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut first radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut notch offset dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut offset from plane dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut offset length dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut scrap cutter length dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut second radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut third radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the match cut type of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Returns the reverse trim side setting of the trim task.

True indicates that the trim side should be reversed.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

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

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
angleToleranceangle tolerance

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
objectsobjects

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
camDirectioncam direction
void NXOpen::Die::TrimTaskBuilder::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.
NOTE: The full Unicode character set is not supported for this parameter.
xmlpDataxmlp data
void NXOpen::Die::TrimTaskBuilder::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
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Die::TrimTaskBuilder::SetCameraViews ( const std::vector< NXOpen::View * > &  objects)

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
objectsobjects

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
camTypecam type

Sets the create scrap setting of the trim task.

True indicates that the scrap is to be created.
Created in NX7.5.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
createScrapcreate scrap
void NXOpen::Die::TrimTaskBuilder::SetDetails ( std::vector< NXString > &  strings)

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
stringsdetail strings
NOTE: The full Unicode character set is not supported for this parameter.
void NXOpen::Die::TrimTaskBuilder::SetDistanceTolerance ( double  distanceTolerance)

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
distanceTolerancedistance tolerance

Sets the end plane of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
endPlaneend plane
void NXOpen::Die::TrimTaskBuilder::SetFinishOperation ( bool  finishOperation)

Sets the finish operation of the trim task True indicates the trim is to be a finish trim.

False indicates rough trim.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
finishOperationfinish operation
void NXOpen::Die::TrimTaskBuilder::SetLayoutFlange ( bool  layoutFlange)

Sets the layout flange setting of the trim task.

True indicates that the trim curve is to be laid out on the flange.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
layoutFlangelayout flange

Sets the match cut extension angle dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
extensionAngleangle of extension line from perpendicular

Sets the match cut first radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
firstRadiusfirst radius after notch

Sets the match cut notch offset dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
notchOffsetnotch offset from trim line

Sets the match cut offset from plane dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
offsetFromPlaneoffset from scrap cutter plane

Sets the match cut offset length dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
offsetLengthlength of offset piece

Sets the match cut scrap cutter length dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
scrapCutterLengthentension line length

Sets the match cut second radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
secondRadiussecond radius after notch

Sets the match cut third radius dimension of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
thirdRadiusradius between offset piece and entension line

Sets the match cut type of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
matchCutTypematch cut type

Sets the reverse trim side setting of the trim task.

True indicates that the trim side should be reversed.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
reversereverse
void NXOpen::Die::TrimTaskBuilder::SetScrapCutters ( const std::vector< NXOpen::ISurface * > &  planes)

Sets the scrap cutters of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
planesplanes

Sets the start plane of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
startPlanestart plane

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



License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
tippedProductThe tip of the operation where the trim task resides.
void NXOpen::Die::TrimTaskBuilder::SetTrimBounds ( NXOpen::Die::DirectionOption  direction,
const std::vector< NXOpen::IProfile * > &  profileEntries 
)

Sets the trim bounds of the trim task.

Note - Die::TrimTaskBuilder::SetTippedProduct needs to be called before this function.
Created in NX4.0.0.

License requirements : die_engineering ("DIE ENGINEERING")

Parameters:
directionProfile direction
profileEntriesProfile entries that make up the boundary of the trim task

Returns the start plane of the trim task
Created in NX4.0.0.



License requirements : die_engineering ("DIE ENGINEERING")

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



License requirements : die_engineering ("DIE ENGINEERING")


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