NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Fields.SketchProfileBuilder Class Reference

Represents a builder class for creating and editing an NXOpen.Fields.Field that is defined by a sketch. More...

Inheritance diagram for NXOpen.Fields.SketchProfileBuilder:
NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  InterpolationType { Linear, Akima, Akima72, Cubic }
 interpolation method used for the profile. More...
 

Public Member Functions

unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe NXOpen.Expression ChordalTolerance [get]
 Returns the chordal tolerance. More...
 
unsafe
NXOpen.Fields.FieldProfileTable.SamplingPointOption 
DiscretePointType [get, set]
 Returns or sets the discrete point type. More...
 
unsafe
NXOpen.Fields.SketchProfileBuilder.InterpolationType 
Interpolation [get, set]
 Returns or sets the interpolation type. More...
 
unsafe int NumberPoints [get, set]
 Returns or sets the number of points. More...
 
unsafe NXOpen.Expression Offset [get]
 Returns the offset. More...
 
unsafe NXOpen.PointList Points [get]
 Returns the list of points. More...
 
unsafe NXOpen.Expression Scale [get]
 Returns the scale. More...
 
unsafe NXOpen.SelectSketch Sketch [get]
 Returns the sketch. More...
 
unsafe NXOpen.Unit UnitType [get, set]
 Returns or sets the unit type. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a builder class for creating and editing an NXOpen.Fields.Field that is defined by a sketch.

It is mandatory to select a valid NXOpen.Fields.SketchProfileBuilder.Sketch .

Created in NX1847.0.0

Member Enumeration Documentation

interpolation method used for the profile.

Enumerator
Linear 

Linear

Akima 

Akima

Akima72 

Akima72

Cubic 

Cubic

Member Function Documentation

unsafe bool NXOpen.Fields.SketchProfileBuilder.Validate ( )
inline

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.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe NXOpen.Expression NXOpen.Fields.SketchProfileBuilder.ChordalTolerance
get

Returns the chordal tolerance.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Fields.FieldProfileTable.SamplingPointOption NXOpen.Fields.SketchProfileBuilder.DiscretePointType
getset

Returns or sets the discrete point type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Fields.SketchProfileBuilder.InterpolationType NXOpen.Fields.SketchProfileBuilder.Interpolation
getset

Returns or sets the interpolation type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.Fields.SketchProfileBuilder.NumberPoints
getset

Returns or sets the number of points.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Expression NXOpen.Fields.SketchProfileBuilder.Offset
get

Returns the offset.

The unit of the offset has to match the NXOpen.Fields.SketchProfileBuilder.UnitType .

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.PointList NXOpen.Fields.SketchProfileBuilder.Points
get

Returns the list of points.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.Fields.SketchProfileBuilder.Scale
get

Returns the scale.

The scale is unitless.

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.SelectSketch NXOpen.Fields.SketchProfileBuilder.Sketch
get

Returns the sketch.

For the sketch to be valid

  • its start point must be at x=0
  • it must be continuous
  • it cannot have two y values at the same x value

Created in NX1847.0.0

License requirements: None.

unsafe NXOpen.Unit NXOpen.Fields.SketchProfileBuilder.UnitType
getset

Returns or sets the unit type.

Created in NX1847.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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