NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::GeometricUtilities::LawBuilder Class Reference

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

Inheritance diagram for NXOpen::GeometricUtilities::LawBuilder:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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::AlongSpineBuilderAlongSpineData ()
 Returns the linear or cubic along spine law.
NXOpen::SelectLineBaseLine ()
 Returns the base line.
NXOpen::ExpressionEndValue ()
 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::SectionLawCurve ()
 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::MultiTransitionLawBuilderMultiTransitionLaw ()
 Returns the multi transition law.
NXOpen::GeometricUtilities::NonInflectingLawBuilderNonInflectingLaw ()
 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 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 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::SShapedLawBuilderSShapedLaw ()
 Returns the s-shaped law.
NXOpen::ExpressionStartValue ()
 Returns the start value.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
NXOpen::ExpressionValue ()
 Returns the constant value.

Detailed Description

Represents a LawBuilder
Created in NX5.0.0.



Member Enumeration Documentation

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.

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

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

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

Returns the end value.

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

License requirements : None

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

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 GeometricUtilities::LawBuilder::Type is GeometricUtilities::LawBuilder::TypeCubicAlongSpine
Created in NX6.0.0.

License requirements : None

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

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

Returns the law type
Created in NX5.0.0.



License requirements : None

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

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

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

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

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:
functionSet the name of function expression

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:
lawCurveOptionlawcurveoption

Sets the law type
Created in NX5.0.0.



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

Parameters:
lawTypeSet the lawType

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:
parameterSet the name of parameter expression

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:
reverseDirectionSet the reverse direction flag

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 GeometricUtilities::LawBuilder::Type is GeometricUtilities::LawBuilder::TypeCubicAlongSpine
Created in NX6.0.0.

License requirements : None

Parameters:
isSimpleCubicissimplecubic

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



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

Parameters:
spineSet the Spine into builder

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

Returns the start value.

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

License requirements : None

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.

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:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.