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

Represents a Datum target Builder
This is an abstract class, and cannot be instantiated. More...

Inheritance diagram for NXOpen::Annotations::DatumTargetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder NXOpen::Annotations::DraftingDatumTargetBuilder NXOpen::Annotations::PmiDatumTargetBuilder

Public Types

enum  StandardTypes {
  StandardTypesNoStandard, StandardTypesAsmeY145m1982, StandardTypesAsmeY145m1994, StandardTypesAsmeIso11011983,
  StandardTypesGmAddendum94, StandardTypesAsig2000, StandardTypesAsmeY1452009
}
 represents the datum target standards More...
 
enum  TerminatorTypes { TerminatorTypesArrow, TerminatorTypesX, TerminatorTypesPlus }
 represents the datum target terminator type More...
 
enum  Types {
  TypesPoint, TypesLine, TypesRectangular, TypesCircular,
  TypesAnnular, TypesSpherical, TypesCylindrical, TypesArbitrary
}
 datum symbol type More...
 

Public Member Functions

NXString AreaSize ()
 Returns the area size
Created in NX6.0.0. More...
 
NXOpen::Annotations::DatumTargetBuilder::StandardTypes DatumTargetStandard ()
 Returns the datum target standard. More...
 
bool DrawX ()
 Returns the draw x
More...
 
NXOpen::ExpressionHeight ()
 Returns the height
Created in NX6.0.0. More...
 
int Index ()
 Returns the index
Created in NX6.0.0. More...
 
void InheritFrom (NXOpen::Annotations::BaseDatumTarget *inheritTag)
 The datum target is inherited form existing datum target. More...
 
NXOpen::ExpressionInnerDiameter ()
 Returns the inner diameter
Created in NX6.0.0. More...
 
NXString Label ()
 Returns the label
Created in NX6.0.0. More...
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0. More...
 
bool Movable ()
 Returns the flag that indicates movable .If true then movable. More...
 
NXOpen::ExpressionMovableModifierAngle ()
 Returns the movable modifier angle
Created in NX10.0.0. More...
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX6.0.0. More...
 
NXOpen::ExpressionOuterDiameter ()
 Returns the outer diameter
Created in NX6.0.0. More...
 
void ReverseMovableModifier ()
 Reverses the Movable datum target direction by 180 degree
Created in NX10.0.0. More...
 
void SetAreaSize (const NXString &areaSize)
 Sets the area size
Created in NX6.0.0. More...
 
void SetAreaSize (const char *areaSize)
 Sets the area size
Created in NX6.0.0. More...
 
void SetDatumTargetStandard (NXOpen::Annotations::DatumTargetBuilder::StandardTypes standard)
 Sets the datum target standard. More...
 
void SetDrawX (bool flag)
 Sets the draw x
More...
 
void SetIndex (int index)
 Sets the index
Created in NX6.0.0. More...
 
void SetLabel (const NXString &label)
 Sets the label
Created in NX6.0.0. More...
 
void SetLabel (const char *label)
 Sets the label
Created in NX6.0.0. More...
 
void SetMovable (bool flag)
 Sets the flag that indicates movable .If true then movable. More...
 
void SetTerminatorType (NXOpen::Annotations::DatumTargetBuilder::TerminatorTypes type)
 Sets the terminator type
Created in NX10.0.0. More...
 
void SetType (NXOpen::Annotations::DatumTargetBuilder::Types type)
 Sets the type
Created in NX6.0.0. More...
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX6.0.0. More...
 
NXOpen::Annotations::DatumTargetBuilder::TerminatorTypes TerminatorType ()
 Returns the terminator type
Created in NX10.0.0. More...
 
NXOpen::Annotations::DatumTargetBuilder::Types Type ()
 Returns the type
Created in NX6.0.0. More...
 
NXOpen::ExpressionWidth ()
 Returns the width
Created in NX6.0.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 a Datum target Builder
This is an abstract class, and cannot be instantiated.



Created in NX6.0.0.

Member Enumeration Documentation

represents the datum target standards

Enumerator
StandardTypesNoStandard 

NO_STANDARD.

StandardTypesAsmeY145m1982 

ASME_Y145M_1982.

StandardTypesAsmeY145m1994 

Y145M_1994.

StandardTypesAsmeIso11011983 

ISO 1101 1983.

StandardTypesGmAddendum94 

94_GM_ADDENDUM

StandardTypesAsig2000 

ASIG_2000.

StandardTypesAsmeY1452009 

ASME_Y145_2009.

represents the datum target terminator type

Enumerator
TerminatorTypesArrow 

terminated with Arrow only

TerminatorTypesX 

terminated with x

TerminatorTypesPlus 

terminated with plus

datum symbol type

Enumerator
TypesPoint 

point

TypesLine 

point

TypesRectangular 

rectangular

TypesCircular 

circular

TypesAnnular 

annular

TypesSpherical 

spherical

TypesCylindrical 

cylindrical

TypesArbitrary 

arbitrary

Member Function Documentation

NXString NXOpen::Annotations::DatumTargetBuilder::AreaSize ( )

Returns the area size
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DatumTargetBuilder::StandardTypes NXOpen::Annotations::DatumTargetBuilder::DatumTargetStandard ( )

Returns the datum target standard.


Created in NX10.0.0.

License requirements : None

bool NXOpen::Annotations::DatumTargetBuilder::DrawX ( )

Returns the draw x

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Annotations::DatumTargetBuilder::TerminatorType instead.


Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Annotations::DatumTargetBuilder::Height ( )

Returns the height
Created in NX6.0.0.



License requirements : None

int NXOpen::Annotations::DatumTargetBuilder::Index ( )

Returns the index
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::DatumTargetBuilder::InheritFrom ( NXOpen::Annotations::BaseDatumTarget inheritTag)

The datum target is inherited form existing datum target.


Created in NX8.5.0.

License requirements : None

Parameters
inheritTaginherittag
NXOpen::Expression* NXOpen::Annotations::DatumTargetBuilder::InnerDiameter ( )

Returns the inner diameter
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Annotations::DatumTargetBuilder::Label ( )

Returns the label
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::LeaderBuilder* NXOpen::Annotations::DatumTargetBuilder::Leader ( )

Returns the NXOpen::Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.



License requirements : None

bool NXOpen::Annotations::DatumTargetBuilder::Movable ( )

Returns the flag that indicates movable .If true then movable.


Created in NX10.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Annotations::DatumTargetBuilder::MovableModifierAngle ( )

Returns the movable modifier angle
Created in NX10.0.0.



License requirements : None

NXOpen::Annotations::OriginBuilder* NXOpen::Annotations::DatumTargetBuilder::Origin ( )

Returns the origin
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Annotations::DatumTargetBuilder::OuterDiameter ( )

Returns the outer diameter
Created in NX6.0.0.



License requirements : None

void NXOpen::Annotations::DatumTargetBuilder::ReverseMovableModifier ( )

Reverses the Movable datum target direction by 180 degree
Created in NX10.0.0.



License requirements : None

void NXOpen::Annotations::DatumTargetBuilder::SetAreaSize ( const NXString areaSize)

Sets the area size
Created in NX6.0.0.



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

Parameters
areaSizeareasize
void NXOpen::Annotations::DatumTargetBuilder::SetAreaSize ( const char *  areaSize)

Sets the area size
Created in NX6.0.0.



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

Parameters
areaSizeareasize
void NXOpen::Annotations::DatumTargetBuilder::SetDatumTargetStandard ( NXOpen::Annotations::DatumTargetBuilder::StandardTypes  standard)

Sets the datum target standard.


Created in NX10.0.0.

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

Parameters
standardstandard
void NXOpen::Annotations::DatumTargetBuilder::SetDrawX ( bool  flag)

Sets the draw x

Deprecated:
Deprecated in NX10.0.0.

Use NXOpen::Annotations::DatumTargetBuilder::SetTerminatorType instead.


Created in NX6.0.0.

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

Parameters
flagflag
void NXOpen::Annotations::DatumTargetBuilder::SetIndex ( int  index)

Sets the index
Created in NX6.0.0.



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

Parameters
indexindex
void NXOpen::Annotations::DatumTargetBuilder::SetLabel ( const NXString label)

Sets the label
Created in NX6.0.0.



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

Parameters
labellabel
void NXOpen::Annotations::DatumTargetBuilder::SetLabel ( const char *  label)

Sets the label
Created in NX6.0.0.



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

Parameters
labellabel
void NXOpen::Annotations::DatumTargetBuilder::SetMovable ( bool  flag)

Sets the flag that indicates movable .If true then movable.


Created in NX10.0.0.

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

Parameters
flagflag
void NXOpen::Annotations::DatumTargetBuilder::SetTerminatorType ( NXOpen::Annotations::DatumTargetBuilder::TerminatorTypes  type)

Sets the terminator type
Created in NX10.0.0.



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

Parameters
typetype
void NXOpen::Annotations::DatumTargetBuilder::SetType ( NXOpen::Annotations::DatumTargetBuilder::Types  type)

Sets the type
Created in NX6.0.0.



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

Parameters
typetype
NXOpen::Annotations::StyleBuilder* NXOpen::Annotations::DatumTargetBuilder::Style ( )

Returns the style
Created in NX6.0.0.



License requirements : None

NXOpen::Annotations::DatumTargetBuilder::TerminatorTypes NXOpen::Annotations::DatumTargetBuilder::TerminatorType ( )

Returns the terminator type
Created in NX10.0.0.



License requirements : None

NXOpen::Annotations::DatumTargetBuilder::Types NXOpen::Annotations::DatumTargetBuilder::Type ( )

Returns the type
Created in NX6.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Annotations::DatumTargetBuilder::Width ( )

Returns the width
Created in NX6.0.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.