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

Builds an on-path dimension
Created in NX5.0.0. More...

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

List of all members.

Public Types

enum  UpdateReason { UpdateReasonPath = 1, UpdateReasonThroughPoint, UpdateReasonAll }
 The type of update to perform. More...

Public Member Functions

NXOpen::ExpressionExpression ()
 Returns the expression for the value of the dimension
Created in NX5.0.0.
bool IsFlipped ()
 Returns a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path
Created in NX5.0.0.
bool IsParameterUsed ()
 Returns a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).
bool IsPercentUsed ()
 Returns a flag indicating whether the expression represents the percentage along the path.
NXOpen::SelectObjectPath ()
 Returns the path that the dimension is evaluated on.
void SetFlipped (bool flipped)
 Sets a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path
Created in NX5.0.0.
void SetParameterUsed (bool useParameter)
 Sets a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).
void SetPercentUsed (bool usePercent)
 Sets a flag indicating whether the expression represents the percentage along the path.
void SetThroughPoint (NXOpen::Point *throughPoint)
 Sets the through point
Created in NX5.0.0.
NXOpen::PointThroughPoint ()
 Returns the through point
Created in NX5.0.0.
void Update (NXOpen::GeometricUtilities::OnPathDimensionBuilder::UpdateReason updateReason)
 Updates this object if the path or through point location has changed.
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.

Detailed Description

Builds an on-path dimension
Created in NX5.0.0.



Member Enumeration Documentation

The type of update to perform.

Enumerator:
UpdateReasonThroughPoint 

Update because the through point location may have changed.

UpdateReasonAll 

Update because either path or through point location may have changed.


Member Function Documentation

Returns the expression for the value of the dimension
Created in NX5.0.0.



License requirements : None

Returns a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path
Created in NX5.0.0.



License requirements : None

Returns a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).

When value is true, the value will always be expressed in terms of percentage (between 0 and 100) regardless of is_percent_used's setting. This property must be used with care. Most referencing classes will only accept arclength values, and setting this property to true for those classes will result in a run time error. Consult the referencing class documentation to see if this value can be true for that particular operation.
Created in NX5.0.0.

License requirements : None

Returns a flag indicating whether the expression represents the percentage along the path.

If false, the expression represents the length along the path
Created in NX5.0.0.

License requirements : None

Returns the path that the dimension is evaluated on.

Note: in some cases, the builder will not permit you to change the path
Created in NX5.0.0.

License requirements : None

Sets a flag indicating whether the length along the path is evaluated starting from the end point of path instead of the start point of the path
Created in NX5.0.0.



License requirements : None

Parameters:
flippedflipped

Sets a flag indicating whether the expression is in terms of the mathematical parameter of the path (is_parameter_used = true) or in terms of its arclength (is_parameter_used = false).

When value is true, the value will always be expressed in terms of percentage (between 0 and 100) regardless of is_percent_used's setting. This property must be used with care. Most referencing classes will only accept arclength values, and setting this property to true for those classes will result in a run time error. Consult the referencing class documentation to see if this value can be true for that particular operation.
Created in NX5.0.0.

License requirements : None

Parameters:
useParameteruse parameter

Sets a flag indicating whether the expression represents the percentage along the path.

If false, the expression represents the length along the path
Created in NX5.0.0.

License requirements : None

Parameters:
usePercentuse percent

Sets the through point
Created in NX5.0.0.



License requirements : None

Parameters:
throughPointthroughpoint

Returns the through point
Created in NX5.0.0.



License requirements : None

Updates this object if the path or through point location has changed.

Call this function if the path is a section and you have added or removed curves from the section, or if there is a through point and the coordinates of the through point have changed.
Created in NX5.0.0.

License requirements : None

Parameters:
updateReasonupdatereason

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