NXOpen .NET Reference
12.0.0
|
Interface for querying and setting characteristic (UG attribute values) on various routing objects. More...
Public Member Functions | |
NXOpen.Routing.CharacteristicList | GetCharacteristics () |
Get all of the characteristics values on the this object. More... | |
void | SetCharacteristics (NXOpen.Routing.CharacteristicList values) |
Set all of the characteristics values on this object. More... | |
int | GetIntegerCharacteristic (string name) |
Get the value of an integer characteristic associated with the input name. More... | |
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... | |
double | GetRealCharacteristic (string name) |
Get the value of a real characteristic associated with the input name. More... | |
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... | |
string | GetStringCharacteristic (string name) |
Get the value of a string characteristic associated with the input name. More... | |
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... | |
void | DeleteCharacterstics (NXOpen.Routing.CharacteristicList values) |
Removes the input list of characteristics from this object. More... | |
NXOpen.Routing.CharacteristicList | GetDestinationCharacteristics () |
Returns the destination characteristics from the input object. More... | |
void | SetCharacteristic2 (string title, int value) |
Sets or creates an integer type attribute associated with the input title. More... | |
void | SetCharacteristic2 (string title, double value) |
Sets or creates a double type attribute associated with the input title. More... | |
void | SetCharacteristic2 (string title, string value) |
Sets or creates a string type type attribute associated with the input title. More... | |
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... | |
Public Member Functions inherited from NXOpen.INXObject | |
NXOpen.INXObject | FindObject (string journalIdentifier) |
Finds the NXOpen.NXObject with the given identifier as recorded in a journal. More... | |
void | Print () |
Prints a representation of this object to the system log file. More... | |
void | SetName (string name) |
Sets the custom name of the object. More... | |
Additional Inherited Members | |
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... | |
Interface for querying and setting characteristic (UG attribute values) on various routing objects.
These methods should be used instead of the attribute methods on the NXObject object in order to support extra functionality such as synonym characteristics available in the Routing application.
Created in NX4.0.0
void NXOpen.Routing.ICharacteristic.DeleteCharacterstics | ( | NXOpen.Routing.CharacteristicList | values | ) |
Removes the input list of characteristics from this object.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
values |
Implemented in NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
NXOpen.Routing.CharacteristicList NXOpen.Routing.ICharacteristic.GetCharacteristics | ( | ) |
Get all of the characteristics values on the this object.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
NXOpen.Routing.CharacteristicList NXOpen.Routing.ICharacteristic.GetDestinationCharacteristics | ( | ) |
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
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
int NXOpen.Routing.ICharacteristic.GetIntegerCharacteristic | ( | string | name | ) |
Get the value of an integer characteristic associated with the input name.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
name |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
double NXOpen.Routing.ICharacteristic.GetRealCharacteristic | ( | string | name | ) |
Get the value of a real characteristic associated with the input name.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
name |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
string NXOpen.Routing.ICharacteristic.GetStringCharacteristic | ( | string | name | ) |
Get the value of a string characteristic associated with the input name.
Created in NX4.0.0
License requirements: routing_base ("Routing Basic")
name |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.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.
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")
name | |
value |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.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.
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")
name | |
value |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.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.
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")
name | |
value |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.SetCharacteristic2 | ( | string | title, |
int | value | ||
) |
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")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.SetCharacteristic2 | ( | string | title, |
double | value | ||
) |
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")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.SetCharacteristic2 | ( | string | title, |
string | value | ||
) |
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")
title | Unique title for the Attribute or Characteristic |
value | New Value to be set on the Attribute |
Implemented in NXOpen.Assemblies.Component, NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.SetCharacteristics | ( | NXOpen.Routing.CharacteristicList | values | ) |
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")
values |
Implemented in NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.
void NXOpen.Routing.ICharacteristic.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.
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")
values | NXOpen.Routing.CharacteristicList having the titles, types and values of Attributes to be set |
Implemented in NXOpen.Routing.Port, NXOpen.Routing.Stock, NXOpen.Routing.LineSegment, NXOpen.Routing.ArcSegment, NXOpen.Routing.SplineSegment, NXOpen.Routing.GapArcSegment, NXOpen.Routing.StockData, NXOpen.Routing.ControlPoint, NXOpen.Routing.CrossSection, NXOpen.Routing.BuiltInPath, NXOpen.Routing.FittingOverstock, NXOpen.Routing.Anchor, and NXOpen.Routing.RouteObject.