NXOpen::Annotations::DatumReferenceBuilder Class Reference

Represents a Annotations::DatumReferenceBuilder
To create a new instance of this class, use Annotations::AnnotationManager::CreateEmptyDatumReferenceBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Annotations::DatumReferenceBuilder:

Public Types
enum	DatumReferenceMaterialCondition { DatumReferenceMaterialConditionNone, DatumReferenceMaterialConditionLeastMaterialCondition, DatumReferenceMaterialConditionMaximumMaterialCondition, DatumReferenceMaterialConditionRegardlessOfFeatureSize }
	Specifies the material modifier condition for the datum reference. More...

Public Member Functions
bool	FreeState ()
	Returns the datum reference free state Created in NX6.0.0.
NXString	Letter ()
	Returns the datum reference datum letter Created in NX6.0.0.
NXOpen::Annotations::DatumReferenceBuilder::DatumReferenceMaterialCondition	MaterialCondition ()
	Returns the datum reference material condition Created in NX6.0.0.
void	SetFreeState (bool datumReferenceFreeState)
	Sets the datum reference free state Created in NX6.0.0.
void	SetLetter (const NXString &datumReferenceDatum)
	Sets the datum reference datum letter Created in NX6.0.0.
void	SetLetter (const char *datumReferenceDatum)
	Sets the datum reference datum letter Created in NX6.0.0.
void	SetMaterialCondition (NXOpen::Annotations::DatumReferenceBuilder::DatumReferenceMaterialCondition materialCondition)
	Sets the datum reference material condition Created in NX6.0.0.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Annotations::DatumReferenceBuilder
To create a new instance of this class, use Annotations::AnnotationManager::CreateEmptyDatumReferenceBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::DatumReferenceBuilder::DatumReferenceMaterialCondition

Specifies the material modifier condition for the datum reference.

Enumerator:

DatumReferenceMaterialConditionNone	none
DatumReferenceMaterialConditionLeastMaterialCondition	least material condition
DatumReferenceMaterialConditionMaximumMaterialCondition	maximum material condition
DatumReferenceMaterialConditionRegardlessOfFeatureSize	regardless of size

Member Function Documentation

bool NXOpen::Annotations::DatumReferenceBuilder::FreeState

(

)

Returns the datum reference free state
Created in NX6.0.0.

License requirements : None

NXString NXOpen::Annotations::DatumReferenceBuilder::Letter

(

)

Returns the datum reference datum letter
Created in NX6.0.0.

License requirements : None

NXOpen::Annotations::DatumReferenceBuilder::DatumReferenceMaterialCondition NXOpen::Annotations::DatumReferenceBuilder::MaterialCondition

(

)

Returns the datum reference material condition
Created in NX6.0.0.

License requirements : None

void NXOpen::Annotations::DatumReferenceBuilder::SetFreeState

(

bool

datumReferenceFreeState

)

Sets the datum reference free state
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

datumReferenceFreeState

datumreferencefreestate

void NXOpen::Annotations::DatumReferenceBuilder::SetLetter

(

const NXString &

datumReferenceDatum

)

Sets the datum reference datum letter
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

datumReferenceDatum

datumreferencedatum

void NXOpen::Annotations::DatumReferenceBuilder::SetLetter

(

const char *

datumReferenceDatum

)

Sets the datum reference datum letter
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

datumReferenceDatum

datumreferencedatum

void NXOpen::Annotations::DatumReferenceBuilder::SetMaterialCondition

(

NXOpen::Annotations::DatumReferenceBuilder::DatumReferenceMaterialCondition

materialCondition

)

Sets the datum reference material condition
Created in NX6.0.0.

License requirements : drafting ("DRAFTING") OR geometric_tol ("GDT")

Parameters

materialCondition

materialcondition

virtual bool NXOpen::Annotations::DatumReferenceBuilder::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_DatumReferenceBuilder.hxx