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

A Routing::CrossSection defines a profile to sweep for Routing::Stock objects. More...

Inheritance diagram for NXOpen::Routing::CrossSection:
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.
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()
 Get all of the characteristics values on the this object.
std::vector< NXOpen::Curve * > GetCrossCurves ()
 Returns the curves that define the profile for the Routing::CrossSection 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.
double GetMaximumRadius ()
 Returns the maximum radius of the profile.
virtual double GetRealCharacteristic (const NXString &name)
 Get the value of a real characteristic associated with the input name.
NXOpen::Routing::StockDataGetStockData ()
 Returns the Routing::StockData that owns this Routing::CrossSection .
virtual NXString GetStringCharacteristic (const NXString &name)
 Get the value of a string characteristic associated with the input name.
NXOpen::ExpressionOffset ()
 Returns the offset expression applied to the profile when generating a Sweep.
NXOpen::ExpressionSecondOffset ()
 Returns the offset expression applied to the profile when generating a Sweep.
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 SetCrossCurves (const std::vector< NXOpen::Curve * > &curves)
 Sets the curves that define the profile for the Routing::CrossSection object.
void SetOffset (NXOpen::Expression *expression)
 Sets the offset expression applied to the profile when generating a Sweep.
void SetSecondOffset (NXOpen::Expression *secondOffset)
 Sets the offset expression applied to the profile when generating a Sweep.
void SetStyle (NXOpen::Routing::StockStyle style)
 Sets the style of the profile.
NXOpen::Routing::StockStyle Style ()
 Returns the style of the profile.

Detailed Description

A Routing::CrossSection defines a profile to sweep for Routing::Stock objects.

The profile is a set of curves centered around the origin, and in the XY plane. An offset may be specified that forms a second profile that consists of curves offset by the specified offset from the profile curves (which forms a hollow stock body, such as a pipe).
To obtain an instance of this class use Routing::CrossSectionCollection::CreateCrossSection

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.

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.

Returns the curves that define the profile for the Routing::CrossSection object.

Returns:
The curves that define the profile.
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::CrossSection::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 the maximum radius of the profile.

Returns:
The radius of the circle that encircles all profile curves in the Routing::CrossSection
Created in NX4.0.0.

License requirements : routing_mechanical ("Routing Mechanical") OR routing_electrical ("Routing Electrical") OR routing_combined ("Routing Combined")
virtual double NXOpen::Routing::CrossSection::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 the Routing::StockData that owns this Routing::CrossSection .

Returns:
The Routing::StockData that owns the Routing::CrossSection object.
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 offset expression applied to the profile when generating a Sweep.

This forms a second set of profile curves that are offset outwards (for positive offsets, inwards for negative offsets) from the profile curves of the Routing::CrossSection . A value of 0.0 or a NULL expression indicates no offset.
Created in NX4.0.0.

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

Returns the offset expression applied to the profile when generating a Sweep.

This forms a second set of profile curves that are offset outwards (for positive offsets, inwards for negative offsets) from the profile curves of the Routing::CrossSection . A value of 0.0 or a NULL expression indicates no offset.
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::CrossSection::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::CrossSection::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::CrossSection::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::CrossSection::SetCrossCurves ( const std::vector< NXOpen::Curve * > &  curves)

Sets the curves that define the profile for the Routing::CrossSection object.

The curves must form a single closed loop.
Created in NX4.0.0.

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

Parameters:
curvesThe curves that define the profile.

Sets the offset expression applied to the profile when generating a Sweep.

This forms a second set of profile curves that are offset outwards (for positive offsets, inwards for negative offsets) from the profile curves of the Routing::CrossSection . A value of 0.0 or a NULL expression indicates no offset.
Created in NX4.0.0.

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

Parameters:
expressionexpression

Sets the offset expression applied to the profile when generating a Sweep.

This forms a second set of profile curves that are offset outwards (for positive offsets, inwards for negative offsets) from the profile curves of the Routing::CrossSection . A value of 0.0 or a NULL expression indicates no offset.
Created in NX5.0.0.

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

Parameters:
secondOffsetsecond offset

Sets the style of the profile.

See Routing::StockData for information on styles
Created in NX4.0.0.

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

Parameters:
stylestyle

Returns the style of the profile.

See Routing::StockData for information on styles
Created in NX4.0.0.

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


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