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

Represents a LawBuilder More...

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

Public Types

enum  RetainLawCurveOption { KeepOriginal, Replace }
 Describes the option on whether to retain the original profile. More...
 
enum  Type {
  Constant, Linear, Cubic, LinearAlongSpine,
  CubicAlongSpine, ByEquation, ByLawCurve, MultiTransition,
  NonInflecting, SShaped
}
 The law types More...
 

Public Member Functions

unsafe void SetSpineIntoBuilder (NXOpen.Section spine)
 Sets the spine dynamically into builder More...
 
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.GeometricUtilities.AlongSpineBuilder 
AlongSpineData [get]
 Returns the linear or cubic along spine law. More...
 
unsafe NXOpen.SelectLine BaseLine [get]
 Returns the base line. More...
 
unsafe NXOpen.Expression EndValue [get]
 Returns the end value. More...
 
unsafe string Function [get, set]
 Returns or sets the function. More...
 
unsafe bool IsSimpleCubicAlongSpine [get, set]
 Returns or sets a value indicating if NXOpen.GeometricUtilities.LawBuilder.Type.CubicAlongSpine is using simple cubic interpolation. More...
 
unsafe NXOpen.Section LawCurve [get]
 Returns the law curve. More...
 
unsafe
NXOpen.GeometricUtilities.LawBuilder.RetainLawCurveOption 
LawCurveOption [get, set]
 Returns or sets the option to retain law curve. More...
 
unsafe
NXOpen.GeometricUtilities.LawBuilder.Type 
LawType [get, set]
 Returns or sets the law type More...
 
unsafe
NXOpen.GeometricUtilities.MultiTransitionLawBuilder 
MultiTransitionLaw [get]
 Returns the multi transition law. More...
 
unsafe
NXOpen.GeometricUtilities.NonInflectingLawBuilder 
NonInflectingLaw [get]
 Returns the non inflecting law. More...
 
unsafe string Parameter [get, set]
 Returns or sets the parameter. More...
 
unsafe bool ReverseDirection [get, set]
 Returns or sets the reverse direction. More...
 
unsafe
NXOpen.GeometricUtilities.SShapedLawBuilder 
SShapedLaw [get]
 Returns the s-shaped law. More...
 
unsafe NXOpen.Expression StartValue [get]
 Returns the start value. More...
 
unsafe NXOpen.Expression Value [get]
 Returns the constant value. 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 LawBuilder

Created in NX5.0.0

Member Enumeration Documentation

Describes the option on whether to retain the original profile.

Enumerator
KeepOriginal 

Keeps the original profile as it is during edit pre NX3 parms

Replace 

Deletes the old profile, so that user has to select new one during edit pre NX3 parms

The law types

Enumerator
Constant 

constant law type

Linear 

linear law type

Cubic 

cubic law type

LinearAlongSpine 

linear along spine law type

CubicAlongSpine 

cubic along spine law type

ByEquation 

by equation law type

ByLawCurve 

by law curve law type

MultiTransition 

multi-transition law type

NonInflecting 

non-inflecting law type

SShaped 

S-shaped law type

Member Function Documentation

unsafe void NXOpen.GeometricUtilities.LawBuilder.SetSpineIntoBuilder ( NXOpen.Section  spine)
inline

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
unsafe bool NXOpen.GeometricUtilities.LawBuilder.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.GeometricUtilities.AlongSpineBuilder NXOpen.GeometricUtilities.LawBuilder.AlongSpineData
get

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.

unsafe NXOpen.SelectLine NXOpen.GeometricUtilities.LawBuilder.BaseLine
get

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.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.LawBuilder.EndValue
get

Returns the end value.

This will be used only when the law type is linear/cubic

Created in NX5.0.0

License requirements: None.

unsafe string NXOpen.GeometricUtilities.LawBuilder.Function
getset

Returns or 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 to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

unsafe bool NXOpen.GeometricUtilities.LawBuilder.IsSimpleCubicAlongSpine
getset

Returns or sets a value indicating if NXOpen.GeometricUtilities.LawBuilder.Type.CubicAlongSpine is using simple cubic interpolation.

Simple cubic interpolation minimizes enforcement of automatic tangent constraints at the defining points. This option is valid only when NXOpen.GeometricUtilities.LawBuilder.Type is NXOpen.GeometricUtilities.LawBuilder.Type.CubicAlongSpine

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Section NXOpen.GeometricUtilities.LawBuilder.LawCurve
get

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.

unsafe NXOpen.GeometricUtilities.LawBuilder.RetainLawCurveOption NXOpen.GeometricUtilities.LawBuilder.LawCurveOption
getset

Returns or 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 to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

unsafe NXOpen.GeometricUtilities.LawBuilder.Type NXOpen.GeometricUtilities.LawBuilder.LawType
getset

Returns or sets the law type

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

unsafe NXOpen.GeometricUtilities.MultiTransitionLawBuilder NXOpen.GeometricUtilities.LawBuilder.MultiTransitionLaw
get

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.

unsafe NXOpen.GeometricUtilities.NonInflectingLawBuilder NXOpen.GeometricUtilities.LawBuilder.NonInflectingLaw
get

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.

unsafe string NXOpen.GeometricUtilities.LawBuilder.Parameter
getset

Returns or 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 to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

unsafe bool NXOpen.GeometricUtilities.LawBuilder.ReverseDirection
getset

Returns or sets the reverse direction.

This will be used only when the law type is by law curve

Created in NX5.0.0

License requirements to get this property: None.

License requirements to set this property: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING")

unsafe NXOpen.GeometricUtilities.SShapedLawBuilder NXOpen.GeometricUtilities.LawBuilder.SShapedLaw
get

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.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.LawBuilder.StartValue
get

Returns the start value.

This will be used only when the law type is linear/cubic

Created in NX5.0.0

License requirements: None.

unsafe NXOpen.Expression NXOpen.GeometricUtilities.LawBuilder.Value
get

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