NX Open C++ Reference Guide
Classes | Public Member Functions | List of all members
NXOpen::DatumCollection Class Reference

Represents a collection of datum geometry. More...

Inheritance diagram for NXOpen::DatumCollection:
NXOpen::TaggedObjectCollection

Classes

class  iterator
 Iterator for accessing the contents of the collection. More...
 

Public Member Functions

iterator begin ()
 Returns an iterator addressing the first element. More...
 
NXOpen::DatumAxisCreateFixedDatumAxis (const NXOpen::Point3d &start, const NXOpen::Point3d &end)
 Creates a fixed datum axis. More...
 
NXOpen::DatumPlaneCreateFixedDatumPlane (const NXOpen::Point3d &origin, const NXOpen::Matrix3x3 &orientation)
 Creates a fixed datum plane. More...
 
iterator end ()
 Returns an iterator addressing one past the last element. More...
 
NXOpen::DisplayableObjectFindObject (const NXString &journalIdentifier)
 Finds the datum with the given identifier as recorded in a journal. More...
 
NXOpen::DisplayableObjectFindObject (const char *journalIdentifier)
 Finds the datum with the given identifier as recorded in a journal. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a collection of datum geometry.

Datum geometry includes datum planes, datum axes, datum coordinate systems, and datum points
To obtain an instance of this class, refer to NXOpen::BasePart

Created in NX3.0.0.

Member Function Documentation

iterator NXOpen::DatumCollection::begin ( )

Returns an iterator addressing the first element.

NXOpen::DatumAxis* NXOpen::DatumCollection::CreateFixedDatumAxis ( const NXOpen::Point3d start,
const NXOpen::Point3d end 
)

Creates a fixed datum axis.

Note: start and end only specify the origin and start direction of the datum axis. The datum axis that is created may have a length longer than what is specified by start and end. To set the start and end points, DatumAxis.SetEndPoints may be used

Returns
The datum axis that is created
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT")
Parameters
startStart point
endEnd point
NXOpen::DatumPlane* NXOpen::DatumCollection::CreateFixedDatumPlane ( const NXOpen::Point3d origin,
const NXOpen::Matrix3x3 orientation 
)

Creates a fixed datum plane.

Returns
The datum plane that is created
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE")
Parameters
originOrigin of the datum plane
orientationOrientation matrix of the datum plane. Must be orthonormal
iterator NXOpen::DatumCollection::end ( )

Returns an iterator addressing one past the last element.

NXOpen::DisplayableObject* NXOpen::DatumCollection::FindObject ( const NXString journalIdentifier)

Finds the datum with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Datum with this identifier
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT")
Parameters
journalIdentifierIdentifier of the datum you want
NXOpen::DisplayableObject* NXOpen::DatumCollection::FindObject ( const char *  journalIdentifier)

Finds the datum with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Returns
Datum with this identifier
Created in NX3.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR cam_base ("CAM BASE") OR geometric_tol ("GDT")
Parameters
journalIdentifierIdentifier of the datum you want
tag_t NXOpen::DatumCollection::Tag ( ) const

Returns the tag of this object.


The documentation for this class was generated from the following file:
Copyright 2012 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.