NXOpen .NET Reference  12.0.0
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Mechatronics.ParameterStockBuilder Class Reference

Represents a NXOpen.Mechatronics.ParameterStockBuilder builder. More...

Inheritance diagram for NXOpen.Mechatronics.ParameterStockBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  DataType {
  Bool, Int, Real, String,
  List
}
 the data type for parameter value. More...
 
enum  Assignment { None, ByOrder, Random }
 the assignment for runtime property. More...
 

Public Member Functions

unsafe void AddBoolParameter (string name, bool value, bool predefined, bool readOnly)
 Adds Bool parameter. More...
 
unsafe void AddIntParameter (string name, int value, bool predefined, bool readOnly)
 Adds Int parameter. More...
 
unsafe void AddRealParameter (string name, double value, NXOpen.Unit unit, bool predefined, bool readOnly)
 Adds Real parameter. More...
 
unsafe void AddStringParameter (string name, string value, bool predefined, bool readOnly)
 Adds String parameter. More...
 
unsafe void AddListParameter (string name, string[] values, NXOpen.Mechatronics.ParameterStockBuilder.Assignment eAssignment, bool predefined, bool readOnly)
 Adds List parameter. More...
 
unsafe string[] GetParameterNamesAndTypes (out NXOpen.Mechatronics.ParameterStockBuilder.DataType[] types)
 Gets parameter names and types. More...
 
unsafe bool GetBoolParameter (string name, out bool predefined, out bool readOnly)
 Gets bool parameter value. More...
 
unsafe int GetIntParameter (string name, out bool predefined, out bool readOnly)
 Gets int parameter value. More...
 
unsafe double GetRealParameter (string name, out NXOpen.Unit unit, out bool predefined, out bool readOnly)
 Gets real parameter value. More...
 
unsafe string GetStringParameter (string name, out bool predefined, out bool readOnly)
 Gets string parameter value. More...
 
unsafe string[] GetListParameter (string name, out NXOpen.Mechatronics.ParameterStockBuilder.Assignment eAssignment, out bool predefined, out bool readOnly)
 Gets list parameter value. More...
 
unsafe void EditBoolParameter (string name, bool value)
 Edits bool parameter value. More...
 
unsafe void EditIntParameter (string name, int value)
 Edits Int parameter. More...
 
unsafe void EditRealParameter (string name, double value, NXOpen.Unit unit)
 Edits Real parameter. More...
 
unsafe void EditStringParameter (string name, string value)
 Edits String parameter. More...
 
unsafe void EditListParameter (string name, string[] values, NXOpen.Mechatronics.ParameterStockBuilder.Assignment eAssignment)
 Edits List parameter. More...
 
unsafe void DeleteParameter (string name)
 Delete parameter. 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...
 

Properties

unsafe string ApplicationName [get, set]
 Returns or sets the application name. More...
 

Detailed Description

Represents a NXOpen.Mechatronics.ParameterStockBuilder builder.

This class is sub-object of another builder, and cannot be directly instantiated.

Created in NX10.0.0

Member Enumeration Documentation

the assignment for runtime property.

Enumerator
None 

None

ByOrder 

By order

Random 

Random

the data type for parameter value.

Enumerator
Bool 

Bool

Int 

Int

Real 

Real

String 

String

List 

Enumeration

Member Function Documentation

unsafe void NXOpen.Mechatronics.ParameterStockBuilder.AddBoolParameter ( string  name,
bool  value,
bool  predefined,
bool  readOnly 
)

Adds Bool parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
predefined
readOnly
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.AddIntParameter ( string  name,
int  value,
bool  predefined,
bool  readOnly 
)

Adds Int parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
predefined
readOnly
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.AddListParameter ( string  name,
string[]  values,
NXOpen.Mechatronics.ParameterStockBuilder.Assignment  eAssignment,
bool  predefined,
bool  readOnly 
)

Adds List parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
values
eAssignment
predefined
readOnly
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.AddRealParameter ( string  name,
double  value,
NXOpen.Unit  unit,
bool  predefined,
bool  readOnly 
)

Adds Real parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
unit
predefined
readOnly
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.AddStringParameter ( string  name,
string  value,
bool  predefined,
bool  readOnly 
)

Adds String parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
predefined
readOnly
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.DeleteParameter ( string  name)

Delete parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.EditBoolParameter ( string  name,
bool  value 
)

Edits bool parameter value.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.EditIntParameter ( string  name,
int  value 
)

Edits Int parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.EditListParameter ( string  name,
string[]  values,
NXOpen.Mechatronics.ParameterStockBuilder.Assignment  eAssignment 
)

Edits List parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
values
eAssignment
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.EditRealParameter ( string  name,
double  value,
NXOpen.Unit  unit 
)

Edits Real parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
unit
unsafe void NXOpen.Mechatronics.ParameterStockBuilder.EditStringParameter ( string  name,
string  value 
)

Edits String parameter.

Created in NX10.0.0

License requirements: nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
name
value
unsafe bool NXOpen.Mechatronics.ParameterStockBuilder.GetBoolParameter ( string  name,
out bool  predefined,
out bool  readOnly 
)

Gets bool parameter value.

Created in NX10.0.0

License requirements: None.

Parameters
name
Returns
Parameters
predefined
readOnly
unsafe int NXOpen.Mechatronics.ParameterStockBuilder.GetIntParameter ( string  name,
out bool  predefined,
out bool  readOnly 
)

Gets int parameter value.

Created in NX10.0.0

License requirements: None.

Parameters
name
Returns
Parameters
predefined
readOnly
unsafe string [] NXOpen.Mechatronics.ParameterStockBuilder.GetListParameter ( string  name,
out NXOpen.Mechatronics.ParameterStockBuilder.Assignment  eAssignment,
out bool  predefined,
out bool  readOnly 
)

Gets list parameter value.

Created in NX10.0.0

License requirements: None.

Parameters
name
Returns
Parameters
eAssignment
predefined
readOnly
unsafe string [] NXOpen.Mechatronics.ParameterStockBuilder.GetParameterNamesAndTypes ( out NXOpen.Mechatronics.ParameterStockBuilder.DataType[]  types)

Gets parameter names and types.

Created in NX10.0.0

License requirements: None.

Returns
Parameters
types
unsafe double NXOpen.Mechatronics.ParameterStockBuilder.GetRealParameter ( string  name,
out NXOpen.Unit  unit,
out bool  predefined,
out bool  readOnly 
)

Gets real parameter value.

Created in NX10.0.0

License requirements: None.

Parameters
name
Returns
Parameters
unit
predefined
readOnly
unsafe string NXOpen.Mechatronics.ParameterStockBuilder.GetStringParameter ( string  name,
out bool  predefined,
out bool  readOnly 
)

Gets string parameter value.

Created in NX10.0.0

License requirements: None.

Parameters
name
Returns
Parameters
predefined
readOnly

Property Documentation

unsafe string NXOpen.Mechatronics.ParameterStockBuilder.ApplicationName
getset

Returns or sets the application name.

Created in NX10.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 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.