SpinePointData Class¶
-
class
NXOpen.GeometricUtilities.
SpinePointData
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a spine point def object
To create an instance of this class, see
NXOpen.GeometricUtilities.SpinePointDataCollection
New in version NX5.0.0.
Properties¶
Property | Description |
---|---|
ParameterLength | Returns or sets the parameter in arc length |
ParameterPercent | Returns or sets the parameter in percent arc length |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
GetLawValueAtPoint | Returns the law value at the specified point |
GetParentSpine | Returns the parent spine on which spine point is defined |
SetLawValueAtPoint | Sets the law value at the specified point |
SetParentSpine | Sets the parent spine on which spine point is defined |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
SpinePointDataParameterType Enumeration | Parameter type |
Property Detail¶
ParameterLength¶
-
SpinePointData.
ParameterLength
¶ Returns or sets the parameter in arc length
-------------------------------------
Getter Method
Signature
ParameterLength
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParameterLength
Parameters: lengthParameter (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
ParameterPercent¶
-
SpinePointData.
ParameterPercent
¶ Returns or sets the parameter in percent arc length
-------------------------------------
Getter Method
Signature
ParameterPercent
Returns: Return type: float New in version NX5.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ParameterPercent
Parameters: percentParameter (float) – New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Method Detail¶
GetLawValueAtPoint¶
-
SpinePointData.
GetLawValueAtPoint
¶ Returns the law value at the specified point
Signature
GetLawValueAtPoint()
Returns: Law value Expression Object Return type: NXOpen.Expression
New in version NX5.0.0.
License requirements: None.
GetParentSpine¶
-
SpinePointData.
GetParentSpine
¶ Returns the parent spine on which spine point is defined
Signature
GetParentSpine()
Returns: section object Return type: NXOpen.Section
New in version NX5.0.0.
License requirements: None.
SetLawValueAtPoint¶
-
SpinePointData.
SetLawValueAtPoint
¶ Sets the law value at the specified point
Signature
SetLawValueAtPoint(valString)
Parameters: valString (str) – Law value string New in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
SetParentSpine¶
-
SpinePointData.
SetParentSpine
¶ Sets the parent spine on which spine point is defined
Signature
SetParentSpine(parent)
Parameters: parent ( NXOpen.Section
) – Parent section path on which spine point is definedNew in version NX5.0.0.
License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”)
Validate¶
-
SpinePointData.
Validate
¶ 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.
Signature
Validate()
Returns: Was self validation successful Return type: bool New in version NX3.0.1.
License requirements: None.