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

Represents SearchCriteriaDatumTargetBuilder
To create a new instance of this class, use NXOpen::Annotations::SearchModelViewCollection::CreateSearchCriteriaDatumTargetBuilder

Created in NX7.5.0. More...

Inheritance diagram for NXOpen::Annotations::SearchCriteriaDatumTargetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  DatumTargetMovableOptions { DatumTargetMovableOptionsNo, DatumTargetMovableOptionsYes }
 Represents the search pmi movable datum target type. More...
 
enum  DatumTargetTypes {
  DatumTargetTypesPoint, DatumTargetTypesLine, DatumTargetTypesRectangular, DatumTargetTypesCircular,
  DatumTargetTypesAnnular, DatumTargetTypesSpherical, DatumTargetTypesCylindrical, DatumTargetTypesArbitrary
}
 Lists the search pmi datum target type. More...
 

Public Member Functions

bool ByDatumMovable ()
 Returns the movable datum target option
Created in NX10.0.0. More...
 
bool ByDatumTargetLabel ()
 Returns the datum target label toggle
Created in NX7.5.0. More...
 
bool ByDatumTargetType ()
 Returns the datum target type toggle
Created in NX7.5.0. More...
 
bool ByHeight ()
 Returns the height toggle
Created in NX7.5.0. More...
 
bool ByInnerDiameter ()
 Returns the inner diameter toggle
Created in NX7.5.0. More...
 
bool ByOuterDiameter ()
 Returns the outer diameter toggle
Created in NX7.5.0. More...
 
bool ByText ()
 Returns the text toggle
Created in NX7.5.0. More...
 
bool ByWidth ()
 Returns the width toggle
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetMovableOptions DatumMovable ()
 Returns the movable datum target type
Created in NX10.0.0. More...
 
NXString DatumTargetLabelText ()
 Returns the datum target label text
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetTypes DatumTargetType ()
 Returns the datum target type enum
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions HeightType ()
 Returns the height enum
Created in NX7.5.0. More...
 
double HeightValue ()
 Returns the height value
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions InnerDiameterType ()
 Returns the inner diameter enum
Created in NX7.5.0. More...
 
double InnerDiameterValue ()
 Returns the inner diameter value
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions OuterDiameterType ()
 Returns the outer diameter enum
Created in NX7.5.0. More...
 
double OuterDiameterValue ()
 Returns the outer diameter value
Created in NX7.5.0. More...
 
void SetByDatumMovable (bool datumMovable)
 Sets the movable datum target option
Created in NX10.0.0. More...
 
void SetByDatumTargetLabel (bool datumTargetLabel)
 Sets the datum target label toggle
Created in NX7.5.0. More...
 
void SetByDatumTargetType (bool datumTargetType)
 Sets the datum target type toggle
Created in NX7.5.0. More...
 
void SetByHeight (bool height)
 Sets the height toggle
Created in NX7.5.0. More...
 
void SetByInnerDiameter (bool innerDiameter)
 Sets the inner diameter toggle
Created in NX7.5.0. More...
 
void SetByOuterDiameter (bool outerDiameter)
 Sets the outer diameter toggle
Created in NX7.5.0. More...
 
void SetByText (bool text)
 Sets the text toggle
Created in NX7.5.0. More...
 
void SetByWidth (bool width)
 Sets the width toggle
Created in NX7.5.0. More...
 
void SetDatumMovable (NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetMovableOptions datumTargetMovable)
 Sets the movable datum target type
Created in NX10.0.0. More...
 
void SetDatumTargetLabelText (const NXString &datumTargetLabelText)
 Sets the datum target label text
Created in NX7.5.0. More...
 
void SetDatumTargetLabelText (const char *datumTargetLabelText)
 Sets the datum target label text
Created in NX7.5.0. More...
 
void SetDatumTargetType (NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetTypes datumTargetType)
 Sets the datum target type enum
Created in NX7.5.0. More...
 
void SetHeightType (NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions heightType)
 Sets the height enum
Created in NX7.5.0. More...
 
void SetHeightValue (double heightValue)
 Sets the height value
Created in NX7.5.0. More...
 
void SetInnerDiameterType (NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions innerDiameterType)
 Sets the inner diameter enum
Created in NX7.5.0. More...
 
void SetInnerDiameterValue (double innerDiameterValue)
 Sets the inner diameter value
Created in NX7.5.0. More...
 
void SetOuterDiameterType (NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions outerDiameterType)
 Sets the outer diameter enum
Created in NX7.5.0. More...
 
void SetOuterDiameterValue (double outerDiameterValue)
 Sets the outer diameter value
Created in NX7.5.0. More...
 
void SetText (const NXString &text)
 Sets the text
Created in NX7.5.0. More...
 
void SetText (const char *text)
 Sets the text
Created in NX7.5.0. More...
 
void SetTextType (NXOpen::Annotations::SearchModelViewBuilder::TextComparisionOptions textType)
 Sets the text enum
Created in NX7.5.0. More...
 
void SetWidthType (NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions widthType)
 Sets the width enum
Created in NX7.5.0. More...
 
void SetWidthValue (double widthValue)
 Sets the width value
Created in NX7.5.0. More...
 
NXString Text ()
 Returns the text
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::TextComparisionOptions TextType ()
 Returns the text enum
Created in NX7.5.0. More...
 
NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions WidthType ()
 Returns the width enum
Created in NX7.5.0. More...
 
double WidthValue ()
 Returns the width value
Created in NX7.5.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 SearchCriteriaDatumTargetBuilder
To create a new instance of this class, use NXOpen::Annotations::SearchModelViewCollection::CreateSearchCriteriaDatumTargetBuilder

Created in NX7.5.0.


Member Enumeration Documentation

Represents the search pmi movable datum target type.

Enumerator
DatumTargetMovableOptionsNo 

Datum Target.

DatumTargetMovableOptionsYes 

Movable Datum Target.

Lists the search pmi datum target type.

Enumerator
DatumTargetTypesPoint 

point type

DatumTargetTypesLine 

line type

DatumTargetTypesRectangular 

rectangular type

DatumTargetTypesCircular 

circular type

DatumTargetTypesAnnular 

annular type

DatumTargetTypesSpherical 

spherical type

DatumTargetTypesCylindrical 

cylindrical type

DatumTargetTypesArbitrary 

arbitray type

Member Function Documentation

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByDatumMovable ( )

Returns the movable datum target option
Created in NX10.0.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByDatumTargetLabel ( )

Returns the datum target label toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByDatumTargetType ( )

Returns the datum target type toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByHeight ( )

Returns the height toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByInnerDiameter ( )

Returns the inner diameter toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByOuterDiameter ( )

Returns the outer diameter toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByText ( )

Returns the text toggle
Created in NX7.5.0.



License requirements : None

bool NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::ByWidth ( )

Returns the width toggle
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetMovableOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumMovable ( )

Returns the movable datum target type
Created in NX10.0.0.



License requirements : None

NXString NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetLabelText ( )

Returns the datum target label text
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetTypes NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetType ( )

Returns the datum target type enum
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::HeightType ( )

Returns the height enum
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::HeightValue ( )

Returns the height value
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::InnerDiameterType ( )

Returns the inner diameter enum
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::InnerDiameterValue ( )

Returns the inner diameter value
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::OuterDiameterType ( )

Returns the outer diameter enum
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::OuterDiameterValue ( )

Returns the outer diameter value
Created in NX7.5.0.



License requirements : None

void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByDatumMovable ( bool  datumMovable)

Sets the movable datum target option
Created in NX10.0.0.



License requirements : None

Parameters
datumMovabledatummovable
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByDatumTargetLabel ( bool  datumTargetLabel)

Sets the datum target label toggle
Created in NX7.5.0.



License requirements : None

Parameters
datumTargetLabeldatumtargetlabel
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByDatumTargetType ( bool  datumTargetType)

Sets the datum target type toggle
Created in NX7.5.0.



License requirements : None

Parameters
datumTargetTypedatumtargettype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByHeight ( bool  height)

Sets the height toggle
Created in NX7.5.0.



License requirements : None

Parameters
heightheight
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByInnerDiameter ( bool  innerDiameter)

Sets the inner diameter toggle
Created in NX7.5.0.



License requirements : None

Parameters
innerDiameterinnerdiameter
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByOuterDiameter ( bool  outerDiameter)

Sets the outer diameter toggle
Created in NX7.5.0.



License requirements : None

Parameters
outerDiameterouterdiameter
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByText ( bool  text)

Sets the text toggle
Created in NX7.5.0.



License requirements : None

Parameters
texttext
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetByWidth ( bool  width)

Sets the width toggle
Created in NX7.5.0.



License requirements : None

Parameters
widthwidth
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetDatumMovable ( NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetMovableOptions  datumTargetMovable)

Sets the movable datum target type
Created in NX10.0.0.



License requirements : None

Parameters
datumTargetMovabledatumtargetmovable
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetDatumTargetLabelText ( const NXString datumTargetLabelText)

Sets the datum target label text
Created in NX7.5.0.



License requirements : None

Parameters
datumTargetLabelTextdatumtargetlabeltext
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetDatumTargetLabelText ( const char *  datumTargetLabelText)

Sets the datum target label text
Created in NX7.5.0.



License requirements : None

Parameters
datumTargetLabelTextdatumtargetlabeltext
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetDatumTargetType ( NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::DatumTargetTypes  datumTargetType)

Sets the datum target type enum
Created in NX7.5.0.



License requirements : None

Parameters
datumTargetTypedatumtargettype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetHeightType ( NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions  heightType)

Sets the height enum
Created in NX7.5.0.



License requirements : None

Parameters
heightTypeheighttype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetHeightValue ( double  heightValue)

Sets the height value
Created in NX7.5.0.



License requirements : None

Parameters
heightValueheightvalue
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetInnerDiameterType ( NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions  innerDiameterType)

Sets the inner diameter enum
Created in NX7.5.0.



License requirements : None

Parameters
innerDiameterTypeinnerdiametertype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetInnerDiameterValue ( double  innerDiameterValue)

Sets the inner diameter value
Created in NX7.5.0.



License requirements : None

Parameters
innerDiameterValueinnerdiametervalue
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetOuterDiameterType ( NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions  outerDiameterType)

Sets the outer diameter enum
Created in NX7.5.0.



License requirements : None

Parameters
outerDiameterTypeouterdiametertype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetOuterDiameterValue ( double  outerDiameterValue)

Sets the outer diameter value
Created in NX7.5.0.



License requirements : None

Parameters
outerDiameterValueouterdiametervalue
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetText ( const NXString text)

Sets the text
Created in NX7.5.0.



License requirements : None

Parameters
texttext
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetText ( const char *  text)

Sets the text
Created in NX7.5.0.



License requirements : None

Parameters
texttext
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetTextType ( NXOpen::Annotations::SearchModelViewBuilder::TextComparisionOptions  textType)

Sets the text enum
Created in NX7.5.0.



License requirements : None

Parameters
textTypetexttype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetWidthType ( NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions  widthType)

Sets the width enum
Created in NX7.5.0.



License requirements : None

Parameters
widthTypewidthtype
void NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::SetWidthValue ( double  widthValue)

Sets the width value
Created in NX7.5.0.



License requirements : None

Parameters
widthValuewidthvalue
NXString NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::Text ( )

Returns the text
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::TextComparisionOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::TextType ( )

Returns the text enum
Created in NX7.5.0.



License requirements : None

NXOpen::Annotations::SearchModelViewBuilder::ValueComparisionOptions NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::WidthType ( )

Returns the width enum
Created in NX7.5.0.



License requirements : None

double NXOpen::Annotations::SearchCriteriaDatumTargetBuilder::WidthValue ( )

Returns the width value
Created in NX7.5.0.



License requirements : None


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