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

Interface class for all routing objects that specify a direction
Created in NX4.0.0. More...

Inheritance diagram for NXOpen::Routing::IAxisPort:
NXOpen::Routing::IRoutePosition NXOpen::Routing::ICharacteristic NXOpen::INXObject NXOpen::Routing::FittingPort NXOpen::Routing::FixturePort NXOpen::Routing::MultiPort NXOpen::Routing::ProxyPort NXOpen::Routing::TerminalPort

Public Member Functions

virtual NXOpen::AxisAxis ()=0
 Returns the axis that defines the port
Created in NX5.0.0. More...
 
virtual NXOpen::ExpressionCutbackLengthObject ()=0
 Returns the cutback length object of a port, i.e. More...
 
virtual NXOpen::ExpressionEngagementObject ()=0
 Returns the engagement object of a port, i.e. More...
 
virtual NXOpen::ExpressionForwardExtensionObject ()=0
 Returns the forward extension object of a port, i.e. More...
 
virtual void SetAlignVector (const NXOpen::Vector3d &vector)=0
 Sets the align vector of Port
Created in NX4.0.0. More...
 
virtual void SetAxis (NXOpen::Axis *axis)=0
 Sets the axis that defines the port
Created in NX5.0.0. More...
 
virtual void SetCutbackLength (double cutbackLength)=0
 Sets the cutback length of a port, i.e. More...
 
virtual void SetCutbackLengthObject (NXOpen::Expression *cutbackLength)=0
 Sets the cutback length object of a port, i.e. More...
 
virtual void SetEngagement (double engagement)=0
 The engagment distance of a NXOpen::Routing::IAxisPort , i.e. More...
 
virtual void SetEngagementObject (NXOpen::Expression *engagement)=0
 Sets the engagement object of a port, i.e. More...
 
virtual void SetForwardExtension (double forwardExtension)=0
 Sets the forward extension value of a port, i.e. More...
 
virtual void SetForwardExtensionObject (NXOpen::Expression *forwardExtension)=0
 Sets the forward extension object of a port, i.e. More...
 
virtual void SetRotationObject (NXOpen::DisplayableObject *rotationObject)=0
 Sets the object used to derive the rotation vector of Port
Created in NX4.0.0. More...
 
virtual void SetRotationVector (const NXOpen::Vector3d &vector)=0
 Sets the rotation vector of Port
Created in NX4.0.0. More...
 
- Public Member Functions inherited from NXOpen::Routing::IRoutePosition
virtual NXOpen::PointPoint ()=0
 Returns the NXOpen::Point that specifies the location of the NXOpen::Routing::IRoutePosition object. More...
 
virtual NXOpen::Point3d Position ()=0
 Returns the current location of the object in ABS coordinates. More...
 
virtual void SetPoint (NXOpen::Point *point)=0
 Sets the NXOpen::Point that specifies the location of the NXOpen::Routing::IRoutePosition object. More...
 
virtual void SetPosition (const NXOpen::Point3d &position)=0
 Sets the current location of the object in ABS coordinates. More...
 
- 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. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetCharacteristics ()=0
 Get all of the characteristics values on the this object. More...
 
virtual
NXOpen::Routing::CharacteristicList
GetDestinationCharacteristics ()=0
 Returns the destination characteristics from the input object. More...
 
virtual int GetIntegerCharacteristic (const NXString &name)=0
 Get the value of an integer characteristic associated with the input name. More...
 
virtual int GetIntegerCharacteristic (const char *name)=0
 Get the value of an integer characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const NXString &name)=0
 Get the value of a real characteristic associated with the input name. More...
 
virtual double GetRealCharacteristic (const char *name)=0
 Get the value of a real characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const NXString &name)=0
 Get the value of a string characteristic associated with the input name. More...
 
virtual NXString GetStringCharacteristic (const char *name)=0
 Get the value of a string characteristic associated with the input name. More...
 
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. More...
 
virtual void SetCharacteristic (const char *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. More...
 
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. More...
 
virtual void SetCharacteristic (const char *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. More...
 
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. More...
 
virtual void SetCharacteristic (const char *name, const char *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. More...
 
virtual void SetCharacteristic2 (const NXString &title, int value)=0
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, int value)=0
 Sets or creates an integer type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, double value)=0
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, double value)=0
 Sets or creates a double type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const NXString &title, const NXString &value)=0
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristic2 (const char *title, const char *value)=0
 Sets or creates a string type type attribute associated with the input title. More...
 
virtual void SetCharacteristics (NXOpen::Routing::CharacteristicList *values)=0
 Set all of the characteristics values on this object. More...
 
virtual void SetCharacteristics2 (NXOpen::Routing::CharacteristicList *values)=0
 Sets all attributes associated with the titles from the input list, creating new attributes for the ones that don't exist already. More...
 
- Public Member Functions inherited from NXOpen::INXObject
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual bool IsOccurrence ()=0
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()=0
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()=0
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()=0
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()=0
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()=0
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()=0
 Returns the prototype of this object if it is an occurrence. More...
 
virtual void SetName (const NXString &name)=0
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)=0
 Sets the custom name of the object. More...
 

Detailed Description

Interface class for all routing objects that specify a direction
Created in NX4.0.0.


Member Function Documentation

virtual NXOpen::Axis* NXOpen::Routing::IAxisPort::Axis ( )
pure virtual

Returns the axis that defines the port
Created in NX5.0.0.



License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual NXOpen::Expression* NXOpen::Routing::IAxisPort::CutbackLengthObject ( )
pure virtual

Returns the cutback length object of a port, i.e.

an expression representing the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual NXOpen::Expression* NXOpen::Routing::IAxisPort::EngagementObject ( )
pure virtual

Returns the engagement object of a port, i.e.

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual NXOpen::Expression* NXOpen::Routing::IAxisPort::ForwardExtensionObject ( )
pure virtual

Returns the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a NXOpen::Routing::Port


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetAlignVector ( const NXOpen::Vector3d vector)
pure virtual

Sets the align vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
vectorVector direction in absolute co-ordinate system

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetAxis ( NXOpen::Axis axis)
pure virtual

Sets the axis that defines the port
Created in NX5.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
axisaxis

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetCutbackLength ( double  cutbackLength)
pure virtual

Sets the cutback length of a port, i.e.

the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
cutbackLengthCutback Length

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetCutbackLengthObject ( NXOpen::Expression cutbackLength)
pure virtual

Sets the cutback length object of a port, i.e.

an expression representing the length along the wire from the port where individual wires leave a bundle to attach to pins


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
cutbackLengthCutback Length Expression

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetEngagement ( double  engagement)
pure virtual

The engagment distance of a NXOpen::Routing::IAxisPort , i.e.

the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
engagementEngagement distance

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetEngagementObject ( NXOpen::Expression engagement)
pure virtual

Sets the engagement object of a port, i.e.

an expression representing the distance behind the port that another fitting or stock may engage


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
engagementEngagement Expression

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetForwardExtension ( double  forwardExtension)
pure virtual

Sets the forward extension value of a port, i.e.

the minimum length that a segment must remain straight coming out of a NXOpen::Routing::Port


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
forwardExtensionPort extension

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetForwardExtensionObject ( NXOpen::Expression forwardExtension)
pure virtual

Sets the forward extension object of a port, i.e.

an expression representing the minimum length that a segment must remain straight coming out of a NXOpen::Routing::Port


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
forwardExtensionForward Extension Expression

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetRotationObject ( NXOpen::DisplayableObject rotationObject)
pure virtual

Sets the object used to derive the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
rotationObjectObject used to derive the rotation vector

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.

virtual void NXOpen::Routing::IAxisPort::SetRotationVector ( const NXOpen::Vector3d vector)
pure virtual

Sets the rotation vector of Port
Created in NX4.0.0.



License requirements : routing_base ("Routing Basic")

Parameters
vectorVector direction in absolute co-ordinate system

Implemented in NXOpen::Routing::MultiPort, NXOpen::Routing::TerminalPort, NXOpen::Routing::FittingPort, NXOpen::Routing::ProxyPort, and NXOpen::Routing::FixturePort.


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