NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::LineSegment Class Reference

Represents a line segment. More...

Inheritance diagram for NXOpen::Routing::LineSegment:
NXOpen::Line NXOpen::Routing::ISegment NXOpen::Curve NXOpen::Routing::ICharacteristic NXOpen::SmartObject NXOpen::ICurve NXOpen::IProfile NXOpen::INXObject NXOpen::DisplayableObject NXOpen::IBaseCurve NXOpen::INXObject NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Member Functions

virtual
NXOpen::Routing::ConvertEccentricLinearToLinear 
ConvertEccentricLinearToLinear ()
 Is line segment eccentric converted to line segment?
virtual
NXOpen::Routing::ConvertLinearToEccentricLinear 
ConvertLinearToEccentricLinear ()
 Is line segment converted to eccentric line segment?
virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object.
virtual NXOpen::CurveFollowCurve ()
 Returns the segment follow curve.
virtual std::vector
< NXOpen::Routing::Electrical::CableDevice * > 
GetCableDevices ()
 Returns Routing::Electrical::CableDevice objects from Routing::ISegment .
virtual std::vector
< NXOpen::Routing::Electrical::CablewaysLayoutView * > 
GetCablewaysLayoutViews ()
 Returns Routing::Electrical::CablewaysLayoutView objects from the Routing::ISegment .
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object.
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()
 Returns the destination characteristics from the input object.
virtual void GetEndPoints (NXOpen::Point3d *startPoint, NXOpen::Point3d *endPoint)
 Get the current location of the segment ends in ABS coordinates.
virtual void GetEndRcps (NXOpen::Routing::ControlPoint **startRcp, NXOpen::Routing::ControlPoint **endRcp)
 Return of segment end control points.
virtual int GetIntegerCharacteristic (const NXString &name)
 Get the value of an integer characteristic associated with the input name.
virtual NXOpen::Routing::Eccentric GetIsEccentricSegment ()
 Is given segment a eccentric segment?
virtual NXOpen::Routing::Interior GetIsSegmentInterior ()
 Query if a segment is interior to any part.
virtual NXOpen::Routing::Terminal GetIsTerminalSegment ()
 Is given segment a terminal segment?
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name.
virtual std::vector
< NXOpen::Routing::Stock * > 
GetSegmentAllStocks ()
 Returns Routing::Stock as well as Routing::Overstock objects from the Routing::ISegment .
virtual std::vector
< NXOpen::Routing::Stock * > 
GetSegmentStock ()
 Returns all stocks that directly reference this segment as part of the path defining the stock.
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name.
bool IsAngleLocked (NXOpen::NXObject *object)
 Returns whether or not an angle, parallel or perpendicular constraint exists that constrains the angle between this segment and the other input object.
bool IsLengthLocked ()
 Returns whether or not a distance constraint exists that constrains the distance between the two end control points of this line segment.
NXOpen::Positioning::ConstraintLockAngle (NXOpen::NXObject *object, bool logicalConsOnly)
 Adds a constraint to maintain the angle of this line segment with respect to another object.
NXOpen::Positioning::ConstraintLockLength ()
 Adds a constraint to maintain the length of this line segment.
virtual void SetCharacteristic (const NXString &name, int value)
 Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristic (const NXString &name, double value)
 Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristic (const NXString &name, const NXString &value)
 Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)
 Set all of the characteristics values on this object.
virtual void SetEndPoints (const NXOpen::Point3d &startPoint, const NXOpen::Point3d &endPoint)
 Set the current location of the segment ends in ABS coordinates.
virtual void SetEndRcps (NXOpen::Routing::ControlPoint *startRcp, NXOpen::Routing::ControlPoint *endRcp)
 
Created in NX4.0.0.
virtual void SetIsTerminalSegment (NXOpen::Routing::Terminal isTerminal)
 Set given segment to be a terminal segment?
Created in NX4.0.0.
virtual void SetSegmentInteriorPart (NXOpen::Assemblies::Component *interiorPart)
 Set a segment to be interior to supplied part
Created in NX4.0.0.
void UnlockAngle (NXOpen::NXObject *object)
 Removes the angle, parallel or perpendicular constraint that constrains the angle between this line segment and the input object.
void UnlockLength ()
 Removes the distance constraint that constrains the distance between the two end control points of this line segment.

Detailed Description

Represents a line segment.


To obtain an instance of this class use Routing::LineSegmentCollection

Created in NX4.0.0.


Member Function Documentation

Is line segment eccentric converted to line segment?

Returns:
Is line segment eccentric converted to line segment?
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Is line segment converted to eccentric line segment?

Returns:
Is line segment converted to eccentric line segment?
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Removes the input list of characteristics from this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

Returns the segment follow curve.

NULL object indicates segment has no follow curve
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Returns Routing::Electrical::CableDevice objects from Routing::ISegment .

Returns:
Array of cable devices.
Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Implements NXOpen::Routing::ISegment.

Returns Routing::Electrical::CablewaysLayoutView objects from the Routing::ISegment .

Returns:
Array of cableways layout views.
Created in NX7.5.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical")

Implements NXOpen::Routing::ISegment.

Get all of the characteristics values on the this object.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ICharacteristic.

Returns the destination characteristics from the input object.

Retrieves the description of which destination characteristics to read from the application view and then reads those destination characteristics from the object

  • Ports: Reads characteristics from the port.
  • RCPs: Attempts to find a port at the RCP, reads characteristics from the port if it exists, otherwise reads from the stock associated with the rcp.
  • Segments: Reads characteristics from the stock associated with the segment.
  • Components: Reads characteristics directly from the component.
  • Stock: Reads characteristics from the stock or from the stock's data.
Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::LineSegment::GetEndPoints ( NXOpen::Point3d startPoint,
NXOpen::Point3d endPoint 
) [virtual]

Get the current location of the segment ends in ABS coordinates.

This value is overridden by the coordinates of the end RCPs associated with this segment.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startPointLocation of end 0 in ABS coordinates
endPointLocation of end 1 in ABS coordinates

Implements NXOpen::Routing::ISegment.

Return of segment end control points.

The Routing::ControlPoint defines an end of a segment
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startRcpRCP defining start of segment
endRcpRCP defining end of segment

Implements NXOpen::Routing::ISegment.

virtual int NXOpen::Routing::LineSegment::GetIntegerCharacteristic ( const NXString name) [virtual]

Get the value of an integer characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Is given segment a eccentric segment?

Returns:
Is segment a eccentric segment?
Created in NX8.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Query if a segment is interior to any part.

Returns:
Is segment interior?
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Is given segment a terminal segment?

Returns:
Is segment a terminal segment?
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

virtual double NXOpen::Routing::LineSegment::GetRealCharacteristic ( const NXString name) [virtual]

Get the value of a real characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Returns Routing::Stock as well as Routing::Overstock objects from the Routing::ISegment .

Returns:
Array of stocks/overstocks.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Returns all stocks that directly reference this segment as part of the path defining the stock.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Implements NXOpen::Routing::ISegment.

Get the value of a string characteristic associated with the input name.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Returns whether or not an angle, parallel or perpendicular constraint exists that constrains the angle between this segment and the other input object.

Both line segments must not be occurrences.

Returns:
Whether or not the angle is locked.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
objectOther object

Returns whether or not a distance constraint exists that constrains the distance between the two end control points of this line segment.

Returns:
Whether or not the length is locked.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")

Adds a constraint to maintain the angle of this line segment with respect to another object.

It does this by ensuring that there is an angle, perpendicular or parallel constraint between this line segment and the other object. This line segment must not be an occurrence, the other object may be an occurrence.

See Positioning::Constraint for a description of angle, parallel and perpendicular constraints.

Returns:
The new or existing angle constraint.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
Parameters:
objectOther object.
logicalConsOnlyif true, only create perpendicular or parallel constraints, if false will also create angle constraints.

Adds a constraint to maintain the length of this line segment.

It does this by ensuring that there is a distance constraint between the two end Routing::ControlPoint objects of this line segment. See Positioning::Constraint for a description of distance constraints.

Returns:
The new or existing distance constraint between the end control points.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")
virtual void NXOpen::Routing::LineSegment::SetCharacteristic ( const NXString name,
int  value 
) [virtual]

Set the value of an integer characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to integer if it's type is not integer.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::LineSegment::SetCharacteristic ( const NXString name,
double  value 
) [virtual]

Set the value of an real characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to real if it's type is not real.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::LineSegment::SetCharacteristic ( const NXString name,
const NXString value 
) [virtual]

Set the value of an string characteristic associated with the input name, adds a new characteristic to the list if one doesn't exist already.

Converts the type of an existing characteristic with the same name to string if it's type is not string.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

Implements NXOpen::Routing::ICharacteristic.

Set all of the characteristics values on this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::LineSegment::SetEndPoints ( const NXOpen::Point3d startPoint,
const NXOpen::Point3d endPoint 
) [virtual]

Set the current location of the segment ends in ABS coordinates.

This value is overridden by the coordinates of the end RCPs associated with this segment.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startPointNew location of end 0 in ABS coordinates
endPointNew location of end 1 in ABS coordinates

Implements NXOpen::Routing::ISegment.


Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startRcpRCP defining start of segment
endRcpRCP defining end of segment

Implements NXOpen::Routing::ISegment.

Set given segment to be a terminal segment?
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
isTerminalSet as terminal segment?

Implements NXOpen::Routing::ISegment.

Set a segment to be interior to supplied part
Created in NX4.0.0.



License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
interiorPartPart segment interior?

Implements NXOpen::Routing::ISegment.

Removes the angle, parallel or perpendicular constraint that constrains the angle between this line segment and the input object.

This line segment must not be an occurrence.

Call Update::DoUpdate afterwards to ensure that the constraint is fully deleted.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")

Parameters:
objectOther object

Removes the distance constraint that constrains the distance between the two end control points of this line segment.

Call Update::DoUpdate afterwards to ensure that the constraint is fully deleted.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical")


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