public interface LawBuilder extends TaggedObject, IComponentBuilder
Modifier and Type | Interface and Description |
---|---|
static class |
LawBuilder.RetainLawCurveOption
Describes the option on whether to retain the original profile.
|
static class |
LawBuilder.Type
The law types
|
Modifier and Type | Method and Description |
---|---|
AlongSpineBuilder |
alongSpineData()
Returns the linear or cubic along spine law.
|
SelectLine |
baseLine()
Returns the base line.
|
Expression |
endValue()
Returns the end value.
|
String |
function()
Returns the function.
|
boolean |
isSimpleCubicAlongSpine()
Returns a value indicating if
LawBuilder.Type.CUBIC_ALONG_SPINE is using simple cubic interpolation. |
Section |
lawCurve()
Returns the law curve.
|
LawBuilder.RetainLawCurveOption |
lawCurveOption()
Returns the option to retain law curve.
|
LawBuilder.Type |
lawType()
Returns the law type
License requirements: None. |
MultiTransitionLawBuilder |
multiTransitionLaw()
Returns the multi transition law.
|
NonInflectingLawBuilder |
nonInflectingLaw()
Returns the non inflecting law.
|
String |
parameter()
Returns the parameter.
|
boolean |
reverseDirection()
Returns the reverse direction.
|
void |
setFunction(String function)
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
void |
setLawCurveOption(LawBuilder.RetainLawCurveOption lawCurveOption)
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
void |
setLawType(LawBuilder.Type lawType)
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
void |
setParameter(String parameter)
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
void |
setReverseDirection(boolean reverseDirection)
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
void |
setSimpleCubicAlongSpine(boolean isSimpleCubic)
License requirements: None. |
void |
setSpineIntoBuilder(Section spine)
Sets the spine dynamically into builder
License requirements: solid_modeling ("SOLIDS MODELING") OR drafting ("DRAFTING") . |
SShapedLawBuilder |
sshapedLaw()
Returns the s-shaped law.
|
Expression |
startValue()
Returns the start value.
|
Expression |
value()
Returns the constant value.
|
printTestData, printTestData, tag, tagValue
validate
LawBuilder.Type lawType() throws NXException, RemoteException
NXException
RemoteException
void setLawType(LawBuilder.Type lawType) throws NXException, RemoteException
lawType
- Set the lawTypeNXException
RemoteException
Expression value() throws NXException, RemoteException
NXException
RemoteException
Expression startValue() throws NXException, RemoteException
NXException
RemoteException
Expression endValue() throws NXException, RemoteException
NXException
RemoteException
LawBuilder.RetainLawCurveOption lawCurveOption() throws NXException, RemoteException
NXException
RemoteException
void setLawCurveOption(LawBuilder.RetainLawCurveOption lawCurveOption) throws NXException, RemoteException
lawCurveOption
- NXException
RemoteException
AlongSpineBuilder alongSpineData() throws NXException, RemoteException
NXException
RemoteException
String parameter() throws NXException, RemoteException
NXException
RemoteException
void setParameter(String parameter) throws NXException, RemoteException
parameter
- Set the name of parameter expressionNXException
RemoteException
String function() throws NXException, RemoteException
NXException
RemoteException
void setFunction(String function) throws NXException, RemoteException
function
- Set the name of function expressionNXException
RemoteException
Section lawCurve() throws NXException, RemoteException
NXException
RemoteException
SelectLine baseLine() throws NXException, RemoteException
NXException
RemoteException
boolean reverseDirection() throws NXException, RemoteException
NXException
RemoteException
void setReverseDirection(boolean reverseDirection) throws NXException, RemoteException
reverseDirection
- Set the reverse direction flagNXException
RemoteException
void setSpineIntoBuilder(Section spine) throws NXException, RemoteException
spine
- Set the Spine into builderNXException
RemoteException
MultiTransitionLawBuilder multiTransitionLaw() throws NXException, RemoteException
NXException
RemoteException
NonInflectingLawBuilder nonInflectingLaw() throws NXException, RemoteException
NXException
RemoteException
SShapedLawBuilder sshapedLaw() throws NXException, RemoteException
NXException
RemoteException
boolean isSimpleCubicAlongSpine() throws NXException, RemoteException
LawBuilder.Type.CUBIC_ALONG_SPINE
is using simple cubic interpolation.
Simple cubic interpolation minimizes enforcement of automatic tangent constraints at the defining points. This option is valid only
when LawBuilder.Type
is LawBuilder.Type.CUBIC_ALONG_SPINE
NXException
RemoteException
void setSimpleCubicAlongSpine(boolean isSimpleCubic) throws NXException, RemoteException
isSimpleCubic
- NXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.