NX Open C++ Reference Guide
|
Represents a line segment. More...
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::Curve * | FollowCurve () |
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::Constraint * | LockAngle (NXOpen::NXObject *object, bool logicalConsOnly) |
Adds a constraint to maintain the angle of this line segment with respect to another object. | |
NXOpen::Positioning::Constraint * | LockLength () |
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. |
Represents a line segment.
To obtain an instance of this class use Routing::LineSegmentCollection
Created in NX4.0.0.
virtual NXOpen::Routing::ConvertEccentricLinearToLinear NXOpen::Routing::LineSegment::ConvertEccentricLinearToLinear | ( | ) | [virtual] |
Is line segment eccentric converted to line segment?
Implements NXOpen::Routing::ISegment.
virtual NXOpen::Routing::ConvertLinearToEccentricLinear NXOpen::Routing::LineSegment::ConvertLinearToEccentricLinear | ( | ) | [virtual] |
Is line segment converted to eccentric line segment?
Implements NXOpen::Routing::ISegment.
virtual void NXOpen::Routing::LineSegment::DeleteCharacterstics | ( | NXOpen::Routing::CharacteristicList * | values | ) | [virtual] |
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")
values | values |
Implements NXOpen::Routing::ICharacteristic.
virtual NXOpen::Curve* NXOpen::Routing::LineSegment::FollowCurve | ( | ) | [virtual] |
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.
virtual std::vector<NXOpen::Routing::Electrical::CableDevice *> NXOpen::Routing::LineSegment::GetCableDevices | ( | ) | [virtual] |
Returns Routing::Electrical::CableDevice objects from Routing::ISegment .
Implements NXOpen::Routing::ISegment.
virtual std::vector<NXOpen::Routing::Electrical::CablewaysLayoutView *> NXOpen::Routing::LineSegment::GetCablewaysLayoutViews | ( | ) | [virtual] |
Returns Routing::Electrical::CablewaysLayoutView objects from the Routing::ISegment .
Implements NXOpen::Routing::ISegment.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::LineSegment::GetCharacteristics | ( | ) | [virtual] |
Get all of the characteristics values on the this object.
Implements NXOpen::Routing::ICharacteristic.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::LineSegment::GetDestinationCharacteristics | ( | ) | [virtual] |
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
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")
startPoint | Location of end 0 in ABS coordinates |
endPoint | Location of end 1 in ABS coordinates |
Implements NXOpen::Routing::ISegment.
virtual void NXOpen::Routing::LineSegment::GetEndRcps | ( | NXOpen::Routing::ControlPoint ** | startRcp, |
NXOpen::Routing::ControlPoint ** | endRcp | ||
) | [virtual] |
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")
startRcp | RCP defining start of segment |
endRcp | RCP 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.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
virtual NXOpen::Routing::Eccentric NXOpen::Routing::LineSegment::GetIsEccentricSegment | ( | ) | [virtual] |
Is given segment a eccentric segment?
Implements NXOpen::Routing::ISegment.
virtual NXOpen::Routing::Interior NXOpen::Routing::LineSegment::GetIsSegmentInterior | ( | ) | [virtual] |
Query if a segment is interior to any part.
Implements NXOpen::Routing::ISegment.
virtual NXOpen::Routing::Terminal NXOpen::Routing::LineSegment::GetIsTerminalSegment | ( | ) | [virtual] |
Is given segment a terminal segment?
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.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
virtual std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::LineSegment::GetSegmentAllStocks | ( | ) | [virtual] |
Returns Routing::Stock as well as Routing::Overstock objects from the Routing::ISegment .
Implements NXOpen::Routing::ISegment.
virtual std::vector<NXOpen::Routing::Stock *> NXOpen::Routing::LineSegment::GetSegmentStock | ( | ) | [virtual] |
Returns all stocks that directly reference this segment as part of the path defining the stock.
Implements NXOpen::Routing::ISegment.
virtual NXString NXOpen::Routing::LineSegment::GetStringCharacteristic | ( | const NXString & | name | ) | [virtual] |
Get the value of a string characteristic associated with the input name.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
bool NXOpen::Routing::LineSegment::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.
Both line segments must not be occurrences.
object | Other object |
Returns whether or not a distance constraint exists that constrains the distance between the two end control points of this line segment.
NXOpen::Positioning::Constraint* NXOpen::Routing::LineSegment::LockAngle | ( | NXOpen::NXObject * | object, |
bool | logicalConsOnly | ||
) |
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.
object | Other object. |
logicalConsOnly | if 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.
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")
name | NOTE: The full Unicode character set is not supported for this parameter. |
value | value |
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")
name | NOTE: The full Unicode character set is not supported for this parameter. |
value | value |
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")
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.
virtual void NXOpen::Routing::LineSegment::SetCharacteristics | ( | NXOpen::Routing::CharacteristicList * | values | ) | [virtual] |
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")
values | values |
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")
startPoint | New location of end 0 in ABS coordinates |
endPoint | New location of end 1 in ABS coordinates |
Implements NXOpen::Routing::ISegment.
virtual void NXOpen::Routing::LineSegment::SetEndRcps | ( | NXOpen::Routing::ControlPoint * | startRcp, |
NXOpen::Routing::ControlPoint * | endRcp | ||
) | [virtual] |
Created in NX4.0.0.
License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
startRcp | RCP defining start of segment |
endRcp | RCP defining end of segment |
Implements NXOpen::Routing::ISegment.
virtual void NXOpen::Routing::LineSegment::SetIsTerminalSegment | ( | NXOpen::Routing::Terminal | isTerminal | ) | [virtual] |
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")
isTerminal | Set as terminal segment? |
Implements NXOpen::Routing::ISegment.
virtual void NXOpen::Routing::LineSegment::SetSegmentInteriorPart | ( | NXOpen::Assemblies::Component * | interiorPart | ) | [virtual] |
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")
interiorPart | Part segment interior? |
Implements NXOpen::Routing::ISegment.
void NXOpen::Routing::LineSegment::UnlockAngle | ( | NXOpen::NXObject * | object | ) |
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")
object | Other 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")