NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::GeometricUtilities::SpinePointData Class Reference

Represents a spine point def object
To create an instance of this class, see NXOpen::GeometricUtilities::SpinePointDataCollection

Created in NX5.0.0. More...

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

Public Types

enum  ParameterType { ParameterTypeNormal, ParameterTypePercent, ParameterTypeLength }
 Parameter type. More...
 

Public Member Functions

NXOpen::ExpressionGetLawValueAtPoint ()
 Returns the law value at the specified point. More...
 
NXOpen::SectionGetParentSpine ()
 Returns the parent spine on which spine point is defined. More...
 
double ParameterLength ()
 Returns the parameter in arc length
Created in NX5.0.0. More...
 
double ParameterPercent ()
 Returns the parameter in percent arc length
Created in NX5.0.0. More...
 
void SetLawValueAtPoint (const NXString &valString)
 Sets the law value at the specified point
Created in NX5.0.0. More...
 
void SetLawValueAtPoint (const char *valString)
 Sets the law value at the specified point
Created in NX5.0.0. More...
 
void SetParameterLength (double lengthParameter)
 Sets the parameter in arc length
Created in NX5.0.0. More...
 
void SetParameterPercent (double percentParameter)
 Sets the parameter in percent arc length
Created in NX5.0.0. More...
 
void SetParentSpine (NXOpen::Section *parent)
 Sets the parent spine on which spine point is defined
Created in NX5.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a spine point def object
To create an instance of this class, see NXOpen::GeometricUtilities::SpinePointDataCollection

Created in NX5.0.0.


Member Enumeration Documentation

Parameter type.

Enumerator
ParameterTypeNormal 

normal

ParameterTypePercent 

Parameter expressed as percent arc length.

ParameterTypeLength 

Parameter expressed as arc length.

Member Function Documentation

NXOpen::Expression* NXOpen::GeometricUtilities::SpinePointData::GetLawValueAtPoint ( )

Returns the law value at the specified point.

Returns
Law value Expression Object
Created in NX5.0.0.

License requirements : None
NXOpen::Section* NXOpen::GeometricUtilities::SpinePointData::GetParentSpine ( )

Returns the parent spine on which spine point is defined.

Returns
section object
Created in NX5.0.0.

License requirements : None
double NXOpen::GeometricUtilities::SpinePointData::ParameterLength ( )

Returns the parameter in arc length
Created in NX5.0.0.



License requirements : None

double NXOpen::GeometricUtilities::SpinePointData::ParameterPercent ( )

Returns the parameter in percent arc length
Created in NX5.0.0.



License requirements : None

void NXOpen::GeometricUtilities::SpinePointData::SetLawValueAtPoint ( const NXString valString)

Sets the law value at the specified point
Created in NX5.0.0.



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

Parameters
valStringLaw value string
void NXOpen::GeometricUtilities::SpinePointData::SetLawValueAtPoint ( const char *  valString)

Sets the law value at the specified point
Created in NX5.0.0.



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

Parameters
valStringLaw value string
void NXOpen::GeometricUtilities::SpinePointData::SetParameterLength ( double  lengthParameter)

Sets the parameter in arc length
Created in NX5.0.0.



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

Parameters
lengthParameterlength parameter
void NXOpen::GeometricUtilities::SpinePointData::SetParameterPercent ( double  percentParameter)

Sets the parameter in percent arc length
Created in NX5.0.0.



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

Parameters
percentParameterpercent parameter
void NXOpen::GeometricUtilities::SpinePointData::SetParentSpine ( NXOpen::Section parent)

Sets the parent spine on which spine point is defined
Created in NX5.0.0.



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

Parameters
parentParent section path on which spine point is defined
virtual bool NXOpen::GeometricUtilities::SpinePointData::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.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.