The Routing BuiltInPath object stores a set of curves. More...

Inheritance diagram for NXOpen.Routing.BuiltInPath:

Public Member Functions
unsafe NXOpen.Curve[]	CreateSegments (NXOpen.Assemblies.Component partOcc)
	Creates the segments in the work part to cover any curves referenced by the Routing. More...

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

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

unsafe NXOpen.Curve[]	GetCurves ()
	Returns the array of curves referenced by the Built-In-Path object. More...

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

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

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

unsafe string	GetStringCharacteristic (string name)
	Get the value of a string characteristic associated with the input name. 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	SetCurves (NXOpen.Curve[] curves)
	Sets the array of curves referenced by the Built-In-Path 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...

Additional Inherited Members
Public Types inherited from NXOpen.NXObject
enum	AttributeType { Invalid, Null, Boolean, Integer, Real, String, Time, Reference, Any = 100 }
	Specifies attribute type. More...

enum	DateAndTimeFormat { Numeric, Textual }
	Specifies the format of the date and time attribute. More...

Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> 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.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...

Detailed Description

The Routing BuiltInPath object stores a set of curves.

Routing will attempt to create segments on top of these curves whenever an instance of the part containing the BuiltInPath is added to the assembly.

To create a new instance of this class, use NXOpen.Routing.BuiltInPathCollection.CreateBuiltInPath

Created in NX4.0.0

Member Function Documentation

unsafe NXOpen.Curve [] NXOpen.Routing.BuiltInPath.CreateSegments ( NXOpen.Assemblies.Component partOcc )

inline

Creates the segments in the work part to cover any curves referenced by the Routing.

BuiltInPath object in the component part file.

Finds the segments currently extracted from the part occurrence and creates a new segment overy every Routing.BuiltInPath curve occurrence that doesn't already have a segment.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

partOcc Component to extract segments from.

Returns: the array of Segments referenced by the BuiltInPath includes previously created segments as well.

unsafe void NXOpen.Routing.BuiltInPath.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.CharacteristicList NXOpen.Routing.BuiltInPath.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.Curve [] NXOpen.Routing.BuiltInPath.GetCurves ( )

inline

Returns the array of curves referenced by the Built-In-Path object.

These curves are in the same part as the Built-In-Path object, and are the curves extracted into the Work Part for the Routing.BuiltInPath.CreateSegments method.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Returns: the array of Curves referenced by the Built-In-Path

unsafe NXOpen.Routing.CharacteristicList NXOpen.Routing.BuiltInPath.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 int NXOpen.Routing.BuiltInPath.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 double NXOpen.Routing.BuiltInPath.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 string NXOpen.Routing.BuiltInPath.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 void NXOpen.Routing.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.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.BuiltInPath.SetCurves ( NXOpen.Curve[] curves )

inline

Sets the array of curves referenced by the Built-In-Path object.

These curves are in the same part as the Built-In-Path object, and are the curves extracted into the Work Part for the Routing.BuiltInPath.CreateSegments method.

Created in NX4.0.0

License requirements: routing_base ("Routing Basic")

Parameters

curves the array of Curves to be referenced by the Built-In-Path

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

Routing_BuiltInPath.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation