Represents a line segment. More...

Inheritance diagram for NXOpen.Routing.LineSegment:

Public Member Functions
unsafe NXOpen.Routing.ConvertEccentricLinearToLinear	ConvertEccentricLinearToLinear ()
	Is line segment eccentric converted to line segment? More...

unsafe NXOpen.Routing.ConvertLinearToEccentricLinear	ConvertLinearToEccentricLinear ()
	Is line segment converted to eccentric line segment? More...

unsafe void	DeleteCharacterstics (NXOpen.Routing.CharacteristicList values)
	Removes the input list of characteristics from this object. More...

unsafe NXOpen.Routing.Electrical.CableDevice[]	GetCableDevices ()
	Returns NXOpen.Routing.Electrical.CableDevice objects from NXOpen.Routing.ISegment . More...

unsafe NXOpen.Routing.Electrical.CablewaysLayoutView[]	GetCablewaysLayoutViews ()
	Returns NXOpen.Routing.Electrical.CablewaysLayoutView objects from the NXOpen.Routing.ISegment . More...

unsafe NXOpen.Routing.CharacteristicList	GetCharacteristics ()
	Get all of the characteristics values on the this object. More...

unsafe NXOpen.Routing.CharacteristicList	GetDestinationCharacteristics ()
	Returns the destination characteristics from the input object. More...

unsafe void	GetEndPoints (out NXOpen.Point3d startPoint, out NXOpen.Point3d endPoint)
	Get the current location of the segment ends in ABS coordinates. More...

unsafe void	GetEndRcps (out NXOpen.Routing.ControlPoint startRcp, out NXOpen.Routing.ControlPoint endRcp)
	Return of segment end control points. More...

unsafe string	GetGuid ()
	Returns the Globally Unique Identifier (GUID) for this segment. More...

unsafe int	GetIntegerCharacteristic (string name)
	Get the value of an integer characteristic associated with the input name. More...

unsafe NXOpen.Routing.Eccentric	GetIsEccentricSegment ()
	Is given segment a eccentric segment? More...

unsafe NXOpen.Routing.Interior	GetIsSegmentInterior ()
	Query if a segment is interior to any part More...

unsafe NXOpen.Routing.Terminal	GetIsTerminalSegment ()
	Is given segment a terminal segment? More...

unsafe double	GetRealCharacteristic (string name)
	Get the value of a real characteristic associated with the input name. More...

unsafe NXOpen.Routing.Stock[]	GetSegmentAllStocks ()
	Returns NXOpen.Routing.Stock as well as NXOpen.Routing.Overstock objects from the NXOpen.Routing.ISegment . More...

unsafe NXOpen.Routing.Stock[]	GetSegmentStock ()
	Returns all stocks that directly reference this segment as part of the path defining the stock. More...

unsafe string	GetStringCharacteristic (string name)
	Get the value of a string characteristic associated with the input name. More...

unsafe 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. More...

unsafe bool	IsLengthLocked ()
	Returns whether or not a distance constraint exists that constrains the distance between the two end control points of this line segment. More...

unsafe 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. More...

unsafe NXOpen.Positioning.Constraint	LockLength ()
	Adds a constraint to maintain the length of this line segment. More...

unsafe void	SetCharacteristic (string 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. More...

unsafe void	SetCharacteristic (string 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. More...

unsafe void	SetCharacteristic (string name, string 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. More...

unsafe void	SetCharacteristic2 (string title, int value)
	Sets or creates an integer type attribute associated with the input title. More...

unsafe void	SetCharacteristic2 (string title, double value)
	Sets or creates a double type attribute associated with the input title. More...

unsafe void	SetCharacteristic2 (string title, string value)
	Sets or creates a string type type attribute associated with the input title. More...

unsafe void	SetCharacteristics (NXOpen.Routing.CharacteristicList values)
	Set all of the characteristics values on this object. More...

unsafe void	SetCharacteristics2 (NXOpen.Routing.CharacteristicList values)
	Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...

unsafe void	SetEndPoints (NXOpen.Point3d startPoint, NXOpen.Point3d endPoint)
	Set the current location of the segment ends in ABS coordinates. More...

unsafe void	SetEndRcps (NXOpen.Routing.ControlPoint startRcp, NXOpen.Routing.ControlPoint endRcp)
	More...

unsafe void	SetIsTerminalSegment (NXOpen.Routing.Terminal isTerminal)
	Set given segment to be a terminal segment? More...

unsafe void	SetSegmentInteriorPart (NXOpen.Assemblies.Component interiorPart)
	Set a segment to be interior to supplied part More...

unsafe void	UnlockAngle (NXOpen.NXObject @object)
	Removes the angle, parallel or perpendicular constraint that constrains the angle between this line segment and the input object. More...

unsafe void	UnlockLength ()
	Removes the distance constraint that constrains the distance between the two end control points of this line segment. More...

Public Member Functions inherited from NXOpen.Line
unsafe void	SetEndPoint (NXOpen.Point3d endPoint)
	Sets the end point of the line More...

unsafe void	SetEndpoints (NXOpen.Point3d startPoint, NXOpen.Point3d endPoint)
	Sets the start and end points of the line More...

unsafe void	SetStartPoint (NXOpen.Point3d startPoint)
	Sets the start point of the line More...

Public Member Functions inherited from NXOpen.Curve
unsafe NXOpen.Drawings.DraftingCurveInfo	GetDraftingCurveInfo ()
	Creates new DraftingCurveInfo object More...

unsafe double	GetLength ()
	Returns the length of the object More...

Public Member Functions inherited from NXOpen.SmartObject
unsafe void	Evaluate ()
	Evaluate a smart object. More...

unsafe void	ProtectFromDelete ()
	Protects the SmartObject from being deleted if any referencing objects are deleted. More...

unsafe void	ReleaseDeleteProtection ()
	Removes delete protection from the SmartObject. More...

unsafe void	RemoveParameters ()
	Removes the smart object parameters. More...

unsafe void	ReplaceParameters (NXOpen.SmartObject otherSo)
	Edit a smart object by replacing its parameters using parameters of other smart object of the same class. More...

unsafe void	SetVisibility (NXOpen.SmartObject.VisibilityOption visibility)
	Sets the visibility. More...

Public Member Functions inherited from NXOpen.DisplayableObject
unsafe void	Blank ()
	Blanks the object. More...

unsafe void	Highlight ()
	Highlights the object. More...

unsafe void	RedisplayObject ()
	Redisplays the object in all views. More...

unsafe void	RemoveViewDependency ()
	Remove dependency on all views from an object. More...

unsafe void	SetNameLocation (NXOpen.Point3d location)
	Sets the location of the object's name. More...

unsafe void	Unblank ()
	Unblanks the object. More...

unsafe void	Unhighlight ()
	Unhighlights the object. More...

Public Member Functions inherited from NXOpen.NXObject
unsafe NXOpen.AttributeIterator	CreateAttributeIterator ()
	Create an attribute iterator More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type)
	Deletes all attributes of a specific type. More...

unsafe void	DeleteAllAttributesByType (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes all attributes of a specific type with the option to update or not. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title)
	Deletes an attribute by type and title. More...

unsafe void	DeleteAttributeByTypeAndTitle (NXOpen.NXObject.AttributeType type, string title, NXOpen.Update.Option option)
	Deletes an attribute by type and title with the option to update or not. More...

unsafe void	DeleteUserAttribute (NXOpen.NXObject.AttributeType type, string title, bool deleteEntireArray, NXOpen.Update.Option option)
	Deletes the first attribute encountered with the given Type, Title. More...

unsafe void	DeleteUserAttributes (NXOpen.AttributeIterator iterator, NXOpen.Update.Option option)
	Deletes the attributes on the object, if any, that satisfy the given iterator More...

unsafe void	DeleteUserAttributes (NXOpen.NXObject.AttributeType type, NXOpen.Update.Option option)
	Deletes the attributes encountered with the given Type with option to update or not. More...

unsafe NXOpen.INXObject	FindObject (string journalIdentifier)
	Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetAttributeTitlesByType (NXOpen.NXObject.AttributeType type)
	Gets all the attribute titles of a specific type. More...

unsafe bool	GetBooleanUserAttribute (string title, int index)
	Gets a boolean attribute by Title and array Index. More...

unsafe NXOpen.NXObject.ComputationalTime	GetComputationalTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe int	GetIntegerAttribute (string title)
	Gets an integer attribute by title. More...

unsafe int	GetIntegerUserAttribute (string title, int index)
	Gets an integer attribute by Title and array Index. More...

unsafe bool	GetNextUserAttribute (NXOpen.AttributeIterator iterator, out NXOpen.NXObject.AttributeInformation info)
	Gets the next attribute encountered on the object, if any, that satisfies the given iterator. More...

unsafe string	GetPdmReferenceAttributeValue (string attributeTitle)
	Gets the value of PDM Reference attribute for given object. More...

unsafe double	GetRealAttribute (string title)
	Gets a real attribute by title. More...

unsafe double	GetRealUserAttribute (string title, int index)
	Gets a real attribute by Title and array Index. More...

unsafe string	GetReferenceAttribute (string title)
	Gets the reference string (not the calculated value) of a string attribute that uses a reference string. More...

unsafe string	GetStringAttribute (string title)
	Gets a string attribute value by title. More...

unsafe string	GetStringUserAttribute (string title, int index)
	Gets a string attribute by Title and array Index. More...

unsafe string	GetTimeAttribute (NXOpen.NXObject.DateAndTimeFormat format, string title)
	Gets a time attribute by title. More...

unsafe string	GetTimeUserAttribute (string title, int index)
	Gets a time attribute by Title and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation	GetUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttribute (string title, bool includeUnset, bool addStringValues, NXOpen.NXObject.AttributeType type)
	Gets the first attribute (or attribute array) encountered on the object, if any, with a given Title and Type. More...

unsafe string	GetUserAttributeAsString (string title, NXOpen.NXObject.AttributeType type, int index)
	Gets the first attribute encountered on the object, if any, with a given title, type and array index. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.AttributeIterator iterator, bool countArrayAsOneAttribute)
	Gets the count of set attributes on the object, if any, that satisfy the given iterator. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type)
	Gets the count of set attributes on the object, if any, of the given type. More...

unsafe int	GetUserAttributeCount (NXOpen.NXObject.AttributeType type, bool includeUnset, bool countArrayAsOneAttribute)
	Gets the count of attributes on the object, if any, of the given type. More...

unsafe bool	GetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type)
	Determine the lock of the given attribute. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (NXOpen.AttributeIterator iterator)
	Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes ()
	Gets all the attributes that have been set on the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset)
	Gets all the attributes of the given object. More...

unsafe NXOpen.NXObject.AttributeInformation[]	GetUserAttributes (bool includeUnset, bool addStringValues)
	Gets all the attributes of the given object. More...

unsafe string[]	GetUserAttributesAsStrings ()
	Gets all the attributes that have been set on the given object. More...

unsafe int	GetUserAttributeSize (string title, NXOpen.NXObject.AttributeType type)
	Gets the size of the first attribute encountered on the object, if any, with a given Title and Type. More...

unsafe NXOpen.NXObject[]	GetUserAttributeSourceObjects ()
	Returns an array of objects from which this object presents attributes. More...

unsafe bool	HasUserAttribute (NXOpen.AttributeIterator iterator)
	Determines if an attribute exists on the object, that satisfies the given iterator More...

unsafe bool	HasUserAttribute (string title, NXOpen.NXObject.AttributeType type, int index)
	Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. More...

unsafe void	Print ()
	Prints a representation of this object to the system log file. More...

unsafe void	SetAttribute (string title, int value)
	Creates or modifies an integer attribute. More...

unsafe void	SetAttribute (string title, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, double value)
	Creates or modifies a real attribute. More...

unsafe void	SetAttribute (string title, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetAttribute (string title, string value)
	Creates or modifies a string attribute. More...

unsafe void	SetAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetAttribute (string title)
	Creates or modifies a null attribute which is an attribute with a title and no value. More...

unsafe void	SetAttribute (string title, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetBooleanUserAttribute (string title, int index, bool value, NXOpen.Update.Option option)
	Creates or modifies a boolean attribute with the option to update or not. More...

unsafe void	SetName (string name)
	Sets the custom name of the object. More...

unsafe void	SetPdmReferenceAttribute (string attributeTitle, string attributeValue)
	Sets the value of PDM Reference attribute on the object. More...

unsafe void	SetReferenceAttribute (string title, string value)
	Creates or modifies a string attribute which uses a reference string. More...

unsafe void	SetReferenceAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute which uses a reference string, with the option to update or not. More...

unsafe void	SetTimeAttribute (string title, string value)
	Creates or modifies a time attribute. More...

unsafe void	SetTimeAttribute (string title, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetTimeUserAttribute (string title, int index, NXOpen.NXObject.ComputationalTime value, NXOpen.Update.Option option)
	Creates or modifies a time attribute with the option to update or not. More...

unsafe void	SetUserAttribute (NXOpen.NXObject.AttributeInformation info, NXOpen.Update.Option option)
	Creates or modifies an attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, int value, NXOpen.Update.Option option)
	Creates or modifies an integer attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, double value, NXOpen.Update.Option option)
	Creates or modifies a real attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, string value, NXOpen.Update.Option option)
	Creates or modifies a string attribute with the option to update or not. More...

unsafe void	SetUserAttribute (string title, int index, NXOpen.Update.Option option)
	Creates or modifies a null attribute with the option to update or not. More...

unsafe void	SetUserAttributeLock (string title, NXOpen.NXObject.AttributeType type, bool @lock)
	Lock or unlock the given attribute. More...

Public Member Functions inherited from NXOpen.TaggedObject
void	PrintTestData (String variableName)
	<exclude> More...

void	PrintTestData (String variableName, int lineNumber)
	<exclude> More...

override string	ToString ()
	Returns a String that represents the current Object. More...

Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl	AsyncProcessMessage (IMessage msg, IMessageSink replySink)
	Asynchronously processes the given message. More...

IMessage	SyncProcessMessage (IMessage msg)
	Synchronously processes the given message. More...

Properties
unsafe NXOpen.Curve	FollowCurve `[get]`
	Returns the segment follow curve. More...

unsafe double	Length `[get]`
	Returns the length of the segment. More...

Properties inherited from NXOpen.Line
unsafe NXOpen.Point3d	EndPoint `[get]`
	Returns the end point of the line More...

unsafe NXOpen.Point3d	StartPoint `[get]`
	Returns the start point of the line More...

Properties inherited from NXOpen.Curve
unsafe bool	IsReference `[get]`
	Returns the reference state of a curve More...

Properties inherited from NXOpen.SmartObject
unsafe NXOpen.SmartObject.UpdateOption	Update `[get]`
	Returns the update option. More...

unsafe NXOpen.SmartObject.VisibilityOption	Visibility `[get]`
	Returns the visibility. More...

Properties inherited from NXOpen.DisplayableObject
unsafe int	Color `[get, set]`
	Returns or sets the color of the object. More...

unsafe bool	IsBlanked `[get]`
	Returns the blank status of this object. More...

unsafe int	Layer `[get, set]`
	Returns or sets the layer that the object is in. More...

unsafe NXOpen.DisplayableObject.ObjectFont	LineFont `[get, set]`
	Returns or sets the line font of the object. More...

unsafe NXOpen.DisplayableObject.ObjectWidth	LineWidth `[get, set]`
	Returns or sets the line width of the object. More...

unsafe NXOpen.Point3d	NameLocation `[get]`
	Returns the location of the object's name. More...

Properties inherited from NXOpen.NXObject
unsafe bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

unsafe string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

unsafe string	Name `[get]`
	Returns the custom name of the object. More...

unsafe NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

unsafe NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

unsafe NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.TaggedObject
Tag	Tag `[get]`
	Returns the tag of this object. More...

Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink	NextSink `[get]`
	Gets the next message sink in the sink chain. More...

Properties inherited from NXOpen.INXObject
bool	IsOccurrence `[get]`
	Returns whether this object is an occurrence or not. More...

string	JournalIdentifier `[get]`
	Returns the identifier that would be recorded in a journal for this object. More...

string	Name `[get]`
	Returns the custom name of the object. More...

NXOpen.Assemblies.Component	OwningComponent `[get]`
	Returns the owning component, if this object is an occurrence. More...

NXOpen.BasePart	OwningPart `[get]`
	Returns the owning part of this object More...

NXOpen.INXObject	Prototype `[get]`
	Returns the prototype of this object if it is an occurrence. More...

Properties inherited from NXOpen.Routing.ISegment
NXOpen.Curve	FollowCurve `[get]`
	Returns the segment follow curve. More...

double	Length `[get]`
	Returns the length of the segment. More...

Additional Inherited Members
Public Types inherited from NXOpen.SmartObject
enum	UpdateOption { DontUpdate, WithinModeling, AfterModeling, AfterParentBody, Mixed }
	Specifies when the smart object updates. More...

enum	VisibilityOption { Invisible, Visible, VisibleIfParentInvisible }
	Specifies the smart object visibility. More...

Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a line segment.

To obtain an instance of this class use NXOpen.Routing.LineSegmentCollection

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.Routing.ConvertEccentricLinearToLinear NXOpen.Routing.LineSegment.ConvertEccentricLinearToLinear ( )

inline

Is line segment eccentric converted to line segment?

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Is line segment eccentric converted to line segment?

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.ConvertLinearToEccentricLinear NXOpen.Routing.LineSegment.ConvertLinearToEccentricLinear ( )

inline

Is line segment converted to eccentric line segment?

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Is line segment converted to eccentric line segment?

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.DeleteCharacterstics ( NXOpen.Routing.CharacteristicList values )

inline

Removes the input list of characteristics from this object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

values

Implements NXOpen.Routing.ICharacteristic.

unsafe NXOpen.Routing.Electrical.CableDevice [] NXOpen.Routing.LineSegment.GetCableDevices ( )

inline

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

Created in NX7.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of cable devices.

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.Electrical.CablewaysLayoutView [] NXOpen.Routing.LineSegment.GetCablewaysLayoutViews ( )

inline

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

Created in NX7.5.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of cableways layout views.

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.LineSegment.GetCharacteristics ( )

inline

Get all of the characteristics values on the this object.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.LineSegment.GetDestinationCharacteristics ( )

inline

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.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.GetEndPoints	(	out NXOpen.Point3d	startPoint,
		out NXOpen.Point3d	endPoint
	)

inline

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

startPoint	Location of end 0 in ABS coordinates
endPoint	Location of end 1 in ABS coordinates

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.GetEndRcps	(	out NXOpen.Routing.ControlPoint	startRcp,
		out NXOpen.Routing.ControlPoint	endRcp
	)

inline

Return of segment end control points.

The NXOpen.Routing.ControlPoint defines an end of a segment

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

startRcp	RCP defining start of segment
endRcp	RCP defining end of segment

Implements NXOpen.Routing.ISegment.

unsafe string NXOpen.Routing.LineSegment.GetGuid ( )

inline

Returns the Globally Unique Identifier (GUID) for this segment.

Created in NX8.0.3

License requirements: routing_base ("Routing Basic")

Returns: The GUID for this segment.

unsafe int NXOpen.Routing.LineSegment.GetIntegerCharacteristic ( string name )

inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe NXOpen.Routing.Eccentric NXOpen.Routing.LineSegment.GetIsEccentricSegment ( )

inline

Is given segment a eccentric segment?

Created in NX8.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Is segment a eccentric segment?

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.Interior NXOpen.Routing.LineSegment.GetIsSegmentInterior ( )

inline

Query if a segment is interior to any part

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Is segment interior?

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.Terminal NXOpen.Routing.LineSegment.GetIsTerminalSegment ( )

inline

Is given segment a terminal segment?

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Is segment a terminal segment?

Implements NXOpen.Routing.ISegment.

unsafe double NXOpen.Routing.LineSegment.GetRealCharacteristic ( string name )

inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe NXOpen.Routing.Stock [] NXOpen.Routing.LineSegment.GetSegmentAllStocks ( )

inline

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

Created in NX5.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns: Array of stocks/overstocks.

Implements NXOpen.Routing.ISegment.

unsafe NXOpen.Routing.Stock [] NXOpen.Routing.LineSegment.GetSegmentStock ( )

inline

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

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Returns

Implements NXOpen.Routing.ISegment.

unsafe string NXOpen.Routing.LineSegment.GetStringCharacteristic ( string name )

inline

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

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

name

Returns

Implements NXOpen.Routing.ICharacteristic.

unsafe bool NXOpen.Routing.LineSegment.IsAngleLocked ( NXOpen.NXObject @ object )

inline

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.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters

object Other object

Returns: Whether or not the angle is locked.

unsafe bool NXOpen.Routing.LineSegment.IsLengthLocked ( )

inline

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

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns: Whether or not the length is locked.

unsafe NXOpen.Positioning.Constraint NXOpen.Routing.LineSegment.LockAngle	(	NXOpen.NXObject @	object,
		bool	logicalConsOnly
	)

inline

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 NXOpen.Positioning.Constraint for a description of angle, parallel and perpendicular constraints.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters

object	Other object.
logicalConsOnly	if true, only create perpendicular or parallel constraints, if false will also create angle constraints.

Returns: The new or existing angle constraint.

unsafe NXOpen.Positioning.Constraint NXOpen.Routing.LineSegment.LockLength ( )

inline

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 NXOpen.Routing.ControlPoint objects of this line segment. See NXOpen.Positioning.Constraint for a description of distance constraints.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns: The new or existing distance constraint between the end control points.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic	(	string	name,
		int	value
	)

inline

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

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic	(	string	name,
		double	value
	)

inline

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

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic	(	string	name,
		string	value
	)

inline

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

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristic2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

name
value

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic2	(	string	title,
		int	value
	)

inline

Sets or creates an integer type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic2	(	string	title,
		double	value
	)

inline

Sets or creates a double type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristic2	(	string	title,
		string	value
	)

inline

Sets or creates a string type type attribute associated with the input title.

creating a new attribute if one doesn't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit a part attribute on the stock part. For legacy parts where the attribute is on the stock component, the attribute will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit an attribute on the corresponding instance. For legacy parts where the attribute is on the component, the attribute will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create an attribute on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

title	Unique title for the Attribute or Characteristic
value	New Value to be set on the Attribute

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristics ( NXOpen.Routing.CharacteristicList values )

inline

Set all of the characteristics values on this object.

Created in NX4.0.0

Deprecated in NX11.0.0. Use NXOpen.Routing.ICharacteristic.SetCharacteristics2 instead.

License requirements: routing_base ("Routing Basic")

Parameters

values

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetCharacteristics2 ( NXOpen.Routing.CharacteristicList values )

inline

Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already.

If the method is called on a stock Assemblies.Component , the method will create or edit part attributes on the stock part. For legacy parts where the attributes are on the stock component, the attributes will be moved to the stock part.

If the method is called on a non-stock Assemblies.Component , the method will create or edit attributes on the corresponding instance. For legacy parts where the attribute is on the component, the attributes will be moved to the corresponding instance.

If the method is called on any non-component object, the method will access or create attributes on the object itself.

Created in NX11.0.0

License requirements: routing_base ("Routing Basic")

Parameters

values NXOpen.Routing.CharacteristicList having the titles, types and values of Attributes to be set

Implements NXOpen.Routing.ICharacteristic.

unsafe void NXOpen.Routing.LineSegment.SetEndPoints	(	NXOpen.Point3d	startPoint,
		NXOpen.Point3d	endPoint
	)

inline

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_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

startPoint	New location of end 0 in ABS coordinates
endPoint	New location of end 1 in ABS coordinates

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.SetEndRcps	(	NXOpen.Routing.ControlPoint	startRcp,
		NXOpen.Routing.ControlPoint	endRcp
	)

inline

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

startRcp	RCP defining start of segment
endRcp	RCP defining end of segment

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.SetIsTerminalSegment ( NXOpen.Routing.Terminal isTerminal )

inline

Set given segment to be a terminal segment?

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

isTerminal Set as terminal segment?

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.SetSegmentInteriorPart ( NXOpen.Assemblies.Component interiorPart )

inline

Set a segment to be interior to supplied part

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

Parameters

interiorPart Part segment interior?

Implements NXOpen.Routing.ISegment.

unsafe void NXOpen.Routing.LineSegment.UnlockAngle ( NXOpen.NXObject @ object )

inline

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 NXOpen.Update.DoUpdate afterwards to ensure that the constraint is fully deleted.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters

object Other object

unsafe void NXOpen.Routing.LineSegment.UnlockLength ( )

inline

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

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

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Property Documentation

unsafe NXOpen.Curve NXOpen.Routing.LineSegment.FollowCurve

get

Returns the segment follow curve.

NULL object indicates segment has no follow curve

Created in NX4.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

unsafe double NXOpen.Routing.LineSegment.Length

get

Returns the length of the segment.

Created in NX11.0.0

License requirements: routing_advanced ("Routing Advanced"), routing_base ("Routing Basic")

The documentation for this class was generated from the following file:

Routing_LineSegment.cs

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

Property Documentation