NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Routing::ControlPoint Class Reference

Routing Control Points define a position in space, and are used to determine connections from segments to segments, and segments to ports. More...

Inheritance diagram for NXOpen::Routing::ControlPoint:
NXOpen::SmartObject NXOpen::Routing::IRoutePosition NXOpen::DisplayableObject NXOpen::Routing::ICharacteristic NXOpen::NXObject NXOpen::IFitTo NXOpen::INXObject NXOpen::TaggedObject NXOpen::INXObject NXOpen::INXObject

List of all members.

Public Types

enum  DefinedStatus { DefinedStatusSystem, DefinedStatusUser }
 User defined status for a ControlPoint . More...

Public Member Functions

NXOpen::Assemblies::ComponentAssignDefaultElbow ()
 Places the default elbow at this object.
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.
NXOpen::NXObjectGetDefiningObject ()
 Returns defining object for this ControlPoint .
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::ControlPoint::DefinedStatus GetIsUserDefined ()
 Returns whether this object is defined by a user or automatically by the Routing Application.
std::vector
< NXOpen::Routing::ISegment * > 
GetRcpSegments ()
 Returns all segments whose start or end Control Point is this Control Point.
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.
bool IsLockedToObject (NXOpen::NXObject *object)
 Returns whether or not a touch constraint exists between the control point and the input object.
NXOpen::Positioning::ConstraintLockToObject (NXOpen::NXObject *object)
 Ensures that a touch constraint exists between this control point and the input object.
virtual NXOpen::PointPoint ()
 Returns the Point that specifies the location of the Routing::IRoutePosition object.
virtual NXOpen::Point3d Position ()
 Returns the current location of the object in ABS coordinates.
void RemoveCorner ()
 Remove the assigned corner.
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.
virtual void SetPoint (NXOpen::Point *point)
 Sets the Point that specifies the location of the Routing::IRoutePosition object.
virtual void SetPosition (const NXOpen::Point3d &position)
 Sets the current location of the object in ABS coordinates.
void UnlockFromObject (NXOpen::NXObject *object)
 Removes the touch constraint that exists between the control point and the input object.

Detailed Description

Routing Control Points define a position in space, and are used to determine connections from segments to segments, and segments to ports.


To create an instace of this object use Routing::ControlPointCollection::CreateControlPoint

Created in NX4.0.0.


Member Enumeration Documentation

User defined status for a ControlPoint .

Enumerator:
DefinedStatusSystem 

Created automatically by the application.

DefinedStatusUser 

Created by the user.


Member Function Documentation

Places the default elbow at this object.

Finds the default elbow by searching through the default elbow part table (see Preferences::RoutingPart using the destination characteristics assigned to the stock on this object.

Uses the ALLOW_DEFAULT_ELBOW_PLACEMENT plugin to determine if an elbow can be placed at this object.

Returns:
the placed elbow component, NULL if placement fails.
Created in NX5.0.0.

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

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 defining object for this ControlPoint .

Returns:
Object defining control point.
Created in NX6.0.0.

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

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::ControlPoint::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 this object is defined by a user or automatically by the Routing Application.

Returns:

Created in NX4.0.0.

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

Returns all segments whose start or end Control Point is this Control Point.

Returns:

Created in NX4.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
virtual double NXOpen::Routing::ControlPoint::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.

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 whether or not a touch constraint exists between the control point and the input object.

This control point must not be an occurrence, the input object may be an occurrence.

Returns:
Whether or not the control point is constained to the object.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
objectObject constrained to control point.

Ensures that a touch constraint exists between this control point and the input object.

Creates a constraint if one doesn't exist already.

This control point must not be an occurrence, the input object may be an occurrence.

See Positioning::Constraint for a description of touch constraints.

Do not attempt to lock control points to Routing::ISegment or Routing::Stock objects, this will result in upredictable behavior.

Returns:
The new or existing touch constraint.
Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")
Parameters:
objectObject to constraint to control point.

Returns the Point that specifies the location of the Routing::IRoutePosition object.

A NULL object indicates that this object is not associated to any point.
Created in NX4.0.0.

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

Implements NXOpen::Routing::IRoutePosition.

Returns the current location of the object in ABS coordinates.

This value is overridden by the coordinates of the point associated with this object.
Created in NX4.0.0.

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

Implements NXOpen::Routing::IRoutePosition.

Remove the assigned corner.


Created in NX4.0.0.

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

virtual void NXOpen::Routing::ControlPoint::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::ControlPoint::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::ControlPoint::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.

virtual void NXOpen::Routing::ControlPoint::SetPoint ( NXOpen::Point point) [virtual]

Sets the Point that specifies the location of the Routing::IRoutePosition object.

A NULL object indicates that this object is not associated to any point.
Created in NX4.0.0.

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

Parameters:
pointNew location of object in ABS coordinates

Implements NXOpen::Routing::IRoutePosition.

virtual void NXOpen::Routing::ControlPoint::SetPosition ( const NXOpen::Point3d position) [virtual]

Sets the current location of the object in ABS coordinates.

This value is overridden by the coordinates of the point associated with this object.
Created in NX4.0.0.

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

Parameters:
positionNew location of object in ABS coordinates

Implements NXOpen::Routing::IRoutePosition.

Removes the touch constraint that exists between the control point and the input object.

This control point must not be an occurrence, the input object may be an occurrence.

Call Update::DoUpdate afterwards to ensure that the constraint is fully deleted.


Created in NX5.0.0.

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

Parameters:
objectObject constrained to control point.

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