NX Open C++ Reference Guide
|
The Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments. More...
Public Member Functions | |
void | AddSegments (const std::vector< NXOpen::Curve * > &segments) |
Adds new segments to this object. | |
void | AlignStock (const NXOpen::Vector3d &vector) |
Align stock to new rotation vector. | |
void | ColorBodies () |
Colors the solid bodies of the stock based on the COLOR characteristic specified in the Routing::StockData of the stock. | |
virtual void | DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values) |
Removes the input list of characteristics from this object. | |
void | EnableFeatures () |
Makes the stock "featurable" by generating a sweep feature over every segment of the stock, with a boolean feature uniting all of the sweeps to form a single body. | |
NXOpen::Routing::Anchor * | GetAnchor () |
Gets the Routing::Anchor that currently modifies the profile for the stock. | |
virtual NXOpen::Routing::CharacteristicList * | GetCharacteristics () |
Get all of the characteristics values on the this object. | |
NXOpen::Assemblies::Component * | GetComponent () |
Returns the Assemblies::Component created and controlled by the stock for a Stock as Components stock. | |
NXOpen::Routing::CrossSection * | GetCrossSection () |
Gets the Routing::CrossSection that currently defines the profile for the stock. | |
virtual NXOpen::Routing::CharacteristicList * | GetDestinationCharacteristics () |
Returns the destination characteristics from the input object. | |
std::vector < NXOpen::Features::Feature * > | GetFeatures () |
Returns the sweep features that are created and controlled by this object. | |
NXOpen::Routing::Flip | GetFlippedStatus () |
Gets whether or not the profile is flipped. | |
virtual int | GetIntegerCharacteristic (const NXString &name) |
Get the value of an integer characteristic associated with the input name. | |
NXOpen::Routing::ComponentName | GetNameStatus () |
Returns whether or not the component associated with a Stock as Components Stock has a permanent or temporary name. | |
double | GetOriginalLength () |
Returns the original length for a stock that has been deformed (it's use is Routing::StockUseDeformed ). | |
void | GetPorts (NXOpen::Routing::StockPort **startPort, NXOpen::Routing::StockPort **endPort) |
Returns the Routing::StockPort at each end of the stock. | |
NXOpen::Routing::ProfileFrom | GetProfileEnd () |
Gets the end that defines profile. | |
virtual double | GetRealCharacteristic (const NXString &name) |
Get the value of a real characteristic associated with the input name. | |
double | GetRotationAngle () |
Gets the rotation angle applied to the profile. | |
std::vector< NXOpen::Curve * > | GetSegments () |
Gets the segments that the Routing::Stock object is placed on top of. | |
NXOpen::Routing::StockData * | GetStockData () |
Gets the Routing::StockData . | |
NXOpen::Routing::StockStyle | GetStockStyle () |
Gets the Routing::StockStyle of the Routing::Stock . | |
NXOpen::Routing::StockUse | GetStockUse () |
Returns the use of the stock. | |
virtual NXString | GetStringCharacteristic (const NXString &name) |
Get the value of a string characteristic associated with the input name. | |
double | GetTwistAngle () |
Gets the twist angle applied to the profile. | |
bool | NegateOffsetsFlag () |
Returns the negate offsets flag of this Routing::Stock . | |
void | RemoveSegments (const std::vector< NXOpen::Curve * > &segments) |
Removes segments from this object. | |
void | RenameComponent () |
Renames the component associated with a Stock as Components Stock. | |
void | RenameStockComponent (const NXString &partName) |
Renames the stock component part with given name Created in NX7.5.4. | |
void | SetAnchor (NXOpen::Routing::Anchor *anchor) |
Sets the Routing::Anchor . | |
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 | SetCrossSection (NXOpen::Routing::CrossSection *crossSection) |
Sets the Routing::CrossSection . | |
void | SetFlippedStatus (NXOpen::Routing::Flip flipped) |
Sets whether or not the profile is flipped. | |
void | SetNegateOffsetsFlag (bool offsetFlag) |
Sets the negate offsets flag of this Routing::Stock . | |
void | SetProfileEnd (NXOpen::Routing::ProfileFrom profileEnd) |
Sets the end that defines profile. | |
void | SetRotationAngle (double rotationAngle) |
Sets the rotation angle applied to the profile. | |
void | SetStockData (NXOpen::Routing::StockData *stockData) |
Sets the Routing::StockData . | |
void | SetStockStyle (NXOpen::Routing::StockStyle style) |
Sets the Routing::StockStyle of the Routing::Stock . | |
void | SetTwistAngle (double twistAngle) |
Sets the twist angle applied to the profile. | |
void | SyncComponentAttrs (bool isNewPart) |
Set the characteristics of the given stock's component so that it has the same characteristics as the Routing::Stock and its stock data. |
The Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments.
The material is defined in the Routing::StockData object. Routing::Stock consists of a Routing::StockData object, as well as references to at most one of the Routing::CrossSection and Routing::Anchor objects that are associated with that Routing::StockData .
A Routing::Stock object may exist in one of two modes ; Legacy Stock or Stock as Components Stock. Legacy Stock is modeled as a sweep feature in the work part. Stock as Components Stock is modeled as a child component (of the work part) that contains a sweep feature. Legacy Stock and Stock as Components stock cannot exist in the same part file with the exception of Bundled stock.
Stock as Components Stock creates a component file, and creates a copy of itself inside of that part file. Segments, anchors, and all other necessary information are copied into the component part file. The stock inside of the component file should not be edited or modified as it is completely controlled by the Stock as Component Stock in the work part.
Routing::Stock object that have automatically been generated by the bundling algorithm used for routing wires are Bundled stock. Bundled stocks are always created as Legacy Stocks (even in parts containing Stock as Component stocks). Any Routing::StockData object that defines a bundled stock has a type of Routing::StockDataTypeBundled . Editing the segments or the stock data of a Bundled stock may result in undefined behavior.
With the exception of stock style, there are no functional differences between the two stock types. Stock as Components Stock always uses the Routing::StockStyleDetailed style (if availble, otherwise it uses the Routing::StockStyleDetailed style) and the stocks style cannot be changed.
Creator not available in KF because transient objects are not supported.
Created in NX4.0.0.
void NXOpen::Routing::Stock::AddSegments | ( | const std::vector< NXOpen::Curve * > & | segments | ) |
Adds new segments to this object.
If the new segments (added to the old segments) do not form a single continuous path, the Routing::Stock will split so that there is a copy of this object on each continuous path formed by the input segments.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
segments | List of segments to add. Ignores any segments that are already referenced by this object. |
void NXOpen::Routing::Stock::AlignStock | ( | const NXOpen::Vector3d & | vector | ) |
Align stock to new rotation vector.
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
vector | Rotation vector. |
void NXOpen::Routing::Stock::ColorBodies | ( | ) |
Colors the solid bodies of the stock based on the COLOR characteristic specified in the Routing::StockData of the stock.
The color string can contain the name of a color, a hex string specifying the RGB values, a comma separated list of RGB integer values and a simple integer specifying the color index directly.
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
virtual void NXOpen::Routing::Stock::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.
Makes the stock "featurable" by generating a sweep feature over every segment of the stock, with a boolean feature uniting all of the sweeps to form a single body.
Features can then be applied to each individual sweep by suppressing the unite features. This will help features to survive stock splitting and merging as this ensures that no sweep feature is deleted during a merge.
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Gets the Routing::Anchor that currently modifies the profile for the stock.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Stock::GetCharacteristics | ( | ) | [virtual] |
Get all of the characteristics values on the this object.
Implements NXOpen::Routing::ICharacteristic.
Returns the Assemblies::Component created and controlled by the stock for a Stock as Components stock.
Only returns a component if the stock type is Routing::StockUseStockAsComponent .
Gets the Routing::CrossSection that currently defines the profile for the stock.
virtual NXOpen::Routing::CharacteristicList* NXOpen::Routing::Stock::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.
std::vector<NXOpen::Features::Feature *> NXOpen::Routing::Stock::GetFeatures | ( | ) |
Returns the sweep features that are created and controlled by this object.
For Stock as Components stock, the features exist in a seperate part file. For Legacy Stock the features exist in the same part as the input object.
Gets whether or not the profile is flipped.
virtual int NXOpen::Routing::Stock::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.
double NXOpen::Routing::Stock::GetOriginalLength | ( | ) |
Returns the original length for a stock that has been deformed (it's use is Routing::StockUseDeformed ).
This is the length of the original stock in the component part at the time that the deformed stock was created.
void NXOpen::Routing::Stock::GetPorts | ( | NXOpen::Routing::StockPort ** | startPort, |
NXOpen::Routing::StockPort ** | endPort | ||
) |
Returns the Routing::StockPort at each end of the stock.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Gets the end that defines profile.
virtual double NXOpen::Routing::Stock::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.
double NXOpen::Routing::Stock::GetRotationAngle | ( | ) |
Gets the rotation angle applied to the profile.
std::vector<NXOpen::Curve *> NXOpen::Routing::Stock::GetSegments | ( | ) |
Gets the segments that the Routing::Stock object is placed on top of.
Gets the Routing::StockData .
Gets the Routing::StockStyle of the Routing::Stock .
Returns the use of the stock.
virtual NXString NXOpen::Routing::Stock::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.
double NXOpen::Routing::Stock::GetTwistAngle | ( | ) |
Gets the twist angle applied to the profile.
Returns the negate offsets flag of this Routing::Stock .
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
void NXOpen::Routing::Stock::RemoveSegments | ( | const std::vector< NXOpen::Curve * > & | segments | ) |
Removes segments from this object.
If the segments of this object (after removing the input segments) do not form a single continuous path, the Routing::Stock will split so that there is a copy of this object on each continuous path. This object will delete itself inside of update if all segments are removed.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
segments | List of segments to remove. Ignores any segments that are not already referenced by this object. |
Renames the component associated with a Stock as Components Stock.
Executes the STOCK_COMPONENT_NAME plugin to determine the new name of the component. Only call on Stock as Components Stock This method is deprecated. Use Routing::Stock::RenameStockComponent instead.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
void NXOpen::Routing::Stock::RenameStockComponent | ( | const NXString & | partName | ) |
Renames the stock component part with given name
Created in NX7.5.4.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
partName | Part name to be set NOTE: The full Unicode character set is not supported for this parameter. |
void NXOpen::Routing::Stock::SetAnchor | ( | NXOpen::Routing::Anchor * | anchor | ) |
Sets the Routing::Anchor .
The given object must be one of the Routing::Anchor objects referenced by the Routing::StockData object that defines this Routing::Stock object.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
anchor | Must be referenced by the Routing::StockData associated with this Routing::Stock object. |
virtual void NXOpen::Routing::Stock::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::Stock::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::Stock::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::Stock::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::Stock::SetCrossSection | ( | NXOpen::Routing::CrossSection * | crossSection | ) |
Sets the Routing::CrossSection .
The given object must be one of the Routing::CrossSection objects referenced by the Routing::StockData object that defines this Routing::Stock object. Routing::Stock::SetStockStyle should be used (when possible) instead of this routine.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
crossSection | Must be referenced by the Routing::StockData associated with this Routing::Stock object. |
void NXOpen::Routing::Stock::SetFlippedStatus | ( | NXOpen::Routing::Flip | flipped | ) |
Sets whether or not the profile is flipped.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
flipped | flipped |
void NXOpen::Routing::Stock::SetNegateOffsetsFlag | ( | bool | offsetFlag | ) |
Sets the negate offsets flag of this Routing::Stock .
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
offsetFlag | offset flag |
void NXOpen::Routing::Stock::SetProfileEnd | ( | NXOpen::Routing::ProfileFrom | profileEnd | ) |
Sets the end that defines profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
profileEnd | profile end |
void NXOpen::Routing::Stock::SetRotationAngle | ( | double | rotationAngle | ) |
Sets the rotation angle applied to the profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
rotationAngle | The angle in radians. Valid values are 0.0 to ( 2 * Pi ). |
void NXOpen::Routing::Stock::SetStockData | ( | NXOpen::Routing::StockData * | stockData | ) |
Sets the Routing::StockData .
After setting the StockData, the caller must also make sure to set the CrossSection and Anchor so that the Routing::Stock object only references objects associated with this Routing::StockData object.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
stockData | stock data |
Sets the Routing::StockStyle of the Routing::Stock .
This may cause update to fire, and can be a time-consuming operation as it may require the building of a new sweep feature. When style is set to Routing::StockStyleNone this routine deletes the stock sweep feature. Only call on Legacy Stocks.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
style | style |
void NXOpen::Routing::Stock::SetTwistAngle | ( | double | twistAngle | ) |
Sets the twist angle applied to the profile.
See the user help documentation on Orient Stock for more information.
Created in NX4.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
twistAngle | The angle in radians. Valid values are 0.0 to ( 2 * Pi ). |
void NXOpen::Routing::Stock::SyncComponentAttrs | ( | bool | isNewPart | ) |
Set the characteristics of the given stock's component so that it has the same characteristics as the Routing::Stock and its stock data.
Created in NX5.0.0.
License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
isNewPart | Is the part new? |