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

Inheritance diagram for NXOpen::Annotations::HoleCalloutSettingsBuilder:

Public Types
enum	Featuretype { FeaturetypeGeneralHole, FeaturetypeDrillSizeHole, FeaturetypeScrewClearanceHole, FeaturetypeThreadedHole, FeaturetypeSymbolicThread, FeaturetypeNone }
	This reprensent the option that indicates a type of hole features. More...

enum	LeaderAttachment { LeaderAttachmentTop, LeaderAttachmentBelowBottomExtendedToMaximum, LeaderAttachmentBelowTopExtendedToMaximum }
	This reprensent the option that indicates the position for the leader to attach to. More...

enum	Parametertype { ParametertypeDiameter, ParametertypeDepth, ParametertypeCounterBoreDiameter, ParametertypeCounterBoreDepth, ParametertypeCounterSinkDiameter, ParametertypeCounterSinkAngle, ParametertypeTaperAngle, ParametertypePatternFeatureCount, ParametertypeScrewSize, ParametertypeFit, ParametertypeLineBreak, ParametertypeThreadSize, ParametertypeThreadDepth, ParametertypePitch, ParametertypeAngle, ParametertypeMinorDiameter, ParametertypeMajorDiameter, ParametertypeTapDrillDiameter, ParametertypeCallout, ParametertypeLength, ParametertypeShaftSize, ParametertypeNone }
	This reprensent the option that indicates a type of hole feature parameters. More...

Public Member Functions
void	DeleteLineBreak (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type is a line break and it can be deleted, deletes it. More...

NXOpen::Annotations::HoleCalloutSettingsBuilder::LeaderAttachment	GetLeaderAttachment ()
	Gets the leader attachment, which decides where the leader is attached to the call out. More...

double	GetLineSpaceFactor ()
	Gets the line space factor, which defines the vertical space between parameters. More...

std::vector < NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype >	GetListOfFeatures ()
	Gets the list of features. More...

std::vector < NXOpen::Annotations::HoleCalloutSettingsBuilder::Parametertype >	GetListOfParameters (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType)
	Gets the list of parameters for feature type. More...

bool	GetNthParameterDisplay (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	Gets the display status of the nth hole feature parameter of feature type. More...

std::vector< NXString >	GetNthParameterPrefix (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type can have prefix, gets its prefix. More...

NXOpen::Annotations::StyleBuilder *	GetNthParameterStyle (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	Gets the parameter style of the nth hole feature parameter of feature type. More...

std::vector< NXString >	GetNthParameterSuffix (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If the nth hole feature parameter of feature type can have suffix, gets its suffix. More...

NXString	GetNthParameterValue (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	Gets the parameter expression of the nth hole feature parameter of feature type. More...

NXString	GetNthParameterValueString (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	Gets the parameter string representation of the nth hole feature parameter of feature type. More...

double	GetParameterSpaceFactor ()
	Gets the parameter space factor, which defines the horizontal space between parameters. More...

NXString	GetThroughHoleTextOfType (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType)
	Get Through Hole Text String. More...

void	InsertLineBreak (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If a line break can be inserted immediately after the nth hole feature parameter of feature type, inserts a line break at that position. More...

bool	ReorderParameters (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, const std::vector< NXOpen::Annotations::HoleCalloutSettingsBuilder::Parametertype > &parameters)
	Reorder the parameters based on the input. More...

void	ResetFromFeature (NXOpen::Features::Feature feature, NXOpen::Assemblies::Component partOccurrence, NXOpen::View *view, const NXOpen::Point3d &pickPoint)
	Reset the builder data based on a feature if the feature is a hole feature. More...

void	SetLeaderAttachment (NXOpen::Annotations::HoleCalloutSettingsBuilder::LeaderAttachment leaderAttachment)
	Sets the leader attachment, which decides where the leader is attached to the call out. More...

void	SetLineSpaceFactor (double lineSpaceFactor)
	Sets the line space factor, which defines the vertical space between parameters. More...

void	SetNthParameterDisplay (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth, bool parameterDisplay)
	Sets the display status of the nth hole feature parameter of feature type. More...

void	SetNthParameterPrefix (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth, std::vector< NXString > &lines)
	If the prefix of the nth hole feature parameter of feature type can be edited, sets its prefix. More...

void	SetNthParameterSuffix (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth, std::vector< NXString > &lines)
	If the suffix of the nth hole feature parameter of feature type can be edited, sets its suffix. More...

void	SetNthParameterValue (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth, const NXString &value)
	Sets the parameter expression of the nth hole feature parameter of feature type. More...

void	SetNthParameterValue (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth, const char *value)
	Sets the parameter expression of the nth hole feature parameter of feature type. More...

void	SetParameterSpaceFactor (double parameterSpaceFactor)
	Sets the parameter space factor, which defines the horizontal space between parameters. More...

void	SetThroughHoleTextOfType (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, const NXString &throughHoleTextString)
	Set Through Hole Text String. More...

void	SetThroughHoleTextOfType (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, const char *throughHoleTextString)
	Set Through Hole Text String. More...

void	ShiftDown (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If the position of the nth hole feature parameter of feature type can be shifted down, shifts it down by one. More...

void	ShiftUp (NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType, int nth)
	If the position of the nth hole feature parameter of feature type can be shifted up, shifts it up by one. 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 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::HoleCalloutSettingsBuilder::Featuretype . 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

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype

This reprensent the option that indicates a type of hole features.

Enumerator
FeaturetypeGeneralHole	general hole
FeaturetypeDrillSizeHole	drill size hole
FeaturetypeScrewClearanceHole	screw clearance hole
FeaturetypeThreadedHole	threaded hole
FeaturetypeSymbolicThread	symbolic thread
FeaturetypeNone	none

enum NXOpen::Annotations::HoleCalloutSettingsBuilder::LeaderAttachment

This reprensent the option that indicates the position for the leader to attach to.

Enumerator
LeaderAttachmentTop	top
LeaderAttachmentBelowBottomExtendedToMaximum	below bottom extended to maximum
LeaderAttachmentBelowTopExtendedToMaximum	below top extended to maximum

enum NXOpen::Annotations::HoleCalloutSettingsBuilder::Parametertype

This reprensent the option that indicates a type of hole feature parameters.

Enumerator
ParametertypeDiameter	diameter
ParametertypeDepth	depth
ParametertypeCounterBoreDiameter	counter bore diameter
ParametertypeCounterBoreDepth	counter bore depth
ParametertypeCounterSinkDiameter	counter sink diameter
ParametertypeCounterSinkAngle	counter sink angle
ParametertypeTaperAngle	taper angle
ParametertypePatternFeatureCount	pattern feature count
ParametertypeScrewSize	screw size
ParametertypeFit	fit
ParametertypeLineBreak	line break
ParametertypeThreadSize	thread size
ParametertypeThreadDepth	thread depth
ParametertypePitch	pitch
ParametertypeAngle	angle
ParametertypeMinorDiameter	minor diameter
ParametertypeMajorDiameter	major diameter
ParametertypeTapDrillDiameter	tap drill diameter
ParametertypeCallout	callout
ParametertypeLength	length
ParametertypeShaftSize	shaft size
ParametertypeNone	none

Member Function Documentation

void NXOpen::Annotations::HoleCalloutSettingsBuilder::DeleteLineBreak	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , for instance, use the API: NXOpen::Annotations::HoleCalloutSettingsBuilder::DeleteLineBreak (NXOpen::Annotations::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , 1)
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth

NXOpen::Annotations::HoleCalloutSettingsBuilder::LeaderAttachment NXOpen::Annotations::HoleCalloutSettingsBuilder::GetLeaderAttachment ( )

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

Returns: Created in NX9.0.0.

License requirements : None

double NXOpen::Annotations::HoleCalloutSettingsBuilder::GetLineSpaceFactor ( )

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

Returns: Created in NX9.0.0.

License requirements : None

std::vector<NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype> NXOpen::Annotations::HoleCalloutSettingsBuilder::GetListOfFeatures ( )

Gets the list of features.

Returns: Created in NX9.0.0.

License requirements : None

std::vector<NXOpen::Annotations::HoleCalloutSettingsBuilder::Parametertype> NXOpen::Annotations::HoleCalloutSettingsBuilder::GetListOfParameters ( NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType )

Gets the list of parameters for feature type.

Returns: Created in NX9.0.0.

License requirements : None

Parameters

featureType featuretype

bool NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterDisplay	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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

Returns: Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth

std::vector<NXString> NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterPrefix	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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

Returns: List of lines
Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth

NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterStyle	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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

Returns: Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth

std::vector<NXString> NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterSuffix	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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

Returns: List of lines
Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth

NXString NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterValue	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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

Returns: Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth

NXString NXOpen::Annotations::HoleCalloutSettingsBuilder::GetNthParameterValueString	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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.

Returns: Created in NX11.0.1.

License requirements : None

Parameters

featureType	featuretype
nth	nth

double NXOpen::Annotations::HoleCalloutSettingsBuilder::GetParameterSpaceFactor ( )

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

Returns: Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::HoleCalloutSettingsBuilder::GetThroughHoleTextOfType ( NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype featureType )

Get Through Hole Text String.

Returns: Created in NX12.0.0.

License requirements : None

Parameters

featureType featuretype

void NXOpen::Annotations::HoleCalloutSettingsBuilder::InsertLineBreak	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , for instance, use the API: NXOpen::Annotations::HoleCalloutSettingsBuilder::InsertLineBreak (NXOpen::Annotations::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , 3)
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth

bool NXOpen::Annotations::HoleCalloutSettingsBuilder::ReorderParameters	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		const std::vector< NXOpen::Annotations::HoleCalloutSettingsBuilder::Parametertype > &	parameters
	)

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.

Returns: Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
parameters	parameters

void NXOpen::Annotations::HoleCalloutSettingsBuilder::ResetFromFeature	(	NXOpen::Features::Feature *	feature,
		NXOpen::Assemblies::Component *	partOccurrence,
		NXOpen::View *	view,
		const NXOpen::Point3d &	pickPoint
	)

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

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

feature	feature
partOccurrence	partoccurrence
view	view
pickPoint	selected object point

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetLeaderAttachment ( NXOpen::Annotations::HoleCalloutSettingsBuilder::LeaderAttachment leaderAttachment )

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

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

leaderAttachment leaderattachment

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetLineSpaceFactor ( double lineSpaceFactor )

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

The line space factor cannot be less than zero.
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

lineSpaceFactor linespacefactor

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetNthParameterDisplay	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth,
		bool	parameterDisplay
	)

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

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth
parameterDisplay	parameterdisplay

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetNthParameterPrefix	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth,
		std::vector< NXString > &	lines
	)

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

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth
lines	List of new lines

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetNthParameterSuffix	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth,
		std::vector< NXString > &	lines
	)

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

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth
lines	List of new lines

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetNthParameterValue	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth,
		const NXString &	value
	)

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

Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth
value	value

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetNthParameterValue	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth,
		const char *	value
	)

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

Created in NX9.0.0.

License requirements : None

Parameters

featureType	featuretype
nth	nth
value	value

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetParameterSpaceFactor ( double parameterSpaceFactor )

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

The parameter space factor cannot be less than zero.
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

parameterSpaceFactor parameterspacefactor

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetThroughHoleTextOfType	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		const NXString &	throughHoleTextString
	)

Set Through Hole Text String.

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
throughHoleTextString	throughholetextstring

void NXOpen::Annotations::HoleCalloutSettingsBuilder::SetThroughHoleTextOfType	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		const char *	throughHoleTextString
	)

Set Through Hole Text String.

Created in NX12.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
throughHoleTextString	throughholetextstring

void NXOpen::Annotations::HoleCalloutSettingsBuilder::ShiftDown	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , for instance, use the API: NXOpen::Annotations::HoleCalloutSettingsBuilder::ShiftDown (NXOpen::Annotations::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , 0)
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth

void NXOpen::Annotations::HoleCalloutSettingsBuilder::ShiftUp	(	NXOpen::Annotations::HoleCalloutSettingsBuilder::Featuretype	featureType,
		int	nth
	)

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::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , for instance, use the API: NXOpen::Annotations::HoleCalloutSettingsBuilder::ShiftUp (NXOpen::Annotations::HoleCalloutSettingsBuilder::FeaturetypeGeneralHole , 2)
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

featureType	featuretype
nth	nth

virtual bool NXOpen::Annotations::HoleCalloutSettingsBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

The documentation for this class was generated from the following file:

Annotations_HoleCalloutSettingsBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation