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  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.
 
bool DrawX ()
 Returns the draw x
Created in NX6.0.0.
 
NXOpen::ExpressionHeight ()
 Returns the height
Created in NX6.0.0.
 
int Index ()
 Returns the index
Created in NX6.0.0.
 
void InheritFrom (NXOpen::Annotations::BaseDatumTarget *inheritTag)
 The datum target is inherited form existing datum target.
 
NXOpen::ExpressionInnerDiameter ()
 Returns the inner diameter
Created in NX6.0.0.
 
NXString Label ()
 Returns the label
Created in NX6.0.0.
 
NXOpen::Annotations::LeaderBuilderLeader ()
 Returns the Annotations::LeaderBuilder for the annotation
Created in NX6.0.0.
 
NXOpen::Annotations::OriginBuilderOrigin ()
 Returns the origin
Created in NX6.0.0.
 
NXOpen::ExpressionOuterDiameter ()
 Returns the outer diameter
Created in NX6.0.0.
 
void SetAreaSize (const NXString &areaSize)
 Sets the area size
Created in NX6.0.0.
 
void SetAreaSize (const char *areaSize)
 Sets the area size
Created in NX6.0.0.
 
void SetDrawX (bool flag)
 Sets the draw x
Created in NX6.0.0.
 
void SetIndex (int index)
 Sets the index
Created in NX6.0.0.
 
void SetLabel (const NXString &label)
 Sets the label
Created in NX6.0.0.
 
void SetLabel (const char *label)
 Sets the label
Created in NX6.0.0.
 
void SetType (NXOpen::Annotations::DatumTargetBuilder::Types type)
 Sets the type
Created in NX6.0.0.
 
NXOpen::Annotations::StyleBuilderStyle ()
 Returns the style
Created in NX6.0.0.
 
NXOpen::Annotations::DatumTargetBuilder::Types Type ()
 Returns the type
Created in NX6.0.0.
 
NXOpen::ExpressionWidth ()
 Returns the width
Created in NX6.0.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
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 Datum target Builder
This is an abstract class, and cannot be instantiated.



Created in NX6.0.0.

Member Enumeration Documentation

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

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

Returns the draw x
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 Annotations::LeaderBuilder for the annotation
Created in NX6.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::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::SetDrawX ( bool  flag)

Sets the draw x
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::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::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 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.