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:

Public Types
enum	InterpolationType { InterpolationTypeLinear, InterpolationTypeAkima, InterpolationTypeAkima72, InterpolationTypeCubic }
	interpolation method used for the profile. More...

Public Member Functions
NXOpen::Expression *	ChordalTolerance ()
	Returns. More...

NXOpen::Fields::FieldProfileTable::SamplingPointOption	DiscretePointType ()
	Returns. More...

NXOpen::Fields::SketchProfileBuilder::InterpolationType	Interpolation ()
	Returns. More...

int	NumberPoints ()
	Returns. More...

NXOpen::Expression *	Offset ()
	Returns. More...

NXOpen::PointList *	Points ()
	Returns. More...

NXOpen::Expression *	Scale ()
	Returns. More...

void	SetDiscretePointType (NXOpen::Fields::FieldProfileTable::SamplingPointOption type)
	Sets. More...

void	SetInterpolation (NXOpen::Fields::SketchProfileBuilder::InterpolationType type)
	Sets. More...

void	SetNumberPoints (int type)
	Sets. More...

void	SetUnitType (NXOpen::Unit *unitType)
	Sets. More...

NXOpen::SelectSketch *	Sketch ()
	Returns. More...

NXOpen::Unit *	UnitType ()
	Returns. 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 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 and NXOpen::Fields::SketchProfileBuilder::SetSketch .

Created in NX1847.0.0.

Member Enumeration Documentation

enum NXOpen::Fields::SketchProfileBuilder::InterpolationType

interpolation method used for the profile.

Enumerator
InterpolationTypeLinear	Linear.
InterpolationTypeAkima	Akima.
InterpolationTypeAkima72	Akima72.
InterpolationTypeCubic	Cubic.

Member Function Documentation

NXOpen::Expression* NXOpen::Fields::SketchProfileBuilder::ChordalTolerance ( )

Returns.

the chordal tolerance.

Created in NX1847.0.0.

License requirements : None

NXOpen::Fields::FieldProfileTable::SamplingPointOption NXOpen::Fields::SketchProfileBuilder::DiscretePointType ( )

Returns.

the discrete point type.

Created in NX1847.0.0.

License requirements : None

NXOpen::Fields::SketchProfileBuilder::InterpolationType NXOpen::Fields::SketchProfileBuilder::Interpolation ( )

Returns.

the interpolation type.

Created in NX1847.0.0.

License requirements : None

int NXOpen::Fields::SketchProfileBuilder::NumberPoints ( )

Returns.

the number of points.

Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::SketchProfileBuilder::Offset ( )

Returns.

the offset.

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

Created in NX1847.0.0.

License requirements : None

NXOpen::PointList* NXOpen::Fields::SketchProfileBuilder::Points ( )

Returns.

the list of points.

Created in NX1847.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Fields::SketchProfileBuilder::Scale ( )

Returns.

the scale.

The scale is unitless.

Created in NX1847.0.0.

License requirements : None

void NXOpen::Fields::SketchProfileBuilder::SetDiscretePointType ( NXOpen::Fields::FieldProfileTable::SamplingPointOption type )

Sets.

the discrete point type.

Created in NX1847.0.0.

License requirements : None

Parameters

type type

void NXOpen::Fields::SketchProfileBuilder::SetInterpolation ( NXOpen::Fields::SketchProfileBuilder::InterpolationType type )

Sets.

the interpolation type.

Created in NX1847.0.0.

License requirements : None

Parameters

type type

void NXOpen::Fields::SketchProfileBuilder::SetNumberPoints ( int type )

Sets.

the number of points.

Created in NX1847.0.0.

License requirements : None

Parameters

type type

void NXOpen::Fields::SketchProfileBuilder::SetUnitType ( NXOpen::Unit * unitType )

Sets.

the unit type.

Created in NX1847.0.0.

License requirements : None

Parameters

unitType unittype

NXOpen::SelectSketch* NXOpen::Fields::SketchProfileBuilder::Sketch ( )

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

NXOpen::Unit* NXOpen::Fields::SketchProfileBuilder::UnitType ( )

Returns.

the unit type.

Created in NX1847.0.0.

License requirements : None

virtual bool NXOpen::Fields::SketchProfileBuilder::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.

The documentation for this class was generated from the following file:

Fields_SketchProfileBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation