HoleCalloutSettingsBuilder Class

class NXOpen.Annotations.HoleCalloutSettingsBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Annotations.HoleCalloutSettingsBuilder, this builder contains list(s) of parameter(s) for feature(s).

Each feature is categorized under a feature type, indicated by NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype. For each feature, parameter(s) are arranged in an array, with a starting index of zero. This is a sub-builder class and cannot be directly instantiated

New in version NX9.0.0.

Properties

Property Description
Tag Returns the Tag for this object.

Methods

Method Description
DeleteLineBreak If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it.
GetLeaderAttachment Gets the leader attachment, which decides where the leader is attached to the call out.
GetLineSpaceFactor Gets the line space factor, which defines the vertical space between parameters.
GetListOfFeatures Gets the list of features.
GetListOfParameters Gets the list of parameters for feature type.
GetNthParameterDisplay Gets the display status of the nth hole feature parameter of feature type.
GetNthParameterPrefix If the nth hole feature parameter of feature type can have prefix, gets its prefix.
GetNthParameterStyle Gets the parameter style of the nth hole feature parameter of feature type.
GetNthParameterSuffix If the nth hole feature parameter of feature type can have suffix, gets its suffix.
GetNthParameterValue Gets the parameter expression of the nth hole feature parameter of feature type.
GetNthParameterValueString Gets the parameter string representation of the nth hole feature parameter of feature type.
GetParameterSpaceFactor Gets the parameter space factor, which defines the horizontal space between parameters.
GetThroughHoleTextOfType Get Through Hole Text String.
InsertLineBreak If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position.
ReorderParameters Reorder the parameters based on the input.
ResetFromFeature Reset the builder data based on a feature if the feature is a hole feature.
SetLeaderAttachment Sets the leader attachment, which decides where the leader is attached to the call out.
SetLineSpaceFactor Sets the line space factor, which defines the vertical space between parameters.
SetNthParameterDisplay Sets the display status of the nth hole feature parameter of feature type.
SetNthParameterPrefix If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix.
SetNthParameterSuffix If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix.
SetNthParameterValue Sets the parameter expression of the nth hole feature parameter of feature type.
SetParameterSpaceFactor Sets the parameter space factor, which defines the horizontal space between parameters.
SetThroughHoleTextOfType Set Through Hole Text String.
ShiftDown If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one.
ShiftUp If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

HoleCalloutSettingsBuilderFeaturetype Enumeration This reprensent the option that indicates a type of hole features.
HoleCalloutSettingsBuilderLeaderAttachment Enumeration This reprensent the option that indicates the position for the leader to attach to.
HoleCalloutSettingsBuilderParametertype Enumeration This reprensent the option that indicates a type of hole feature parameters.

Method Detail

DeleteLineBreak

HoleCalloutSettingsBuilder.DeleteLineBreak

If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it.

To delete the second parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.DeleteLineBreak`(:py:class:`NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, 1)

Signature DeleteLineBreak(featureType, nth)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

GetLeaderAttachment

HoleCalloutSettingsBuilder.GetLeaderAttachment

Gets the leader attachment, which decides where the leader is attached to the call out.

Signature GetLeaderAttachment()

Returns:
Return type:NXOpen.Annotations.HoleCalloutSettingsBuilderLeaderAttachment

New in version NX9.0.0.

License requirements: None.

GetLineSpaceFactor

HoleCalloutSettingsBuilder.GetLineSpaceFactor

Gets the line space factor, which defines the vertical space between parameters.

Signature GetLineSpaceFactor()

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

GetListOfFeatures

HoleCalloutSettingsBuilder.GetListOfFeatures

Gets the list of features.

Signature GetListOfFeatures()

Returns:
Return type:list of NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype

New in version NX9.0.0.

License requirements: None.

GetListOfParameters

HoleCalloutSettingsBuilder.GetListOfParameters

Gets the list of parameters for feature type.

Signature GetListOfParameters(featureType)

Parameters:featureType (NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype) –
Returns:
Return type:list of NXOpen.Annotations.HoleCalloutSettingsBuilderParametertype

New in version NX9.0.0.

License requirements: None.

GetNthParameterDisplay

HoleCalloutSettingsBuilder.GetNthParameterDisplay

Gets the display status of the nth hole feature parameter of feature type.

Signature GetNthParameterDisplay(featureType, nth)

Parameters:
Returns:
Return type:

bool

New in version NX9.0.0.

License requirements: None.

GetNthParameterPrefix

HoleCalloutSettingsBuilder.GetNthParameterPrefix

If the nth hole feature parameter of feature type can have prefix, gets its prefix.

Signature GetNthParameterPrefix(featureType, nth)

Parameters:
Returns:

List of lines
Return type:

list of str

New in version NX9.0.0.

License requirements: None.

GetNthParameterStyle

HoleCalloutSettingsBuilder.GetNthParameterStyle

Gets the parameter style of the nth hole feature parameter of feature type.

Signature GetNthParameterStyle(featureType, nth)

Parameters:
Returns:
Return type:

NXOpen.Annotations.StyleBuilder

New in version NX9.0.0.

License requirements: None.

GetNthParameterSuffix

HoleCalloutSettingsBuilder.GetNthParameterSuffix

If the nth hole feature parameter of feature type can have suffix, gets its suffix.

Signature GetNthParameterSuffix(featureType, nth)

Parameters:
Returns:

List of lines
Return type:

list of str

New in version NX9.0.0.

License requirements: None.

GetNthParameterValue

HoleCalloutSettingsBuilder.GetNthParameterValue

Gets the parameter expression of the nth hole feature parameter of feature type.

Signature GetNthParameterValue(featureType, nth)

Parameters:
Returns:
Return type:

str

New in version NX9.0.0.

License requirements: None.

GetNthParameterValueString

HoleCalloutSettingsBuilder.GetNthParameterValueString

Gets the parameter string representation of the nth hole feature parameter of feature type.

Differs from NXOpen.Annotations.HoleCalloutSettingsBuilder.GetNthParameterValue() in that certain parameters which do not have a parameter value still have a string representation. This API will return that string representation instead of an empty string.

Signature GetNthParameterValueString(featureType, nth)

Parameters:
Returns:
Return type:

str

New in version NX11.0.1.

License requirements: None.

GetParameterSpaceFactor

HoleCalloutSettingsBuilder.GetParameterSpaceFactor

Gets the parameter space factor, which defines the horizontal space between parameters.

Signature GetParameterSpaceFactor()

Returns:
Return type:float

New in version NX9.0.0.

License requirements: None.

GetThroughHoleTextOfType

HoleCalloutSettingsBuilder.GetThroughHoleTextOfType

Get Through Hole Text String.

Signature GetThroughHoleTextOfType(featureType)

Parameters:featureType (NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype) –
Returns:
Return type:str

New in version NX12.0.0.

License requirements: None.

InsertLineBreak

HoleCalloutSettingsBuilder.InsertLineBreak

If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position.

To insert a line break after the fourth parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.InsertLineBreak`(:py:class:`NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, 3)

Signature InsertLineBreak(featureType, nth)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

ReorderParameters

HoleCalloutSettingsBuilder.ReorderParameters

Reorder the parameters based on the input.

This function only works if all input parameters exist in the builder and all builder parameters exist in the input.

Signature ReorderParameters(featureType, parameters)

Parameters:
Returns:
Return type:

bool

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

ResetFromFeature

HoleCalloutSettingsBuilder.ResetFromFeature

Reset the builder data based on a feature if the feature is a hole feature.

Signature ResetFromFeature(feature, partOccurrence, view, pickPoint)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetLeaderAttachment

HoleCalloutSettingsBuilder.SetLeaderAttachment

Sets the leader attachment, which decides where the leader is attached to the call out.

Signature SetLeaderAttachment(leaderAttachment)

Parameters:leaderAttachment (NXOpen.Annotations.HoleCalloutSettingsBuilderLeaderAttachment) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetLineSpaceFactor

HoleCalloutSettingsBuilder.SetLineSpaceFactor

Sets the line space factor, which defines the vertical space between parameters.

The line space factor cannot be less than zero.

Signature SetLineSpaceFactor(lineSpaceFactor)

Parameters:lineSpaceFactor (float) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetNthParameterDisplay

HoleCalloutSettingsBuilder.SetNthParameterDisplay

Sets the display status of the nth hole feature parameter of feature type.

Signature SetNthParameterDisplay(featureType, nth, parameterDisplay)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetNthParameterPrefix

HoleCalloutSettingsBuilder.SetNthParameterPrefix

If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix.

Signature SetNthParameterPrefix(featureType, nth, lines)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetNthParameterSuffix

HoleCalloutSettingsBuilder.SetNthParameterSuffix

If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix.

Signature SetNthParameterSuffix(featureType, nth, lines)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetNthParameterValue

HoleCalloutSettingsBuilder.SetNthParameterValue

Sets the parameter expression of the nth hole feature parameter of feature type.

Signature SetNthParameterValue(featureType, nth, value)

Parameters:

New in version NX9.0.0.

License requirements: None.

SetParameterSpaceFactor

HoleCalloutSettingsBuilder.SetParameterSpaceFactor

Sets the parameter space factor, which defines the horizontal space between parameters.

The parameter space factor cannot be less than zero.

Signature SetParameterSpaceFactor(parameterSpaceFactor)

Parameters:parameterSpaceFactor (float) –

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

SetThroughHoleTextOfType

HoleCalloutSettingsBuilder.SetThroughHoleTextOfType

Set Through Hole Text String.

Signature SetThroughHoleTextOfType(featureType, throughHoleTextString)

Parameters:

New in version NX12.0.0.

License requirements: drafting (“DRAFTING”)

ShiftDown

HoleCalloutSettingsBuilder.ShiftDown

If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one.

To shift down the first parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftDown`(:py:class:`NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, 0)

Signature ShiftDown(featureType, nth)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

ShiftUp

HoleCalloutSettingsBuilder.ShiftUp

If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one.

To shift up the third parameter of feature type NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, for instance, use the API: NXOpen.Annotations.HoleCalloutSettingsBuilder.ShiftUp`(:py:class:`NXOpen.Annotations.HoleCalloutSettingsBuilderFeaturetype.GeneralHole, 2)

Signature ShiftUp(featureType, nth)

Parameters:

New in version NX9.0.0.

License requirements: drafting (“DRAFTING”)

Validate

HoleCalloutSettingsBuilder.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.