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

This the builder class to create or edit an Interference object. More...

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

Public Types

enum  Action { ActionHighlight, ActionCreateSolids, ActionShowIntersectionCurve }
 Interference action type. More...
 
enum  Frame {
  FrameAbsolute, FrameFirstSet, FrameSecondSet, FrameBothSets,
  FrameSelected
}
 Interference solid reference frame type. More...
 
enum  Mode { ModeFaceted, ModePreciseSolid }
 Interference calculation mode type. More...
 

Public Member Functions

NXOpen::Motion::PackagingInterferenceBuilder::Action ActionType ()
 Returns the NXOpen::Motion::PackagingInterference action type defined at NXOpen::Motion::PackagingInterferenceBuilder::Action
Created in NX4.0.0. More...
 
NXOpen::ExpressionClearanceExpression ()
 Returns the clearance expression value
Created in NX8.5.0. More...
 
NXOpen::Motion::PackagingInterferenceBuilder::Frame FrameType ()
 Returns the NXOpen::Motion::PackagingInterference frame type defined at NXOpen::Motion::PackagingInterferenceBuilder::Frame
Created in NX4.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetList2 ()
 Gets the geometry list 2 of NXOpen::Motion::PackagingInterference object. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetRelativeLinks ()
 Returns NXOpen::Motion::PackagingInterference user selected relative links. More...
 
NXOpen::Motion::PackagingInterferenceBuilder::Mode ModeType ()
 Returns the NXOpen::Motion::PackagingInterference mode type defined at NXOpen::Motion::PackagingInterferenceBuilder::Mode
Created in NX4.0.0. More...
 
void SetActionType (NXOpen::Motion::PackagingInterferenceBuilder::Action aType)
 Sets the NXOpen::Motion::PackagingInterference action type defined at NXOpen::Motion::PackagingInterferenceBuilder::Action
Created in NX4.0.0. More...
 
void SetFrameType (NXOpen::Motion::PackagingInterferenceBuilder::Frame fType)
 Sets the NXOpen::Motion::PackagingInterference frame type defined at NXOpen::Motion::PackagingInterferenceBuilder::Frame
Created in NX4.0.0. More...
 
void SetList2 (const std::vector< NXOpen::DisplayableObject * > &list2)
 Sets the geometry list 2 of NXOpen::Motion::PackagingInterference object. More...
 
void SetModeType (NXOpen::Motion::PackagingInterferenceBuilder::Mode mType)
 Sets the NXOpen::Motion::PackagingInterference mode type defined at NXOpen::Motion::PackagingInterferenceBuilder::Mode
Created in NX4.0.0. More...
 
void SetRelativeLinks (const std::vector< NXOpen::DisplayableObject * > &links)
 Sets NXOpen::Motion::PackagingInterference user selected relative links. More...
 
void SetStopOnEvent (bool stopOnEvent)
 Sets the Stop_On_Event flag of NXOpen::Motion::PackagingInterference object
Created in NX4.0.0. More...
 
bool StopOnEvent ()
 Returns the Stop_On_Event flag of NXOpen::Motion::PackagingInterference object
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 the builder class to create or edit an Interference object.


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

Created in NX4.0.0.

Member Enumeration Documentation

Interference action type.

Enumerator
ActionHighlight 

Highlight interfering bodies.

ActionCreateSolids 

Create solids of interference volumes.

ActionShowIntersectionCurve 

Show intersection curve of interference volumes.

Interference solid reference frame type.

Only used for action type of NXOpen::Motion::PackagingInterferenceBuilder::ActionCreateSolids .

Enumerator
FrameAbsolute 

Interference solids positioned in absolute coordinate system.

FrameFirstSet 

Interference solids positioned relative to interfering links in first set.

FrameSecondSet 

Interference solids positioned relative to interfering links in second set.

FrameBothSets 

Interference solids positioned relative to interfering links in both sets.

FrameSelected 

Interference solids positioned relative to user selected links.

Interference calculation mode type.

Enumerator
ModeFaceted 

Interference calculated by Faceted method.

Faceted is only allowed for action type of NXOpen::Motion::PackagingInterferenceBuilder::ActionCreateSolids .

ModePreciseSolid 

Interference calculated by Precise Solid method.

Member Function Documentation

NXOpen::Motion::PackagingInterferenceBuilder::Action NXOpen::Motion::PackagingInterferenceBuilder::ActionType ( )

Returns the NXOpen::Motion::PackagingInterference action type defined at NXOpen::Motion::PackagingInterferenceBuilder::Action
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::PackagingInterferenceBuilder::ClearanceExpression ( )

Returns the clearance expression value
Created in NX8.5.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::PackagingInterferenceBuilder::Frame NXOpen::Motion::PackagingInterferenceBuilder::FrameType ( )

Returns the NXOpen::Motion::PackagingInterference frame type defined at NXOpen::Motion::PackagingInterferenceBuilder::Frame
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

std::vector<NXOpen::DisplayableObject *> NXOpen::Motion::PackagingInterferenceBuilder::GetList2 ( )

Gets the geometry list 2 of NXOpen::Motion::PackagingInterference object.

Interference can have one or two lists defined. If the user defines two lists, then interference checks will be done between each object in list 1 against each object in list 2.

Returns

Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")
std::vector<NXOpen::DisplayableObject *> NXOpen::Motion::PackagingInterferenceBuilder::GetRelativeLinks ( )

Returns NXOpen::Motion::PackagingInterference user selected relative links.

Only available when frame type is NXOpen::Motion::PackagingInterferenceBuilder::FrameSelected .

Returns

Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")
NXOpen::Motion::PackagingInterferenceBuilder::Mode NXOpen::Motion::PackagingInterferenceBuilder::ModeType ( )

Returns the NXOpen::Motion::PackagingInterference mode type defined at NXOpen::Motion::PackagingInterferenceBuilder::Mode
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PackagingInterferenceBuilder::SetActionType ( NXOpen::Motion::PackagingInterferenceBuilder::Action  aType)

Sets the NXOpen::Motion::PackagingInterference action type defined at NXOpen::Motion::PackagingInterferenceBuilder::Action
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
aTypea type
void NXOpen::Motion::PackagingInterferenceBuilder::SetFrameType ( NXOpen::Motion::PackagingInterferenceBuilder::Frame  fType)

Sets the NXOpen::Motion::PackagingInterference frame type defined at NXOpen::Motion::PackagingInterferenceBuilder::Frame
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
fTypef type
void NXOpen::Motion::PackagingInterferenceBuilder::SetList2 ( const std::vector< NXOpen::DisplayableObject * > &  list2)

Sets the geometry list 2 of NXOpen::Motion::PackagingInterference object.


Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
list2list2
void NXOpen::Motion::PackagingInterferenceBuilder::SetModeType ( NXOpen::Motion::PackagingInterferenceBuilder::Mode  mType)

Sets the NXOpen::Motion::PackagingInterference mode type defined at NXOpen::Motion::PackagingInterferenceBuilder::Mode
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
mTypem type
void NXOpen::Motion::PackagingInterferenceBuilder::SetRelativeLinks ( const std::vector< NXOpen::DisplayableObject * > &  links)

Sets NXOpen::Motion::PackagingInterference user selected relative links.

Only used when frame type is NXOpen::Motion::PackagingInterferenceBuilder::FrameSelected .
Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
linkslinks
void NXOpen::Motion::PackagingInterferenceBuilder::SetStopOnEvent ( bool  stopOnEvent)

Sets the Stop_On_Event flag of NXOpen::Motion::PackagingInterference object
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
stopOnEventstop on event
bool NXOpen::Motion::PackagingInterferenceBuilder::StopOnEvent ( )

Returns the Stop_On_Event flag of NXOpen::Motion::PackagingInterference object
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.