SearchCriteriaCalloutBuilder Class¶
-
class
NXOpen.Annotations.
SearchCriteriaCalloutBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents SearchCriteriaCalloutBuilder
This is a sub-builder class and cannot be directly instantiated
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AngleType | Returns or sets the angle setting |
AngleValue | Returns or sets the angle value |
ByAngle | Returns or sets the angle toggle |
ByCalloutType | Returns or sets the callout type toggle |
ByCounterboreDepth | Returns or sets the counterboreDepth toggle |
ByCounterboreDiameter | Returns or sets the counterboreDiameter toggle |
ByCountersinkAngle | Returns or sets the countersinkAngle toggle |
ByCountersinkDiameter | Returns or sets the countersinkDiameter toggle |
ByDepth | Returns or sets the depth toggle |
ByDiameter | Returns or sets the diameter toggle |
ByPitch | Returns or sets the pitch toggle |
ByScrewSize | Returns or sets the screwSize toggle |
ByTaperAngle | Returns or sets the taperAngle toggle |
ByThreadDepth | Returns or sets the threadDepth toggle |
ByThreadSize | Returns or sets the threadSize toggle |
CalloutType | Returns or sets the callout type |
CounterboreDepthType | Returns or sets the counterboreDepth setting |
CounterboreDepthValue | Returns or sets the counterboreDepth value |
CounterboreDiameterType | Returns or sets the counterboreDiameter setting |
CounterboreDiameterValue | Returns or sets the counterboreDiameter value |
CountersinkAngleType | Returns or sets the countersinkAngle setting |
CountersinkAngleValue | Returns or sets the countersinkAngle value |
CountersinkDiameterType | Returns or sets the countersinkDiameter setting |
CountersinkDiameterValue | Returns or sets the countersinkDiameter value |
DepthType | Returns or sets the depth setting |
DepthValue | Returns or sets the depth value |
DiameterType | Returns or sets the diameter setting |
DiameterValue | Returns or sets the diameter value |
PitchType | Returns or sets the pitch setting |
PitchValue | Returns or sets the pitch value |
ScrewSizeText | Returns or sets the screwSize text |
ScrewSizeTextType | Returns or sets the ScrewSize setting |
Tag | Returns the Tag for this object. |
TaperAngleType | Returns or sets the taperAngle setting |
TaperAngleValue | Returns or sets the taperAngle value |
ThreadDepthType | Returns or sets the threadDepth setting |
ThreadDepthValue | Returns or sets the threadDepth value |
ThreadSizeText | Returns or sets the threadSize text |
ThreadSizeTextType | Returns or sets the threadSize setting |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SearchCriteriaCalloutBuilderCalloutTypes Enumeration | CalloutTypes |
Property Detail¶
AngleType¶
-
SearchCriteriaCalloutBuilder.
AngleType
¶ Returns or sets the angle setting
-------------------------------------
Getter Method
Signature
AngleType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleType
Parameters: angleType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
AngleValue¶
-
SearchCriteriaCalloutBuilder.
AngleValue
¶ Returns or sets the angle value
-------------------------------------
Getter Method
Signature
AngleValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AngleValue
Parameters: angleValue (float) – New in version NX9.0.0.
License requirements: None.
ByAngle¶
-
SearchCriteriaCalloutBuilder.
ByAngle
¶ Returns or sets the angle toggle
-------------------------------------
Getter Method
Signature
ByAngle
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByAngle
Parameters: byAngle (bool) – New in version NX9.0.0.
License requirements: None.
ByCalloutType¶
-
SearchCriteriaCalloutBuilder.
ByCalloutType
¶ Returns or sets the callout type toggle
-------------------------------------
Getter Method
Signature
ByCalloutType
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByCalloutType
Parameters: calloutType (bool) – New in version NX9.0.0.
License requirements: None.
ByCounterboreDepth¶
-
SearchCriteriaCalloutBuilder.
ByCounterboreDepth
¶ Returns or sets the counterboreDepth toggle
-------------------------------------
Getter Method
Signature
ByCounterboreDepth
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByCounterboreDepth
Parameters: byCounterboreDepth (bool) – New in version NX9.0.0.
License requirements: None.
ByCounterboreDiameter¶
-
SearchCriteriaCalloutBuilder.
ByCounterboreDiameter
¶ Returns or sets the counterboreDiameter toggle
-------------------------------------
Getter Method
Signature
ByCounterboreDiameter
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByCounterboreDiameter
Parameters: byCounterboreDiameter (bool) – New in version NX9.0.0.
License requirements: None.
ByCountersinkAngle¶
-
SearchCriteriaCalloutBuilder.
ByCountersinkAngle
¶ Returns or sets the countersinkAngle toggle
-------------------------------------
Getter Method
Signature
ByCountersinkAngle
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByCountersinkAngle
Parameters: byCountersinkAngle (bool) – New in version NX9.0.0.
License requirements: None.
ByCountersinkDiameter¶
-
SearchCriteriaCalloutBuilder.
ByCountersinkDiameter
¶ Returns or sets the countersinkDiameter toggle
-------------------------------------
Getter Method
Signature
ByCountersinkDiameter
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByCountersinkDiameter
Parameters: byCountersinkDiameter (bool) – New in version NX9.0.0.
License requirements: None.
ByDepth¶
-
SearchCriteriaCalloutBuilder.
ByDepth
¶ Returns or sets the depth toggle
-------------------------------------
Getter Method
Signature
ByDepth
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByDepth
Parameters: byDepth (bool) – New in version NX9.0.0.
License requirements: None.
ByDiameter¶
-
SearchCriteriaCalloutBuilder.
ByDiameter
¶ Returns or sets the diameter toggle
-------------------------------------
Getter Method
Signature
ByDiameter
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByDiameter
Parameters: byDiameter (bool) – New in version NX9.0.0.
License requirements: None.
ByPitch¶
-
SearchCriteriaCalloutBuilder.
ByPitch
¶ Returns or sets the pitch toggle
-------------------------------------
Getter Method
Signature
ByPitch
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByPitch
Parameters: byPitch (bool) – New in version NX9.0.0.
License requirements: None.
ByScrewSize¶
-
SearchCriteriaCalloutBuilder.
ByScrewSize
¶ Returns or sets the screwSize toggle
-------------------------------------
Getter Method
Signature
ByScrewSize
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByScrewSize
Parameters: byScrewSize (bool) – New in version NX9.0.0.
License requirements: None.
ByTaperAngle¶
-
SearchCriteriaCalloutBuilder.
ByTaperAngle
¶ Returns or sets the taperAngle toggle
-------------------------------------
Getter Method
Signature
ByTaperAngle
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByTaperAngle
Parameters: byTaperAngle (bool) – New in version NX9.0.0.
License requirements: None.
ByThreadDepth¶
-
SearchCriteriaCalloutBuilder.
ByThreadDepth
¶ Returns or sets the threadDepth toggle
-------------------------------------
Getter Method
Signature
ByThreadDepth
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByThreadDepth
Parameters: byThreadDepth (bool) – New in version NX9.0.0.
License requirements: None.
ByThreadSize¶
-
SearchCriteriaCalloutBuilder.
ByThreadSize
¶ Returns or sets the threadSize toggle
-------------------------------------
Getter Method
Signature
ByThreadSize
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ByThreadSize
Parameters: byThreadSize (bool) – New in version NX9.0.0.
License requirements: None.
CalloutType¶
-
SearchCriteriaCalloutBuilder.
CalloutType
¶ Returns or sets the callout type
-------------------------------------
Getter Method
Signature
CalloutType
Returns: Return type: NXOpen.Annotations.SearchCriteriaCalloutBuilderCalloutTypes
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalloutType
Parameters: calloutType ( NXOpen.Annotations.SearchCriteriaCalloutBuilderCalloutTypes
) –New in version NX9.0.0.
License requirements: None.
CounterboreDepthType¶
-
SearchCriteriaCalloutBuilder.
CounterboreDepthType
¶ Returns or sets the counterboreDepth setting
-------------------------------------
Getter Method
Signature
CounterboreDepthType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CounterboreDepthType
Parameters: counterboreDepthType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
CounterboreDepthValue¶
-
SearchCriteriaCalloutBuilder.
CounterboreDepthValue
¶ Returns or sets the counterboreDepth value
-------------------------------------
Getter Method
Signature
CounterboreDepthValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CounterboreDepthValue
Parameters: counterboreDepthValue (float) – New in version NX9.0.0.
License requirements: None.
CounterboreDiameterType¶
-
SearchCriteriaCalloutBuilder.
CounterboreDiameterType
¶ Returns or sets the counterboreDiameter setting
-------------------------------------
Getter Method
Signature
CounterboreDiameterType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CounterboreDiameterType
Parameters: counterboreDiameterType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
CounterboreDiameterValue¶
-
SearchCriteriaCalloutBuilder.
CounterboreDiameterValue
¶ Returns or sets the counterboreDiameter value
-------------------------------------
Getter Method
Signature
CounterboreDiameterValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CounterboreDiameterValue
Parameters: counterboreDiameterValue (float) – New in version NX9.0.0.
License requirements: None.
CountersinkAngleType¶
-
SearchCriteriaCalloutBuilder.
CountersinkAngleType
¶ Returns or sets the countersinkAngle setting
-------------------------------------
Getter Method
Signature
CountersinkAngleType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CountersinkAngleType
Parameters: countersinkAngleType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
CountersinkAngleValue¶
-
SearchCriteriaCalloutBuilder.
CountersinkAngleValue
¶ Returns or sets the countersinkAngle value
-------------------------------------
Getter Method
Signature
CountersinkAngleValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CountersinkAngleValue
Parameters: countersinkAngleValue (float) – New in version NX9.0.0.
License requirements: None.
CountersinkDiameterType¶
-
SearchCriteriaCalloutBuilder.
CountersinkDiameterType
¶ Returns or sets the countersinkDiameter setting
-------------------------------------
Getter Method
Signature
CountersinkDiameterType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CountersinkDiameterType
Parameters: countersinkDiameterType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
CountersinkDiameterValue¶
-
SearchCriteriaCalloutBuilder.
CountersinkDiameterValue
¶ Returns or sets the countersinkDiameter value
-------------------------------------
Getter Method
Signature
CountersinkDiameterValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CountersinkDiameterValue
Parameters: countersinkDiameterValue (float) – New in version NX9.0.0.
License requirements: None.
DepthType¶
-
SearchCriteriaCalloutBuilder.
DepthType
¶ Returns or sets the depth setting
-------------------------------------
Getter Method
Signature
DepthType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DepthType
Parameters: depthType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
DepthValue¶
-
SearchCriteriaCalloutBuilder.
DepthValue
¶ Returns or sets the depth value
-------------------------------------
Getter Method
Signature
DepthValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DepthValue
Parameters: depthValue (float) – New in version NX9.0.0.
License requirements: None.
DiameterType¶
-
SearchCriteriaCalloutBuilder.
DiameterType
¶ Returns or sets the diameter setting
-------------------------------------
Getter Method
Signature
DiameterType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DiameterType
Parameters: diameterType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
DiameterValue¶
-
SearchCriteriaCalloutBuilder.
DiameterValue
¶ Returns or sets the diameter value
-------------------------------------
Getter Method
Signature
DiameterValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DiameterValue
Parameters: diameterValue (float) – New in version NX9.0.0.
License requirements: None.
PitchType¶
-
SearchCriteriaCalloutBuilder.
PitchType
¶ Returns or sets the pitch setting
-------------------------------------
Getter Method
Signature
PitchType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PitchType
Parameters: pitchType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
PitchValue¶
-
SearchCriteriaCalloutBuilder.
PitchValue
¶ Returns or sets the pitch value
-------------------------------------
Getter Method
Signature
PitchValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PitchValue
Parameters: pitchValue (float) – New in version NX9.0.0.
License requirements: None.
ScrewSizeText¶
-
SearchCriteriaCalloutBuilder.
ScrewSizeText
¶ Returns or sets the screwSize text
-------------------------------------
Getter Method
Signature
ScrewSizeText
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScrewSizeText
Parameters: screwSizeText (str) – New in version NX9.0.0.
License requirements: None.
ScrewSizeTextType¶
-
SearchCriteriaCalloutBuilder.
ScrewSizeTextType
¶ Returns or sets the ScrewSize setting
-------------------------------------
Getter Method
Signature
ScrewSizeTextType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ScrewSizeTextType
Parameters: screwSizeTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
TaperAngleType¶
-
SearchCriteriaCalloutBuilder.
TaperAngleType
¶ Returns or sets the taperAngle setting
-------------------------------------
Getter Method
Signature
TaperAngleType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TaperAngleType
Parameters: taperAngleType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
TaperAngleValue¶
-
SearchCriteriaCalloutBuilder.
TaperAngleValue
¶ Returns or sets the taperAngle value
-------------------------------------
Getter Method
Signature
TaperAngleValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TaperAngleValue
Parameters: taperAngleValue (float) – New in version NX9.0.0.
License requirements: None.
ThreadDepthType¶
-
SearchCriteriaCalloutBuilder.
ThreadDepthType
¶ Returns or sets the threadDepth setting
-------------------------------------
Getter Method
Signature
ThreadDepthType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreadDepthType
Parameters: threadDepthType ( NXOpen.Annotations.SearchModelViewBuilderValueComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
ThreadDepthValue¶
-
SearchCriteriaCalloutBuilder.
ThreadDepthValue
¶ Returns or sets the threadDepth value
-------------------------------------
Getter Method
Signature
ThreadDepthValue
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreadDepthValue
Parameters: threadDepthValue (float) – New in version NX9.0.0.
License requirements: None.
ThreadSizeText¶
-
SearchCriteriaCalloutBuilder.
ThreadSizeText
¶ Returns or sets the threadSize text
-------------------------------------
Getter Method
Signature
ThreadSizeText
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreadSizeText
Parameters: threadSizeText (str) – New in version NX9.0.0.
License requirements: None.
ThreadSizeTextType¶
-
SearchCriteriaCalloutBuilder.
ThreadSizeTextType
¶ Returns or sets the threadSize setting
-------------------------------------
Getter Method
Signature
ThreadSizeTextType
Returns: Return type: NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ThreadSizeTextType
Parameters: threadSizeTextType ( NXOpen.Annotations.SearchModelViewBuilderTextComparisionOptions
) –New in version NX9.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
SearchCriteriaCalloutBuilder.
Validate
¶ Validate whether the inputs to the component are sufficient for commit to be called.
If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.