NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::ICharacteristic Class Referenceabstract

Interface for querying and setting characteristic (UG attribute values) on various routing objects. More...

Inheritance diagram for NXOpen::Routing::ICharacteristic:
NXOpen::INXObject NXOpen::Assemblies::Component NXOpen::Routing::BuiltInPath NXOpen::Routing::CrossSection NXOpen::Routing::FittingOverstock NXOpen::Routing::IRoutePosition NXOpen::Routing::ISegment NXOpen::Routing::RouteObject NXOpen::Routing::Stock NXOpen::Routing::StockData

Public Member Functions

virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)=0
 Removes the input list of characteristics from this object. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()=0
 Get all of the characteristics values on the this object. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()=0
 Returns the destination characteristics from the input object. More...
 
virtual int GetIntegerCharacteristic (const NXString &name)=0
 Get the value of an integer characteristic associated with the input name. More...
 
virtual int GetIntegerCharacteristic (const char *name)=0
 Get the value of an integer characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const NXString &name)=0
 Get the value of a real characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const char *name)=0
 Get the value of a real characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const NXString &name)=0
 Get the value of a string characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const char *name)=0
 Get the value of a string characteristic associated with the input name. More...
 
virtual void SetCharacteristic (const NXString &name, int value)=0
 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...
 
virtual void SetCharacteristic (const char *name, int value)=0
 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...
 
virtual void SetCharacteristic (const NXString &name, double value)=0
 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...
 
virtual void SetCharacteristic (const char *name, double value)=0
 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...
 
virtual void SetCharacteristic (const NXString &name, const NXString &value)=0
 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...
 
virtual void SetCharacteristic (const char *name, const char *value)=0
 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...
 
virtual void SetCharacteristic2 (const NXString &title, int value)=0
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, int value)=0
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, double value)=0
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, double value)=0
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, const NXString &value)=0
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, const char *value)=0
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)=0
 Set all of the characteristics values on this object. More...
 
virtual void SetCharacteristics2 (NXOpen::Routing::CharacteristicList *values)=0
 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
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual bool IsOccurrence ()=0
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()=0
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()=0
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()=0
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()=0
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()=0
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()=0
 Returns the prototype of this object if it is an occurrence. More...
 
virtual void SetName (const NXString &name)=0
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)=0
 Sets the custom name of the object. More...
 

Detailed Description

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.

Member Function Documentation

virtual void NXOpen::Routing::ICharacteristic::DeleteCharacterstics ( NXOpen::Routing::CharacteristicList values)
pure virtual
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::ICharacteristic::GetCharacteristics ( )
pure virtual
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::ICharacteristic::GetDestinationCharacteristics ( )
pure 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

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

Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual int NXOpen::Routing::ICharacteristic::GetIntegerCharacteristic ( const NXString name)
pure virtual
virtual int NXOpen::Routing::ICharacteristic::GetIntegerCharacteristic ( const char *  name)
pure virtual
virtual double NXOpen::Routing::ICharacteristic::GetRealCharacteristic ( const NXString name)
pure virtual
virtual double NXOpen::Routing::ICharacteristic::GetRealCharacteristic ( const char *  name)
pure virtual
virtual NXString NXOpen::Routing::ICharacteristic::GetStringCharacteristic ( const NXString name)
pure virtual
virtual NXString NXOpen::Routing::ICharacteristic::GetStringCharacteristic ( const char *  name)
pure virtual
virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const NXString name,
int  value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const char *  name,
int  value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const NXString name,
double  value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const char *  name,
double  value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const NXString name,
const NXString value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic ( const char *  name,
const char *  value 
)
pure 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.

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


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
namename
valuevalue

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const NXString title,
int  value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const char *  title,
int  value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const NXString title,
double  value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const char *  title,
double  value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const NXString title,
const NXString value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristic2 ( const char *  title,
const char *  value 
)
pure virtual

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
titleUnique title for the Attribute or Characteristic
valueNew 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::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.

virtual void NXOpen::Routing::ICharacteristic::SetCharacteristics ( NXOpen::Routing::CharacteristicList values)
pure virtual
virtual void NXOpen::Routing::ICharacteristic::SetCharacteristics2 ( NXOpen::Routing::CharacteristicList values)
pure virtual

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
valuesNXOpen::Routing::CharacteristicList having the titles, types and values of Attributes to be set

Implemented in NXOpen::Assemblies::Component, NXOpen::Routing::Port, NXOpen::Routing::Stock, NXOpen::Routing::LineSegment, NXOpen::Routing::ArcSegment, NXOpen::Routing::GapArcSegment, NXOpen::Routing::SplineSegment, NXOpen::Routing::ControlPoint, NXOpen::Routing::StockData, NXOpen::Routing::CrossSection, NXOpen::Routing::Anchor, NXOpen::Routing::BuiltInPath, NXOpen::Routing::FittingOverstock, and NXOpen::Routing::RouteObject.


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