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

Represents a NXOpen.Mechatronics.CamProfileDocumentationBuilder . More...

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

Public Types

enum  CurveTypes { Standard2D, Radial2D, Radial3D }
 the cam curve type option. More...
 
enum  PartTypes { WorkPart, NewAssembly }
 Represents the document part option. More...
 

Public Member Functions

unsafe void AddSelectedParts (NXOpen.Part[] parts)
 Adds selected parts More...
 
unsafe void DeleteRow (int index)
 Deletes a row. More...
 
unsafe NXOpen.NXColor GetRowColor (int index)
 Gets row color. More...
 
unsafe bool GetRowState (int index)
 Gets row state. More...
 
unsafe void InsertRow (int pos, NXOpen.NXObject objectTag)
 Inserts a new row. More...
 
unsafe void SetRowColor (int index, NXOpen.NXColor color)
 Sets row color. More...
 
unsafe void SetRowState (int index, bool state)
 Sets row state. 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
NXOpen.Mechatronics.CamProfileDocumentationBuilder.CurveTypes 
CamCurveType [get, set]
 Returns or sets the cam curve type . More...
 
unsafe bool CreateXYAxis [get, set]
 Returns or sets the option to create axis. More...
 
unsafe
NXOpen.Mechatronics.CamProfileDocumentationBuilder.PartTypes 
DocumentPartType [get, set]
 Returns or sets the document part option . More...
 
unsafe string Name [get, set]
 Returns or sets the name. More...
 
unsafe NXOpen.Point Point [get, set]
 Returns or sets the point. More...
 
unsafe NXOpen.Expression RadialCurveBaseRadius [get]
 Returns the radial curve base radius. More...
 
unsafe bool ShowAxisScale [get, set]
 Returns or sets the option to show axis scale. More...
 
unsafe bool ShowPoints [get, set]
 Returns or sets the option to show points. More...
 
unsafe bool ShowSegmentData [get, set]
 Returns or sets the option to show segment data. More...
 
unsafe string XAxisLabel [get, set]
 Returns or sets the x axis label. More...
 
unsafe string YAxisLabel [get, set]
 Returns or sets the y axis label. 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.CamProfileDocumentationBuilder .

To create a new instance of this class, use NXOpen.Mechatronics.PhysicsManager.CreateCamProfileDocumentationBuilder

Created in NX1847.0.0

Member Enumeration Documentation

the cam curve type option.

Enumerator
Standard2D 

2D Standard

Radial2D 

2D Radial

Radial3D 

3D Radial

Represents the document part option.

Enumerator
WorkPart 

Work Part

NewAssembly 

New Assembly

Member Function Documentation

unsafe void NXOpen.Mechatronics.CamProfileDocumentationBuilder.AddSelectedParts ( NXOpen.Part[]  parts)
inline

Adds selected parts

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
partsthe parts used to add to find cam profile.
unsafe void NXOpen.Mechatronics.CamProfileDocumentationBuilder.DeleteRow ( int  index)
inline

Deletes a row.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
unsafe NXOpen.NXColor NXOpen.Mechatronics.CamProfileDocumentationBuilder.GetRowColor ( int  index)
inline

Gets row color.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
Returns
unsafe bool NXOpen.Mechatronics.CamProfileDocumentationBuilder.GetRowState ( int  index)
inline

Gets row state.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
Returns
unsafe void NXOpen.Mechatronics.CamProfileDocumentationBuilder.InsertRow ( int  pos,
NXOpen.NXObject  objectTag 
)
inline

Inserts a new row.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
pos
objectTag
unsafe void NXOpen.Mechatronics.CamProfileDocumentationBuilder.SetRowColor ( int  index,
NXOpen.NXColor  color 
)
inline

Sets row color.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
color
unsafe void NXOpen.Mechatronics.CamProfileDocumentationBuilder.SetRowState ( int  index,
bool  state 
)
inline

Sets row state.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
index
state

Property Documentation

unsafe NXOpen.Mechatronics.CamProfileDocumentationBuilder.CurveTypes NXOpen.Mechatronics.CamProfileDocumentationBuilder.CamCurveType
getset

Returns or sets the cam curve type .

Created in NX1847.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 bool NXOpen.Mechatronics.CamProfileDocumentationBuilder.CreateXYAxis
getset

Returns or sets the option to create axis.

Created in NX1847.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.CamProfileDocumentationBuilder.PartTypes NXOpen.Mechatronics.CamProfileDocumentationBuilder.DocumentPartType
getset

Returns or sets the document part option .

Created in NX1847.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.CamProfileDocumentationBuilder.Name
getset

Returns or sets the name.

Created in NX1847.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.Point NXOpen.Mechatronics.CamProfileDocumentationBuilder.Point
getset

Returns or sets the point.

Created in NX1847.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.CamProfileDocumentationBuilder.RadialCurveBaseRadius
get

Returns the radial curve base radius.

Created in NX1847.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

unsafe bool NXOpen.Mechatronics.CamProfileDocumentationBuilder.ShowAxisScale
getset

Returns or sets the option to show axis scale.

Created in NX1847.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 bool NXOpen.Mechatronics.CamProfileDocumentationBuilder.ShowPoints
getset

Returns or sets the option to show points.

Created in NX1847.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 bool NXOpen.Mechatronics.CamProfileDocumentationBuilder.ShowSegmentData
getset

Returns or sets the option to show segment data.

Created in NX1847.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.CamProfileDocumentationBuilder.XAxisLabel
getset

Returns or sets the x axis label.

Created in NX1847.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.CamProfileDocumentationBuilder.YAxisLabel
getset

Returns or sets the y axis label.

Created in NX1847.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.