Represents a LawBuilder
Created in NX5.0.0. More...

Inheritance diagram for NXOpen::GeometricUtilities::LawBuilder:

Public Types
enum	RetainLawCurveOption { RetainLawCurveOptionKeepOriginal, RetainLawCurveOptionReplace }
	Describes the option on whether to retain the original profile. More...

enum	Type { TypeConstant, TypeLinear, TypeCubic, TypeLinearAlongSpine, TypeCubicAlongSpine, TypeByEquation, TypeByLawCurve, TypeMultiTransition, TypeNonInflecting, TypeSShaped }
	The law types. More...

Public Member Functions
NXOpen::GeometricUtilities::AlongSpineBuilder *	AlongSpineData ()
	Returns the linear or cubic along spine law.

NXOpen::SelectLine *	BaseLine ()
	Returns the base line.

NXOpen::Expression *	EndValue ()
	Returns the end value.

NXString	Function ()
	Returns the function.

bool	IsSimpleCubicAlongSpine ()
	Returns a value indicating if GeometricUtilities::LawBuilder::TypeCubicAlongSpine is using simple cubic interpolation.

NXOpen::Section *	LawCurve ()
	Returns the law curve.

NXOpen::GeometricUtilities::LawBuilder::RetainLawCurveOption	LawCurveOption ()
	Returns the option to retain law curve.

NXOpen::GeometricUtilities::LawBuilder::Type	LawType ()
	Returns the law type Created in NX5.0.0.

NXOpen::GeometricUtilities::MultiTransitionLawBuilder *	MultiTransitionLaw ()
	Returns the multi transition law.

NXOpen::GeometricUtilities::NonInflectingLawBuilder *	NonInflectingLaw ()
	Returns the non inflecting law.

NXString	Parameter ()
	Returns the parameter.

bool	ReverseDirection ()
	Returns the reverse direction.

void	SetFunction (const NXString &function)
	Sets the function.

void	SetFunction (const char *function)
	Sets the function.

void	SetLawCurveOption (NXOpen::GeometricUtilities::LawBuilder::RetainLawCurveOption lawCurveOption)
	Sets the option to retain law curve.

void	SetLawType (NXOpen::GeometricUtilities::LawBuilder::Type lawType)
	Sets the law type Created in NX5.0.0.

void	SetParameter (const NXString &parameter)
	Sets the parameter.

void	SetParameter (const char *parameter)
	Sets the parameter.

void	SetReverseDirection (bool reverseDirection)
	Sets the reverse direction.

void	SetSimpleCubicAlongSpine (bool isSimpleCubic)
	Sets a value indicating if GeometricUtilities::LawBuilder::TypeCubicAlongSpine is using simple cubic interpolation.

void	SetSpineIntoBuilder (NXOpen::Section *spine)
	Sets the spine dynamically into builder Created in NX5.0.0.

NXOpen::GeometricUtilities::SShapedLawBuilder *	SShapedLaw ()
	Returns the s-shaped law.

NXOpen::Expression *	StartValue ()
	Returns the start value.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

NXOpen::Expression *	Value ()
	Returns the constant value.

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 LawBuilder
Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::GeometricUtilities::LawBuilder::RetainLawCurveOption

Describes the option on whether to retain the original profile.

Enumerator:

RetainLawCurveOptionKeepOriginal	Keeps the original profile as it is during edit pre NX3 parms.
RetainLawCurveOptionReplace	Deletes the old profile, so that user has to select new one during edit pre NX3 parms.

enum NXOpen::GeometricUtilities::LawBuilder::Type

The law types.

Enumerator:

TypeConstant	constant law type
TypeLinear	linear law type
TypeCubic	cubic law type
TypeLinearAlongSpine	linear along spine law type
TypeCubicAlongSpine	cubic along spine law type
TypeByEquation	by equation law type
TypeByLawCurve	by law curve law type
TypeMultiTransition	multi-transition law type
TypeNonInflecting	non-inflecting law type
TypeSShaped	S-shaped law type.

Member Function Documentation

NXOpen::GeometricUtilities::AlongSpineBuilder* NXOpen::GeometricUtilities::LawBuilder::AlongSpineData ( )

Returns the linear or cubic along spine law.

This will be used only when the law type is linear along spine/cubic along spine
Created in NX5.0.0.

License requirements : None

NXOpen::SelectLine* NXOpen::GeometricUtilities::LawBuilder::BaseLine ( )

Returns the base line.

This will be used only when the law type is by law curve
Created in NX5.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::LawBuilder::EndValue ( )

Returns the end value.

This will be used only when the law type is linear/cubic
Created in NX5.0.0.

License requirements : None

NXString NXOpen::GeometricUtilities::LawBuilder::Function ( )

Returns the function.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::LawBuilder::IsSimpleCubicAlongSpine ( )

Returns a value indicating if GeometricUtilities::LawBuilder::TypeCubicAlongSpine is using simple cubic interpolation.

       Simple cubic interpolation minimizes enforcement of automatic tangent constraints at the defining points. This option is valid only
       when @link GeometricUtilities::LawBuilder::Type GeometricUtilities::LawBuilder::Type@endlink  is @link GeometricUtilities::LawBuilder::TypeCubicAlongSpine GeometricUtilities::LawBuilder::TypeCubicAlongSpine@endlink

Created in NX6.0.0.

License requirements : None

NXOpen::Section* NXOpen::GeometricUtilities::LawBuilder::LawCurve ( )

Returns the law curve.

This will be used only when the law type is by law curve
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::LawBuilder::RetainLawCurveOption NXOpen::GeometricUtilities::LawBuilder::LawCurveOption ( )

Returns the option to retain law curve.

This will be used only during the edit of Pre NX3 feature Parms
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::LawBuilder::Type NXOpen::GeometricUtilities::LawBuilder::LawType ( )

Returns the law type
Created in NX5.0.0.

License requirements : None

NXOpen::GeometricUtilities::MultiTransitionLawBuilder* NXOpen::GeometricUtilities::LawBuilder::MultiTransitionLaw ( )

Returns the multi transition law.

This will be used only when the law type is multi transition law
Created in NX6.0.0.

License requirements : None

NXOpen::GeometricUtilities::NonInflectingLawBuilder* NXOpen::GeometricUtilities::LawBuilder::NonInflectingLaw ( )

Returns the non inflecting law.

This will be used only when the law type is non inflecting law
Created in NX6.0.0.

License requirements : None

NXString NXOpen::GeometricUtilities::LawBuilder::Parameter ( )

Returns the parameter.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : None

bool NXOpen::GeometricUtilities::LawBuilder::ReverseDirection ( )

Returns the reverse direction.

This will be used only when the law type is by law curve
Created in NX5.0.0.

License requirements : None

void NXOpen::GeometricUtilities::LawBuilder::SetFunction ( const NXString & function )

Sets the function.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

function Set the name of function expression

void NXOpen::GeometricUtilities::LawBuilder::SetFunction ( const char * function )

Sets the function.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

function Set the name of function expression

void NXOpen::GeometricUtilities::LawBuilder::SetLawCurveOption ( NXOpen::GeometricUtilities::LawBuilder::RetainLawCurveOption lawCurveOption )

Sets the option to retain law curve.

This will be used only during the edit of Pre NX3 feature Parms
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

lawCurveOption lawcurveoption

void NXOpen::GeometricUtilities::LawBuilder::SetLawType ( NXOpen::GeometricUtilities::LawBuilder::Type lawType )

Sets the law type
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

lawType Set the lawType

void NXOpen::GeometricUtilities::LawBuilder::SetParameter ( const NXString & parameter )

Sets the parameter.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

parameter Set the name of parameter expression

void NXOpen::GeometricUtilities::LawBuilder::SetParameter ( const char * parameter )

Sets the parameter.

This will be used only when the law type is by equation. Make sure that the expression should be created before setting it in to the builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

parameter Set the name of parameter expression

void NXOpen::GeometricUtilities::LawBuilder::SetReverseDirection ( bool reverseDirection )

Sets the reverse direction.

This will be used only when the law type is by law curve
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

reverseDirection Set the reverse direction flag

void NXOpen::GeometricUtilities::LawBuilder::SetSimpleCubicAlongSpine ( bool isSimpleCubic )

Sets a value indicating if GeometricUtilities::LawBuilder::TypeCubicAlongSpine is using simple cubic interpolation.

       Simple cubic interpolation minimizes enforcement of automatic tangent constraints at the defining points. This option is valid only
       when @link GeometricUtilities::LawBuilder::Type GeometricUtilities::LawBuilder::Type@endlink  is @link GeometricUtilities::LawBuilder::TypeCubicAlongSpine GeometricUtilities::LawBuilder::TypeCubicAlongSpine@endlink

Created in NX6.0.0.

License requirements : None

Parameters

isSimpleCubic issimplecubic

void NXOpen::GeometricUtilities::LawBuilder::SetSpineIntoBuilder ( NXOpen::Section * spine )

Sets the spine dynamically into builder
Created in NX5.0.0.

License requirements : solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

Parameters

spine Set the Spine into builder

NXOpen::GeometricUtilities::SShapedLawBuilder* NXOpen::GeometricUtilities::LawBuilder::SShapedLaw ( )

Returns the s-shaped law.

This will be used only when the law type is s-shaped law
Created in NX6.0.0.

License requirements : None

NXOpen::Expression* NXOpen::GeometricUtilities::LawBuilder::StartValue ( )

Returns the start value.

This will be used only when the law type is linear/cubic
Created in NX5.0.0.

License requirements : None

virtual bool NXOpen::GeometricUtilities::LawBuilder::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::Expression* NXOpen::GeometricUtilities::LawBuilder::Value ( )

Returns the constant value.

This will be used only when the law type is constant
Created in NX5.0.0.

License requirements : None

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

GeometricUtilities_LawBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation