NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Member Functions | Properties | List of all members
NXOpen.Mechatronics.PulleyBeltBuilder Class Reference

Represents a Mechatronics.PulleyBelt builder More...

Inheritance diagram for NXOpen.Mechatronics.PulleyBeltBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _PulleyBeltData
 Defines the pulley belt data structure.
 
struct  PulleyBeltData
 Defines the pulley belt data structure. More...
 

Public Member Functions

unsafe
NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData 
AddPulley (NXOpen.NXObject objTag, double dRadius, double dRatio, bool bMasterFlag)
 Validate the pulley with input parameter legal or not and construct JA_PULLEY_BELT_BUILDER_PulleyBeltData if it pass validation. More...
 
unsafe void DeletePulley (NXOpen.NXObject objTag)
 Delete the auto creation reference object such as rigid body or hinge joint linked to input parameter "objTag" More...
 
unsafe
NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData[] 
GetPulleyBeltData ()
 Gets all parameter data. More...
 
unsafe void SetBaseObject (NXOpen.NXObject objTag)
 Set the datum object, it can be cylindrical face object or hinge joint object, which direction is refered as the expected revolve direction. More...
 
unsafe void SetPulleyBeltData (NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData[] parameterData)
 Sets all parameter data. More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe string Name [get, set]
 Returns or sets the name More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a Mechatronics.PulleyBelt builder

To create a new instance of this class, use NXOpen.Mechatronics.PulleyBeltCollection.CreatePulleyBeltBuilder

Created in NX1899.0.0

Member Function Documentation

unsafe NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData NXOpen.Mechatronics.PulleyBeltBuilder.AddPulley ( NXOpen.NXObject  objTag,
double  dRadius,
double  dRatio,
bool  bMasterFlag 
)
inline

Validate the pulley with input parameter legal or not and construct JA_PULLEY_BELT_BUILDER_PulleyBeltData if it pass validation.

<remark> Check the return value to know if it pass validation or not. Only when returning MDPHYS_err_no_error means validation successful. </remark> <remark> Input object will pass validation only when it's cylindrical face or hinge/cylindrical joint are legal object and only when its direction is parallel to datum object. </remark> <remark> The interface will try to fetch the radius of the input object automatically when parameter "dRadius" is 0 and "objTag" is cylindrical face object. </remark> <remark> The interface might auto create hinge joint and rigid body when parameter "dRadius" is 0 and "objTag" is cylindrical face object and it has no legal hinge joint linked to its solid body. </remark>

<remark> More explanation of input parameters: </remark> <remark> objTag: only cylindrical face or hinge/cylindrical joint is legal. </remark> <remark> dRatio: input parameter, 0 value means NX app will automutically calculate transmition ratio for this pulley; none zero value means NX app will directly use this value as transmition ratio, and ignore the "dRadius" value. </remark> <remark> dRadius: input parameter, 0 value means NX app will fetch the radius if parameter "objTag" is cylindrical face object; none zero value means NX app will directly use this value to calculate the transmition ratio. </remark> <remark> bMasterFlag: input parameter, "true" means it's set to master axis joint pulley in this pulleys and belt chain; "false" means it's set to slave axis joint pulley in this pulleys and belt chain. </remark> <remark> pulleyData: output parameter, it's useful when the interface returns MDPHYS_err_no_error. </remark>

Created in NX1899.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
objTagThe tag of the input object
dRadiusThe shortest distance from the touch face to rotary axis joint vector, with mm unit
dRatioPulley transmition ratio, its sign indicating the rotary direction
bMasterFlagThe flag to indicate a pulley is set as master rotary axis or not
Returns
unsafe void NXOpen.Mechatronics.PulleyBeltBuilder.DeletePulley ( NXOpen.NXObject  objTag)
inline

Delete the auto creation reference object such as rigid body or hinge joint linked to input parameter "objTag"

Created in NX1899.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
objTagThe tag of the input object
unsafe NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData [] NXOpen.Mechatronics.PulleyBeltBuilder.GetPulleyBeltData ( )
inline

Gets all parameter data.

Created in NX1899.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Returns
Array of parameter data
unsafe void NXOpen.Mechatronics.PulleyBeltBuilder.SetBaseObject ( NXOpen.NXObject  objTag)
inline

Set the datum object, it can be cylindrical face object or hinge joint object, which direction is refered as the expected revolve direction.

<remark> This interface must be called before calling Mechatronics.PulleyBeltBuilder.AddPulley to add a pulley. </remark>

Created in NX1899.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
objTagThe tag of datum Object, it can be cylindrical face object or hinge/cylindrical jiont object.
unsafe void NXOpen.Mechatronics.PulleyBeltBuilder.SetPulleyBeltData ( NXOpen.Mechatronics.PulleyBeltBuilder.PulleyBeltData[]  parameterData)
inline

Sets all parameter data.

<remark> The elements in input array "parameterData" can be constructed by JA_PULLEY_BELT_BUILDER_AddPulley interface. </remark>

Created in NX1899.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
parameterDataArray of parameter data

Property Documentation

unsafe string NXOpen.Mechatronics.PulleyBeltBuilder.Name
getset

Returns or sets the name

Created in NX1899.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")


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