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

Represents a NXOpen::Die::DieLocationBuilder . More...

Inheritance diagram for NXOpen::Die::DieLocationBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  LocationType {
  LocationTypeSelectLocation, LocationTypeNewPoint, LocationTypeNewCoordinateSystem, LocationTypeNewVector,
  LocationTypeNewPlane
}
 the options available for defining the location More...
 

Public Member Functions

NXOpen::Matrix3x3 CoordinateSystemMatrix ()
 Returns the coordinate system matrix
Created in NX6.0.0. More...
 
NXOpen::Point3d CoordinateSystemOrigin ()
 Returns the coordinate system origin
Created in NX6.0.0. More...
 
NXOpen::Die::DieLocationBuilder::LocationType InputType ()
 Returns the type of source that defined the location
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectLocation ()
 Returns the selected location
Created in NX6.0.0. More...
 
NXOpen::PlanePlane ()
 Returns the specified plane
Created in NX6.0.0. More...
 
NXOpen::PointPoint ()
 Returns the specified point
Created in NX6.0.0. More...
 
void SetCoordinateSystemMatrix (const NXOpen::Matrix3x3 &coordinateSystemMatrix)
 Sets the coordinate system matrix
Created in NX6.0.0. More...
 
void SetCoordinateSystemOrigin (const NXOpen::Point3d &coordinateSystemOrigin)
 Sets the coordinate system origin
Created in NX6.0.0. More...
 
void SetInputType (NXOpen::Die::DieLocationBuilder::LocationType inputType)
 Sets the type of source that defined the location
Created in NX6.0.0. More...
 
void SetPlane (NXOpen::Plane *plane)
 Sets the specified plane
Created in NX6.0.0. More...
 
void SetPoint (NXOpen::Point *point)
 Sets the specified point
Created in NX6.0.0. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the specified vector
Created in NX6.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::DirectionVector ()
 Returns the specified vector
Created in NX6.0.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a NXOpen::Die::DieLocationBuilder .

The Die Location Item is a helper and identifies a single item in the NXOpen::Die::DieLocationBuilder . The item allows the user to fully specify a single location point for items such as hole center or clamping slot location. Note that a non-point is selected, such as a plane or coordinate system, the control point of the object will be used for the location.
To create a new instance of this class, use NXOpen::Die::DieCollection::CreateDieLocation

Created in NX6.0.0.

Member Enumeration Documentation

the options available for defining the location

Enumerator
LocationTypeSelectLocation 

Select the point to be used.

LocationTypeNewPoint 

Define the point to be used.

LocationTypeNewCoordinateSystem 

Define a coordinate system to specify the location.

LocationTypeNewVector 

Define a vector to specify the location.

LocationTypeNewPlane 

Define a plane to specify the location.

Member Function Documentation

NXOpen::Matrix3x3 NXOpen::Die::DieLocationBuilder::CoordinateSystemMatrix ( )

Returns the coordinate system matrix
Created in NX6.0.0.



License requirements : None

NXOpen::Point3d NXOpen::Die::DieLocationBuilder::CoordinateSystemOrigin ( )

Returns the coordinate system origin
Created in NX6.0.0.



License requirements : None

NXOpen::Die::DieLocationBuilder::LocationType NXOpen::Die::DieLocationBuilder::InputType ( )

Returns the type of source that defined the location
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Die::DieLocationBuilder::Location ( )

Returns the selected location
Created in NX6.0.0.



License requirements : None

NXOpen::Plane* NXOpen::Die::DieLocationBuilder::Plane ( )

Returns the specified plane
Created in NX6.0.0.



License requirements : None

NXOpen::Point* NXOpen::Die::DieLocationBuilder::Point ( )

Returns the specified point
Created in NX6.0.0.



License requirements : None

void NXOpen::Die::DieLocationBuilder::SetCoordinateSystemMatrix ( const NXOpen::Matrix3x3 coordinateSystemMatrix)

Sets the coordinate system matrix
Created in NX6.0.0.



License requirements : None

Parameters
coordinateSystemMatrixcoordinatesystemmatrix
void NXOpen::Die::DieLocationBuilder::SetCoordinateSystemOrigin ( const NXOpen::Point3d coordinateSystemOrigin)

Sets the coordinate system origin
Created in NX6.0.0.



License requirements : None

Parameters
coordinateSystemOrigincoordinatesystemorigin
void NXOpen::Die::DieLocationBuilder::SetInputType ( NXOpen::Die::DieLocationBuilder::LocationType  inputType)

Sets the type of source that defined the location
Created in NX6.0.0.



License requirements : None

Parameters
inputTypeinputtype
void NXOpen::Die::DieLocationBuilder::SetPlane ( NXOpen::Plane plane)

Sets the specified plane
Created in NX6.0.0.



License requirements : None

Parameters
planeplane
void NXOpen::Die::DieLocationBuilder::SetPoint ( NXOpen::Point point)

Sets the specified point
Created in NX6.0.0.



License requirements : None

Parameters
pointpoint
void NXOpen::Die::DieLocationBuilder::SetVector ( NXOpen::Direction vector)

Sets the specified vector
Created in NX6.0.0.



License requirements : None

Parameters
vectorvector
virtual bool NXOpen::Die::DieLocationBuilder::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.

NXOpen::Direction* NXOpen::Die::DieLocationBuilder::Vector ( )

Returns the specified vector
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.