NX Open C++ Reference Guide
|
The Routing BuiltInPath object stores a set of curves. More...
Public Member Functions | |
std::vector< NXOpen::Curve * > | CreateSegments (NXOpen::Assemblies::Component *partOcc) |
Creates the segments in the work part to cover any curves referenced by the Routing.BuiltInPath object in the component part file. | |
virtual void | DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values) |
Removes the input list of characteristics from this object. | |
virtual NXOpen::Routing::CharacteristicList * | GetCharacteristics () |
Get all of the characteristics values on the this object. | |
std::vector< NXOpen::Curve * > | GetCurves () |
Returns the array of curves referenced by the Built-In-Path object. | |
virtual NXOpen::Routing::CharacteristicList * | GetDestinationCharacteristics () |
Returns the destination characteristics from the input object. | |
virtual int | GetIntegerCharacteristic (const NXString &name) |
Get the value of an integer characteristic associated with the input name. | |
virtual double | GetRealCharacteristic (const NXString &name) |
Get the value of a real characteristic associated with the input name. | |
virtual NXString | GetStringCharacteristic (const NXString &name) |
Get the value of a string characteristic associated with the input name. | |
virtual void | SetCharacteristic (const NXString &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. | |
virtual void | SetCharacteristic (const NXString &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. | |
virtual void | SetCharacteristic (const NXString &name, const NXString &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. | |
virtual void | SetCharacteristics (NXOpen::Routing::CharacteristicList *values) |
Set all of the characteristics values on this object. | |
void | SetCurves (const std::vector< NXOpen::Curve * > &curves) |
Sets the array of curves referenced by the Built-In-Path object. |
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 Routing::BuiltInPathCollection::CreateBuiltInPath
Created in NX4.0.0.
std::vector<NXOpen::Curve *> NXOpen::Routing::BuiltInPath::CreateSegments | ( | NXOpen::Assemblies::Component * | partOcc | ) |
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.
partOcc | Component to extract segments from. |
virtual void NXOpen::Routing::BuiltInPath::DeleteCharacterstics | ( | NXOpen::Routing::CharacteristicList * | values | ) | [virtual] |
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")
values | values |
Implements NXOpen::Routing::ICharacteristic.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::BuiltInPath::GetCharacteristics | ( | ) | [virtual] |
Get all of the characteristics values on the this object.
Implements NXOpen::Routing::ICharacteristic.
std::vector<NXOpen::Curve *> NXOpen::Routing::BuiltInPath::GetCurves | ( | ) |
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.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::BuiltInPath::GetDestinationCharacteristics | ( | ) | [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
Implements NXOpen::Routing::ICharacteristic.
virtual int NXOpen::Routing::BuiltInPath::GetIntegerCharacteristic | ( | const NXString & | name | ) | [virtual] |
Get the value of an integer characteristic associated with the input name.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
virtual double NXOpen::Routing::BuiltInPath::GetRealCharacteristic | ( | const NXString & | name | ) | [virtual] |
Get the value of a real characteristic associated with the input name.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
virtual NXString NXOpen::Routing::BuiltInPath::GetStringCharacteristic | ( | const NXString & | name | ) | [virtual] |
Get the value of a string characteristic associated with the input name.
name | NOTE: The full Unicode character set is not supported for this parameter. |
Implements NXOpen::Routing::ICharacteristic.
virtual void NXOpen::Routing::BuiltInPath::SetCharacteristic | ( | const NXString & | name, |
int | value | ||
) | [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")
name | NOTE: The full Unicode character set is not supported for this parameter. |
value | value |
Implements NXOpen::Routing::ICharacteristic.
virtual void NXOpen::Routing::BuiltInPath::SetCharacteristic | ( | const NXString & | name, |
double | value | ||
) | [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")
name | NOTE: The full Unicode character set is not supported for this parameter. |
value | value |
Implements NXOpen::Routing::ICharacteristic.
virtual void NXOpen::Routing::BuiltInPath::SetCharacteristic | ( | const NXString & | name, |
const NXString & | value | ||
) | [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")
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. |
Implements NXOpen::Routing::ICharacteristic.
virtual void NXOpen::Routing::BuiltInPath::SetCharacteristics | ( | NXOpen::Routing::CharacteristicList * | values | ) | [virtual] |
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")
values | values |
Implements NXOpen::Routing::ICharacteristic.
void NXOpen::Routing::BuiltInPath::SetCurves | ( | const std::vector< NXOpen::Curve * > & | curves | ) |
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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
curves | the array of Curves to be referenced by the Built-In-Path |