NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Motion::PortVariable Class Reference

Represents a Motion::PortVariable . More...

Inheritance diagram for NXOpen::Motion::PortVariable:
NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Member Functions

NXString AssociatedPortName ()
 Returns the associated port name
Created in NX11.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX11.0.0. More...
 
NXOpen::Motion::ControlPortPort ()
 Returns the port
Created in NX11.0.0. More...
 
void SetAssociatedPortName (const NXString &associatedPortName)
 Sets the associated port name
Created in NX11.0.0. More...
 
void SetAssociatedPortName (const char *associatedPortName)
 Sets the associated port name
Created in NX11.0.0. More...
 
int Unit ()
 Returns the unit
Created in NX11.0.0. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Motion::PortVariable .

This class contains the port association for the output of a mechatronics element
No KF support

Created in NX11.0.0.

Member Function Documentation

NXString NXOpen::Motion::PortVariable::AssociatedPortName ( )

Returns the associated port name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXString NXOpen::Motion::PortVariable::Name ( )

Returns the name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

NXOpen::Motion::ControlPort* NXOpen::Motion::PortVariable::Port ( )

Returns the port
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

void NXOpen::Motion::PortVariable::SetAssociatedPortName ( const NXString associatedPortName)

Sets the associated port name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
associatedPortNameassociatedportname
void NXOpen::Motion::PortVariable::SetAssociatedPortName ( const char *  associatedPortName)

Sets the associated port name
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
associatedPortNameassociatedportname
int NXOpen::Motion::PortVariable::Unit ( )

Returns the unit
Created in NX11.0.0.



License requirements : mechanisms ("MECHANISMS")

virtual bool NXOpen::Motion::PortVariable::Validate ( )
virtual

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Returns
Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.


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