NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::ICharacteristic Class Reference

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

List of all members.

Public Member Functions

virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)=0
 Removes the input list of characteristics from this object.
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()=0
 Get all of the characteristics values on the this object.
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()=0
 Returns the destination characteristics from the input object.
virtual int GetIntegerCharacteristic (const NXString &name)=0
 Get the value of an integer characteristic associated with the input name.
virtual double GetRealCharacteristic (const NXString &name)=0
 Get the value of a real characteristic associated with the input name.
virtual NXString GetStringCharacteristic (const NXString &name)=0
 Get the value of a string characteristic associated with the input name.
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.
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.
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.
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)=0
 Set all of the characteristics values on this object.

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

Removes the input list of characteristics from this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

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

Get all of the characteristics values on the this object.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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

virtual int NXOpen::Routing::ICharacteristic::GetIntegerCharacteristic ( const NXString name) [pure virtual]

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

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

virtual double NXOpen::Routing::ICharacteristic::GetRealCharacteristic ( const NXString name) [pure virtual]

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

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

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

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.

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

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.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

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

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.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
valuevalue

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

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.
Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
name
NOTE: The full Unicode character set is not supported for this parameter.
value
NOTE: The full Unicode character set is not supported for this parameter.

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

Set all of the characteristics values on this object.


Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
valuesvalues

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


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