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

Represents a NXOpen.Mechatronics.ExpressionBlockBuilder builder. More...

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

Classes

struct  _Slot
 Represents Slot definition structure.
 
struct  Slot
 Represents Slot definition structure. More...
 

Public Types

enum  DataType { Bool, Int, Double }
 Represents the data type. More...
 
enum  SlotType {
  None = -1, Input, Output, Param,
  State, Custom, Num
}
 Represents the Slot type. More...
 

Public Member Functions

unsafe string[] GetDescription ()
 Gets description lines. More...
 
unsafe
NXOpen.Mechatronics.ExpressionBlockBuilder.Slot[] 
GetSlots ()
 Gets all Slots. More...
 
unsafe void LoadFromXmlFile (string templateFile)
 Load data from xml file. More...
 
unsafe void SaveToXmlFile (string templateFile)
 Save data to xml file. More...
 
unsafe void SetDescription (string[] descLines)
 Sets description lines. More...
 
unsafe void SetSlots (NXOpen.Mechatronics.ExpressionBlockBuilder.Slot[] slots)
 Sets all Slots. 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...
 

Additional Inherited Members

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

Detailed Description

Represents a NXOpen.Mechatronics.ExpressionBlockBuilder builder.

ExpressionBlockBuilder is used to maintain the NXOpen.Mechatronics.ExpressionBlockObject which is used store related expressions that work for same task.

To create a new instance of this class, use NXOpen.Mechatronics.ExpressionBlockCollection.CreateExpressionBlockBuilder

Created in NX11.0.0

Member Enumeration Documentation

Represents the data type.

Enumerator
Bool 

bool

Int 

int

Double 

double

Represents the Slot type.

Enumerator
None 

None

Input 

Input that should connect to runtime parameter as input value.

Output 

Output that should connect to runtime parameter to output value

Param 

Param that is used to configure the block to differentiate mode

State 

State that is change during runtime based on internal data

Custom 

Custom that represents the user created temporary variable

Num 

Total Num

Member Function Documentation

unsafe string [] NXOpen.Mechatronics.ExpressionBlockBuilder.GetDescription ( )
inline

Gets description lines.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Returns
unsafe NXOpen.Mechatronics.ExpressionBlockBuilder.Slot [] NXOpen.Mechatronics.ExpressionBlockBuilder.GetSlots ( )
inline

Gets all Slots.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Returns
Array of Slots
unsafe void NXOpen.Mechatronics.ExpressionBlockBuilder.LoadFromXmlFile ( string  templateFile)
inline

Load data from xml file.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
templateFile
unsafe void NXOpen.Mechatronics.ExpressionBlockBuilder.SaveToXmlFile ( string  templateFile)
inline

Save data to xml file.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
templateFile
unsafe void NXOpen.Mechatronics.ExpressionBlockBuilder.SetDescription ( string[]  descLines)
inline

Sets description lines.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
descLines
unsafe void NXOpen.Mechatronics.ExpressionBlockBuilder.SetSlots ( NXOpen.Mechatronics.ExpressionBlockBuilder.Slot[]  slots)
inline

Sets all Slots.

Created in NX11.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
slotsArray of Slots

Property Documentation

unsafe string NXOpen.Mechatronics.ExpressionBlockBuilder.Name
getset

Returns or sets the name.

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