NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::Motion::LinkAttachmentData Class Reference

Represents a Motion::LinkAttachmentData . More...

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

Public Types

enum  OrientationTypes { OrientationTypesNone, OrientationTypesVector, OrientationTypesCsys }
 Defines the orientation types of motion body attachment. More...
 

Public Member Functions

NXOpen::CoordinateSystemCsys ()
 Returns the csys - if the selected type is CSYS, use this method to access it. More...
 
NXOpen::Motion::ParamOverrideState CsysOvrCtrl ()
 Returns the override state of the csys, which should only be used for occurrence. More...
 
NXOpen::Matrix3x3 GetOrientation ()
 The orientation matrix. More...
 
NXOpen::Motion::SelectLinkLink ()
 Returns the motion body
Created in NX11.0.0. More...
 
NXOpen::Motion::ParamOverrideState LinkOvrCtrl ()
 Returns the override state of the link, which should only be used for occurrence. More...
 
NXOpen::Motion::LinkAttachmentData::OrientationTypes OrientationType ()
 Returns the orientation type
Created in NX1847.0.0. More...
 
NXOpen::Motion::ParamOverrideState OrientationTypeOvrCtrl ()
 Returns the override state of the orientation type, which should only be used for occurrence. More...
 
NXOpen::PointOrigin ()
 Returns the origin
Created in NX11.0.0. More...
 
NXOpen::Motion::ParamOverrideState OriginOvrCtrl ()
 Returns the override state of the origin, which should only be used for occurrence. More...
 
void SetCsys (NXOpen::CoordinateSystem *csys)
 Sets the csys - if the selected type is CSYS, use this method to access it. More...
 
void SetCsysOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets the override state of the csys, which should only be used for occurrence. More...
 
void SetLinkOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets the override state of the link, which should only be used for occurrence. More...
 
void SetOrientationType (NXOpen::Motion::LinkAttachmentData::OrientationTypes orientationType)
 Sets the orientation type
Created in NX1847.0.0. More...
 
void SetOrientationTypeOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets the override state of the orientation type, which should only be used for occurrence. More...
 
void SetOrigin (NXOpen::Point *origin)
 Sets the origin
Created in NX11.0.0. More...
 
void SetOriginOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets the override state of the origin, which should only be used for occurrence. More...
 
void SetVector (NXOpen::Direction *vector)
 Sets the vector - if the selected type is Vector, use this method to access it. More...
 
void SetVectorOvrCtrl (NXOpen::Motion::ParamOverrideState overrideState)
 Sets the override state of the vector, which should only be used for occurrence. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
NXOpen::DirectionVector ()
 Returns the vector - if the selected type is Vector, use this method to access it. More...
 
NXOpen::Motion::ParamOverrideState VectorOvrCtrl ()
 Returns the override state of the vector, which should only be used for occurrence. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Motion::LinkAttachmentData .


Created in NX11.0.0.

Member Enumeration Documentation

Defines the orientation types of motion body attachment.

Enumerator
OrientationTypesNone 

No orientation type.

OrientationTypesVector 

Vector orientation type.

OrientationTypesCsys 

CSYS orientation type.

Member Function Documentation

NXOpen::CoordinateSystem* NXOpen::Motion::LinkAttachmentData::Csys ( )

Returns the csys - if the selected type is CSYS, use this method to access it.


Created in NX11.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::LinkAttachmentData::CsysOvrCtrl ( )

Returns the override state of the csys, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : None

NXOpen::Matrix3x3 NXOpen::Motion::LinkAttachmentData::GetOrientation ( )

The orientation matrix.

Returns
Matrix3x3
Created in NX11.0.0.

License requirements : None
NXOpen::Motion::SelectLink* NXOpen::Motion::LinkAttachmentData::Link ( )

Returns the motion body
Created in NX11.0.0.



License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::LinkAttachmentData::LinkOvrCtrl ( )

Returns the override state of the link, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : None

NXOpen::Motion::LinkAttachmentData::OrientationTypes NXOpen::Motion::LinkAttachmentData::OrientationType ( )

Returns the orientation type
Created in NX1847.0.0.



License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::LinkAttachmentData::OrientationTypeOvrCtrl ( )

Returns the override state of the orientation type, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : None

NXOpen::Point* NXOpen::Motion::LinkAttachmentData::Origin ( )

Returns the origin
Created in NX11.0.0.



License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::LinkAttachmentData::OriginOvrCtrl ( )

Returns the override state of the origin, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : None

void NXOpen::Motion::LinkAttachmentData::SetCsys ( NXOpen::CoordinateSystem csys)

Sets the csys - if the selected type is CSYS, use this method to access it.


Created in NX11.0.0.

License requirements : None

Parameters
csyscsys
void NXOpen::Motion::LinkAttachmentData::SetCsysOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets the override state of the csys, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::LinkAttachmentData::SetLinkOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets the override state of the link, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::LinkAttachmentData::SetOrientationType ( NXOpen::Motion::LinkAttachmentData::OrientationTypes  orientationType)

Sets the orientation type
Created in NX1847.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
orientationTypeorientationtype
void NXOpen::Motion::LinkAttachmentData::SetOrientationTypeOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets the override state of the orientation type, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::LinkAttachmentData::SetOrigin ( NXOpen::Point origin)

Sets the origin
Created in NX11.0.0.



License requirements : None

Parameters
originorigin
void NXOpen::Motion::LinkAttachmentData::SetOriginOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets the override state of the origin, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
void NXOpen::Motion::LinkAttachmentData::SetVector ( NXOpen::Direction vector)

Sets the vector - if the selected type is Vector, use this method to access it.


Created in NX11.0.0.

License requirements : None

Parameters
vectorvector
void NXOpen::Motion::LinkAttachmentData::SetVectorOvrCtrl ( NXOpen::Motion::ParamOverrideState  overrideState)

Sets the override state of the vector, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : mechanisms ("MECHANISMS")

Parameters
overrideStateoverridestate
virtual bool NXOpen::Motion::LinkAttachmentData::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.

NXOpen::Direction* NXOpen::Motion::LinkAttachmentData::Vector ( )

Returns the vector - if the selected type is Vector, use this method to access it.


Created in NX11.0.0.

License requirements : None

NXOpen::Motion::ParamOverrideState NXOpen::Motion::LinkAttachmentData::VectorOvrCtrl ( )

Returns the override state of the vector, which should only be used for occurrence.


Created in NX1847.0.0.

License requirements : None


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