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

This is the builder class to create or edit a Trace object. More...

Inheritance diagram for NXOpen::Motion::PackagingTraceBuilder:
NXOpen::Motion::PackagingBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Frame { FrameAbsolute, FrameRelative }
 Trace reference frame type. More...
 

Public Member Functions

NXOpen::Motion::PackagingTraceBuilder::Frame FrameType ()
 Returns the NXOpen::Motion::PackagingTrace reference frame type defined at NXOpen::Motion::PackagingTraceBuilder::Frame
Created in NX4.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetRelativeLinks ()
 Returns NXOpen::Motion::PackagingTrace relative links. More...
 
void SetFrameType (NXOpen::Motion::PackagingTraceBuilder::Frame fType)
 Sets the NXOpen::Motion::PackagingTrace reference frame type defined at NXOpen::Motion::PackagingTraceBuilder::Frame
Created in NX4.0.0. More...
 
void SetRelativeLinks (const std::vector< NXOpen::DisplayableObject * > &links)
 Sets NXOpen::Motion::PackagingTrace relative links. More...
 
void SetTargetLayer (int targetLayer)
 Sets the NXOpen::Motion::PackagingTrace target layer
Created in NX4.0.0. More...
 
int TargetLayer ()
 Returns the NXOpen::Motion::PackagingTrace target layer
Created in NX4.0.0. More...
 
- Public Member Functions inherited from NXOpen::Motion::PackagingBuilder
bool Enable ()
 Returns the enable flag of NXOpen::Motion::Packaging object. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetList1 ()
 Returns geometry list 1 of NXOpen::Motion::Packaging object. More...
 
NXString Name ()
 Returns the name of NXOpen::Motion::Packaging object. More...
 
void SetEnable (bool enable)
 Sets the enable flag of NXOpen::Motion::Packaging object. More...
 
void SetList1 (const std::vector< NXOpen::DisplayableObject * > &list1)
 Sets geometry list 1. More...
 
void SetName (const NXString &name)
 Sets the name of NXOpen::Motion::Packaging object. More...
 
void SetName (const char *name)
 Sets the name of NXOpen::Motion::Packaging object. 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

This is the builder class to create or edit a Trace object.


To create a new instance of this class, use NXOpen::Motion::PackagingCollection::CreateTraceBuilder

Created in NX4.0.0.

Member Enumeration Documentation

Trace reference frame type.

Enumerator
FrameAbsolute 

Traced copies positioned in absolute coordinate system.

FrameRelative 

Traced copies positioned relative to selected links.

Member Function Documentation

NXOpen::Motion::PackagingTraceBuilder::Frame NXOpen::Motion::PackagingTraceBuilder::FrameType ( )

Returns the NXOpen::Motion::PackagingTrace reference frame type defined at NXOpen::Motion::PackagingTraceBuilder::Frame
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

std::vector<NXOpen::DisplayableObject *> NXOpen::Motion::PackagingTraceBuilder::GetRelativeLinks ( )

Returns NXOpen::Motion::PackagingTrace relative links.

Only available when frame type is NXOpen::Motion::PackagingTraceBuilder::FrameRelative .

Returns
The list pointer
Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")
void NXOpen::Motion::PackagingTraceBuilder::SetFrameType ( NXOpen::Motion::PackagingTraceBuilder::Frame  fType)

Sets the NXOpen::Motion::PackagingTrace reference frame type defined at NXOpen::Motion::PackagingTraceBuilder::Frame
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
fTypeTrace reference frame type defined in NXOpen::Motion::PackagingTraceBuilder::Frame
void NXOpen::Motion::PackagingTraceBuilder::SetRelativeLinks ( const std::vector< NXOpen::DisplayableObject * > &  links)

Sets NXOpen::Motion::PackagingTrace relative links.

Only used when frame type is NXOpen::Motion::PackagingTraceBuilder::FrameRelative .
Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
linksThe list pointer
void NXOpen::Motion::PackagingTraceBuilder::SetTargetLayer ( int  targetLayer)

Sets the NXOpen::Motion::PackagingTrace target layer
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
targetLayerTarget layer
int NXOpen::Motion::PackagingTraceBuilder::TargetLayer ( )

Returns the NXOpen::Motion::PackagingTrace target layer
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")


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