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

A Routing::StockData contains the various profiles, characteristic information, Routing::Anchor and other attributes that define Routing::Stock objects. More...

Inheritance diagram for NXOpen::Routing::StockData:
NXOpen::NXObject NXOpen::Routing::ICharacteristic NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Member Functions

virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)
 Removes the input list of characteristics from this object.
std::vector
< NXOpen::Routing::Anchor * > 
GetAnchors ()
 Gets the list of Routing::Anchor objects associated with this Routing::StockData .
std::vector
< NXOpen::Routing::StockData * > 
GetBundledStockDatas ()
 Returns all of the Routing::StockData that were used to build this object by the bundling algorithm.
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object.
std::vector
< NXOpen::Routing::CrossSection * > 
GetCrossSections ()
 Gets the list of Routing::CrossSection objects associated with this Routing::StockData .
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.
NXOpen::Routing::StockDataType GetIsBundled ()
 Returns whether or not the Routing::StockData is used in the bundling of wires or not.
NXOpen::Routing::AnchorGetNamedAnchor (const NXString &anchorName)
 Returns the Routing::Anchor which is part of the Routing::StockData , given the anchors name.
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name.
std::vector
< NXOpen::Routing::Stock * > 
GetStocks ()
 Returns all of the Routing::Stock objects that use this Routing::StockData object.
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name.
NXOpen::Routing::CrossSectionGetStyledCross (NXOpen::Routing::StockStyle stockStyle)
 Returns the Routing::CrossSection which is part of the Routing::StockData , given the cross section style.
void SetAnchors (const std::vector< NXOpen::Routing::Anchor * > &anchors)
 Sets the list of Routing::Anchor objects associated with this Routing::StockData .
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 SetCrossSections (const std::vector< NXOpen::Routing::CrossSection * > &crossSections)
 Sets the list of Routing::CrossSection objects associated with this Routing::StockData .

Detailed Description

A Routing::StockData contains the various profiles, characteristic information, Routing::Anchor and other attributes that define Routing::Stock objects.

Each Routing::Stock has exactly one Routing::StockData associated with it. All Routing::CrossSection and Routing::Anchor objects used in a Routing::Stock object must come from the Routing::StockData associated with that Routing::Stock object.
Creator not available in KF because transient objects are not supported.

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

Implements NXOpen::Routing::ICharacteristic.

Gets the list of Routing::Anchor objects associated with this Routing::StockData .

There should be no more than one Routing::Anchor with the same name.

Returns:
The list of Routing::Anchor objects.
Created in NX4.0.0.

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

Returns all of the Routing::StockData that were used to build this object by the bundling algorithm.

Only returns valid output if Routing::StockData::GetIsBundled returns Routing::StockDataTypeBundled .

Returns:

Created in NX4.0.0.

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

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")

Implements NXOpen::Routing::ICharacteristic.

Gets the list of Routing::CrossSection objects associated with this Routing::StockData .

There should be no more than one Routing::CrossSection of any particular Routing::StockStyle (and no Routing::CrossSection with a style of Routing::StockStyleNone ).

Returns:
The list of Routing::CrossSection objects.
Created in NX4.0.0.

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

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")

Implements NXOpen::Routing::ICharacteristic.

virtual int NXOpen::Routing::StockData::GetIntegerCharacteristic ( const NXString name) [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.

Implements NXOpen::Routing::ICharacteristic.

Returns whether or not the Routing::StockData is used in the bundling of wires or not.

Returns:

Created in NX4.0.0.

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

Returns the Routing::Anchor which is part of the Routing::StockData , given the anchors name.

Returns:

Created in NX5.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Parameters:
anchorName
NOTE: The full Unicode character set is not supported for this parameter.
virtual double NXOpen::Routing::StockData::GetRealCharacteristic ( const NXString name) [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.

Implements NXOpen::Routing::ICharacteristic.

Returns all of the Routing::Stock objects that use this Routing::StockData object.

Returns:

Created in NX4.0.0.

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

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.

Implements NXOpen::Routing::ICharacteristic.

Returns the Routing::CrossSection which is part of the Routing::StockData , given the cross section style.

Returns:

Created in NX5.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
Parameters:
stockStylestock style
void NXOpen::Routing::StockData::SetAnchors ( const std::vector< NXOpen::Routing::Anchor * > &  anchors)

Sets the list of Routing::Anchor objects associated with this Routing::StockData .

There should be no more than one Routing::Anchor with the same name.
Created in NX4.0.0.

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

Parameters:
anchorsThe list of Routing::Anchor objects.
virtual void NXOpen::Routing::StockData::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")

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

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::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")

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

Implements NXOpen::Routing::ICharacteristic.

virtual void NXOpen::Routing::StockData::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")

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.

Implements NXOpen::Routing::ICharacteristic.

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

Implements NXOpen::Routing::ICharacteristic.

void NXOpen::Routing::StockData::SetCrossSections ( const std::vector< NXOpen::Routing::CrossSection * > &  crossSections)

Sets the list of Routing::CrossSection objects associated with this Routing::StockData .

There should be no more than one Routing::CrossSection of any particular Routing::StockStyle (and no Routing::CrossSection with a style of Routing::StockStyleNone ).
Created in NX4.0.0.

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

Parameters:
crossSectionsThe list of Routing::CrossSection objects.

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