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

Represents a NXOpen.Mechatronics.CamProfile builder. More...

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

Classes

struct  _Element
 Contains segment information of a motion segment
 
struct  Element
 Contains segment information of a motion segment More...
 

Public Types

enum  MasterValueUnit { Linear, Rotary, Time }
 The master value unit indicates which type master joint is. More...
 
enum  ProfileCyclicType { RelativeCyclic, Cyclic, NonCyclic }
 Indicates which cyclic type should be take. More...
 
enum  SlaveValueUnit { LinearPosition, RotaryPosition, LinearSpeed, RotarySpeed }
 The master value unit indicates which type master joint is. More...
 

Public Member Functions

unsafe void AddElement (NXOpen.NXObject part, NXOpen.Mechatronics.CamProfileBuilder.Element element)
 Add element to builder. More...
 
unsafe
NXOpen.Mechatronics.CamProfileBuilder.Element 
AskElementByIndex (int index)
 Ask segment element. More...
 
unsafe int AskElementsLength ()
 Ask segments length. More...
 
unsafe void ClearElements ()
 Clear elements . More...
 
unsafe void EditElement (int index, NXOpen.NXObject part, NXOpen.Mechatronics.CamProfileBuilder.Element element)
 Edit the specific element of builder. More...
 
unsafe int FindElementIndex (NXOpen.Mechatronics.CamProfileBuilder.Element element)
 Find the element index. More...
 
unsafe void RemoveElementByIndex (int index)
 Remove element by index. More...
 
unsafe void SetSegmentTable (NXOpen.Mechatronics.CamProfile segmentTableObject)
 Set segment table. More...
 
unsafe void SwitchSegmentTable (NXOpen.Mechatronics.CamProfile segmentTableObject)
 Switch segments table object. 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 bool CheckingG2Continuity [get, set]
 Returns or sets the indicator that a cam profile should check G2 continuous or not More...
 
unsafe
NXOpen.Mechatronics.CamProfileBuilder.ProfileCyclicType 
CyclicType [get, set]
 Returns or sets the cyclic type of a cam profile More...
 
unsafe NXOpen.Expression MasterMaximum [get]
 Returns the maximum master value More...
 
unsafe NXOpen.Expression MasterMinimum [get]
 Returns the minimum master value More...
 
unsafe
NXOpen.Mechatronics.CamProfileBuilder.MasterValueUnit 
MasterUnit [get, set]
 Returns or sets the type of master joint More...
 
unsafe string Name [get, set]
 Returns or sets the cam profile name More...
 
unsafe NXOpen.Expression SlaveMaximum [get]
 Returns the maximum slave value. More...
 
unsafe NXOpen.Expression SlaveMinimum [get]
 Returns the minimum slave More...
 
unsafe
NXOpen.Mechatronics.CamProfileBuilder.SlaveValueUnit 
SlaveUnit [get, set]
 Returns or sets the type of slave joint or slave controller 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 NXOpen.Mechatronics.CamProfile builder.

To create a new instance of this class, use NXOpen.Mechatronics.CamProfileCollection.CreateCamProfileBuilder

Created in NX9.0.0

Member Enumeration Documentation

The master value unit indicates which type master joint is.

Enumerator
Linear 

Linear

Rotary 

Rotary

Time 

Time

Indicates which cyclic type should be take.

The type of Cam Profile can be switched between non-cyclic, cyclic and relative cyclic

Enumerator
RelativeCyclic 

In Relative Cyclic Cam Profiles the start point and end point of the profile do not necessarily have to be equal.

Cyclic 

In Cyclic Cam Profiles the points at the beginning and the end of the Master Axis range need to be identical with respect to Slave Axis value, slope and curve.

NonCyclic 

Non-cyclic Cam Profiles are defined only in the defined master axis range.

Exceeding this range will cause an error.

The master value unit indicates which type master joint is.

Enumerator
LinearPosition 

Linear Position

RotaryPosition 

Rotary Position

LinearSpeed 

Linear Speed

RotarySpeed 

Rotary Speed

Member Function Documentation

unsafe void NXOpen.Mechatronics.CamProfileBuilder.AddElement ( NXOpen.NXObject  part,
NXOpen.Mechatronics.CamProfileBuilder.Element  element 
)
inline

Add element to builder.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
part
element
unsafe NXOpen.Mechatronics.CamProfileBuilder.Element NXOpen.Mechatronics.CamProfileBuilder.AskElementByIndex ( int  index)
inline

Ask segment element.

Created in NX10.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
Returns
unsafe int NXOpen.Mechatronics.CamProfileBuilder.AskElementsLength ( )
inline

Ask segments length.

Created in NX10.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Returns
unsafe void NXOpen.Mechatronics.CamProfileBuilder.ClearElements ( )
inline

Clear elements .

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe void NXOpen.Mechatronics.CamProfileBuilder.EditElement ( int  index,
NXOpen.NXObject  part,
NXOpen.Mechatronics.CamProfileBuilder.Element  element 
)
inline

Edit the specific element of builder.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
indexThe element index
part
element
unsafe int NXOpen.Mechatronics.CamProfileBuilder.FindElementIndex ( NXOpen.Mechatronics.CamProfileBuilder.Element  element)
inline

Find the element index.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
element
Returns
unsafe void NXOpen.Mechatronics.CamProfileBuilder.RemoveElementByIndex ( int  index)
inline

Remove element by index.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
unsafe void NXOpen.Mechatronics.CamProfileBuilder.SetSegmentTable ( NXOpen.Mechatronics.CamProfile  segmentTableObject)
inline

Set segment table.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
segmentTableObject
unsafe void NXOpen.Mechatronics.CamProfileBuilder.SwitchSegmentTable ( NXOpen.Mechatronics.CamProfile  segmentTableObject)
inline

Switch segments table object.

Created in NX12.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
segmentTableObject

Property Documentation

unsafe bool NXOpen.Mechatronics.CamProfileBuilder.CheckingG2Continuity
getset

Returns or sets the indicator that a cam profile should check G2 continuous or not

Created in NX10.0.0

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

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

unsafe NXOpen.Mechatronics.CamProfileBuilder.ProfileCyclicType NXOpen.Mechatronics.CamProfileBuilder.CyclicType
getset

Returns or sets the cyclic type of a cam profile

Created in NX9.0.0

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

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

unsafe NXOpen.Expression NXOpen.Mechatronics.CamProfileBuilder.MasterMaximum
get

Returns the maximum master value

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Expression NXOpen.Mechatronics.CamProfileBuilder.MasterMinimum
get

Returns the minimum master value

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Mechatronics.CamProfileBuilder.MasterValueUnit NXOpen.Mechatronics.CamProfileBuilder.MasterUnit
getset

Returns or sets the type of master joint

Created in NX9.0.0

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

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

unsafe string NXOpen.Mechatronics.CamProfileBuilder.Name
getset

Returns or sets the cam profile name

Created in NX9.0.0

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

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

unsafe NXOpen.Expression NXOpen.Mechatronics.CamProfileBuilder.SlaveMaximum
get

Returns the maximum slave value.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Expression NXOpen.Mechatronics.CamProfileBuilder.SlaveMinimum
get

Returns the minimum slave

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe NXOpen.Mechatronics.CamProfileBuilder.SlaveValueUnit NXOpen.Mechatronics.CamProfileBuilder.SlaveUnit
getset

Returns or sets the type of slave joint or slave controller

Created in NX9.0.0

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

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.