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

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

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

Classes

struct  GeometryData
 Represents geometry data. More...
 

Public Types

enum  MeasureCondition { MeasureConditionLessThan, MeasureConditionGreaterThan, MeasureConditionEqualTo }
 Measure condition. More...
 
enum  MeasureType { MeasureTypeMinimumDistance, MeasureTypeAngle }
 Measure type. More...
 

Public Member Functions

NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition Condition ()
 Returns the measure condition defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition
Created in NX4.0.0. More...
 
std::vector
< NXOpen::DisplayableObject * > 
GetList2 ()
 Returns the geometry list 2 of NXOpen::Motion::PackagingMeasure object. More...
 
void GetSourceList (std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &sourceGeometryData)
 Gets the source geometry data. More...
 
void GetTargetList (std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &targetGeometryData)
 Gets the target geometry data. More...
 
NXOpen::Motion::PackagingMeasureBuilder::MeasureType MsType ()
 Returns the Measure type defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureType
Created in NX4.0.0. More...
 
void SetCondition (NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition condition)
 Sets the measure condition defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition
Created in NX4.0.0. More...
 
void SetList2 (const std::vector< NXOpen::DisplayableObject * > &list2)
 Sets the geometry list 2. More...
 
void SetMsType (NXOpen::Motion::PackagingMeasureBuilder::MeasureType mType)
 Sets the Measure type defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureType
Created in NX4.0.0. More...
 
void SetSourceList (const std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &sourceGeometryData)
 Sets the source geometry data. More...
 
void SetStopOnEvent (bool stopOnEvent)
 Sets the Stop_On_Event flag of NXOpen::Motion::PackagingMeasure object
Created in NX4.0.0. More...
 
void SetTargetList (const std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &targetGeometryData)
 Sets the target geometry data. More...
 
bool StopOnEvent ()
 Returns the Stop_On_Event flag of NXOpen::Motion::PackagingMeasure object
Created in NX4.0.0. More...
 
NXOpen::ExpressionThresholdAngleExpression ()
 Returns the Measure angular threshold expression value
Created in NX8.0.0. More...
 
NXOpen::ExpressionThresholdExpression ()
 Returns the Measure threshold expression value
Created in NX8.0.0. More...
 
NXOpen::ExpressionToleranceAngleExpression ()
 Returns the Measure angular tolerance expression value
Created in NX8.0.0. More...
 
NXOpen::ExpressionToleranceExpression ()
 Returns the Measure tolerance expression value
Created in NX8.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 Measure object.


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

Created in NX4.0.0.

Member Enumeration Documentation

Measure condition.

Enumerator
MeasureConditionLessThan 

Stop event defined by minimum measurement less than threshold value.

MeasureConditionGreaterThan 

Stop event defined by minimum measurement greater than threshold value.

MeasureConditionEqualTo 

Stop event defined by minimum measurement equal to threshold (target) value.

Measure type.

Enumerator
MeasureTypeMinimumDistance 

Measure minimum distance between objects.

MeasureTypeAngle 

Measure angle between lines or linear edges.

Member Function Documentation

NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition NXOpen::Motion::PackagingMeasureBuilder::Condition ( )

Returns the measure condition defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

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

Returns the geometry list 2 of NXOpen::Motion::PackagingMeasure object.

Measure can have one or two lists defined. If the user defines two lists, then measurements 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")
void NXOpen::Motion::PackagingMeasureBuilder::GetSourceList ( std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &  sourceGeometryData)

Gets the source geometry data.


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
sourceGeometryDataSource geometry data
void NXOpen::Motion::PackagingMeasureBuilder::GetTargetList ( std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &  targetGeometryData)

Gets the target geometry data.


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
targetGeometryDataTarget geometry data
NXOpen::Motion::PackagingMeasureBuilder::MeasureType NXOpen::Motion::PackagingMeasureBuilder::MsType ( )

Returns the Measure type defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureType
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PackagingMeasureBuilder::SetCondition ( NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition  condition)

Sets the measure condition defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureCondition
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
conditioncondition
void NXOpen::Motion::PackagingMeasureBuilder::SetList2 ( const std::vector< NXOpen::DisplayableObject * > &  list2)

Sets the geometry list 2.


Created in NX4.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
list2list2
void NXOpen::Motion::PackagingMeasureBuilder::SetMsType ( NXOpen::Motion::PackagingMeasureBuilder::MeasureType  mType)

Sets the Measure type defined at NXOpen::Motion::PackagingMeasureBuilder::MeasureType
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
mTypem type
void NXOpen::Motion::PackagingMeasureBuilder::SetSourceList ( const std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &  sourceGeometryData)

Sets the source geometry data.


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
sourceGeometryDataSource geometry data
void NXOpen::Motion::PackagingMeasureBuilder::SetStopOnEvent ( bool  stopOnEvent)

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



License requirements : mechanisms ("MECHANISMS")

Parameters
stopOnEventstop on event
void NXOpen::Motion::PackagingMeasureBuilder::SetTargetList ( const std::vector< NXOpen::Motion::PackagingMeasureBuilder::GeometryData > &  targetGeometryData)

Sets the target geometry data.


Created in NX7.5.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
targetGeometryDataTarget geometry data
bool NXOpen::Motion::PackagingMeasureBuilder::StopOnEvent ( )

Returns the Stop_On_Event flag of NXOpen::Motion::PackagingMeasure object
Created in NX4.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::PackagingMeasureBuilder::ThresholdAngleExpression ( )

Returns the Measure angular threshold expression value
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::PackagingMeasureBuilder::ThresholdExpression ( )

Returns the Measure threshold expression value
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::PackagingMeasureBuilder::ToleranceAngleExpression ( )

Returns the Measure angular tolerance expression value
Created in NX8.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Expression* NXOpen::Motion::PackagingMeasureBuilder::ToleranceExpression ( )

Returns the Measure tolerance expression value
Created in NX8.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.