NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::IRoutePosition Class Referenceabstract

Interface class for all routing objects that specify a single (possibly associative) location in space. More...

Inheritance diagram for NXOpen::Routing::IRoutePosition:
NXOpen::Routing::ICharacteristic NXOpen::INXObject NXOpen::Routing::Anchor NXOpen::Routing::ControlPoint NXOpen::Routing::IAxisPort NXOpen::Routing::Port NXOpen::Routing::FittingPort NXOpen::Routing::FixturePort NXOpen::Routing::MultiPort NXOpen::Routing::ProxyPort NXOpen::Routing::TerminalPort NXOpen::Routing::ExtractPort NXOpen::Routing::FittingPort NXOpen::Routing::FixturePort NXOpen::Routing::MultiPort NXOpen::Routing::ProxyPort NXOpen::Routing::StockOffsetPort NXOpen::Routing::StockPort NXOpen::Routing::TerminalPort

Public Member Functions

virtual NXOpen::Point * Point ()=0
 Returns the Point that specifies the location of the Routing::IRoutePosition object.
 
virtual NXOpen::Point3d Position ()=0
 Returns the current location of the object in ABS coordinates.
 
virtual void SetPoint (NXOpen::Point *point)=0
 Sets the Point that specifies the location of the Routing::IRoutePosition object.
 
virtual void SetPosition (const NXOpen::Point3d &position)=0
 Sets the current location of the object in ABS coordinates.
 
- Public Member Functions inherited from NXOpen::Routing::ICharacteristic
virtual void DeleteCharacterstics (NXOpen::Routing::CharacteristicList *values)=0
 Removes the input list of characteristics from this object.
 
virtual
NXOpen::Routing::CharacteristicList * 		GetCharacteristics ()=0
 Get all of the characteristics values on the this object.
 
virtual
NXOpen::Routing::CharacteristicList * 		GetDestinationCharacteristics ()=0
 Returns the destination characteristics from the input object.
 
virtual int GetIntegerCharacteristic (const NXString &name)=0
 Get the value of an integer characteristic associated with the input name.
 
int GetIntegerCharacteristic (const char *name)
 Get the value of an integer characteristic associated with the input name.
 
virtual double GetRealCharacteristic (const NXString &name)=0
 Get the value of a real characteristic associated with the input name.
 
double GetRealCharacteristic (const char *name)
 Get the value of a real characteristic associated with the input name.
 
virtual NXString GetStringCharacteristic (const NXString &name)=0
 Get the value of a string characteristic associated with the input name.
 
NXString GetStringCharacteristic (const char *name)
 Get the value of a string characteristic associated with the input name.
 
virtual void SetCharacteristic (const NXString &name, int value)=0
 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.
 
void SetCharacteristic (const char *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)=0
 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.
 
void SetCharacteristic (const char *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)=0
 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.
 
void SetCharacteristic (const char *name, const char *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)=0
 Set all of the characteristics values on this object.
 
- Public Member Functions inherited from NXOpen::INXObject
virtual NXOpen::INXObject * FindObject (const NXString &journalIdentifier)=0
 Finds the NXObject with the given identifier as recorded in a journal.
 
NXOpen::INXObject * FindObject (const char *journalIdentifier)
 Finds the NXObject with the given identifier as recorded in a journal.
 
virtual bool IsOccurrence ()=0
 Returns whether this object is an occurrence or not.
 
virtual NXString JournalIdentifier ()=0
 Returns the identifier that would be recorded in a journal for this object.
 
virtual NXString Name ()=0
 Returns the custom name of the object.
 
virtual
NXOpen::Assemblies::Component * 		OwningComponent ()=0
 Returns the owning component, if this object is an occurrence.
 
virtual NXOpen::BasePart * OwningPart ()=0
 Returns the owning part of this object
Created in NX3.0.0.
 
virtual void Print ()=0
 Prints a representation of this object to the system log file.
 
virtual NXOpen::INXObject * Prototype ()=0
 Returns the prototype of this object if it is an occurrence.
 
virtual void SetName (const NXString &name)=0
 Sets the custom name of the object.
 
void SetName (const char *name)
 Sets the custom name of the object.
 

Detailed Description

Interface class for all routing objects that specify a single (possibly associative) location in space.


Created in NX4.0.0.

Member Function Documentation

virtual NXOpen::Point* NXOpen::Routing::IRoutePosition::Point ( )
pure virtual

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_base ("Routing Basic")

Implemented in NXOpen::Routing::Port, NXOpen::Routing::ControlPoint, and NXOpen::Routing::Anchor.

virtual NXOpen::Point3d NXOpen::Routing::IRoutePosition::Position ( )
pure virtual

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_base ("Routing Basic")

Implemented in NXOpen::Routing::Port, NXOpen::Routing::ControlPoint, and NXOpen::Routing::Anchor.

virtual void NXOpen::Routing::IRoutePosition::SetPoint ( NXOpen::Point *  point)
pure 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_base ("Routing Basic")

Parameters
pointNew location of object in ABS coordinates

Implemented in NXOpen::Routing::Port, NXOpen::Routing::ControlPoint, and NXOpen::Routing::Anchor.

virtual void NXOpen::Routing::IRoutePosition::SetPosition ( const NXOpen::Point3d &  position)
pure 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_base ("Routing Basic")

Parameters
positionNew location of object in ABS coordinates

Implemented in NXOpen::Routing::Port, NXOpen::Routing::ControlPoint, and NXOpen::Routing::Anchor.

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