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.Optimization.DesignStudyBuilder Class Reference

Represents a NXOpen.Optimization.DesignStudyBuilder More...

Inheritance diagram for NXOpen.Optimization.DesignStudyBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _DesignStudyObjective
 Defined Objective Structure
 
struct  _DesignStudyVariable
 Defined variable structure
 
struct  DesignStudyObjective
 Defined Objective Structure More...
 
struct  DesignStudyVariable
 Defined variable structure More...
 

Public Types

enum  DesignStudyAttributeType { Expression, KFAttribute, GeometryParameter }
 Attribute type More...
 
enum  DesignStudyConstraintLimitType { Upper, Lower }
 Constraint limit type More...
 
enum  DesignStudyDistributeType { Uniform, Normal, Gamma }
 Distribution type More...
 

Public Member Functions

unsafe void BuildAllObjectives ()
 Build all the objectives More...
 
unsafe void BuildAllVariables ()
 Build all the variables More...
 
unsafe
NXOpen.Optimization.DesignStudyBuilder.DesignStudyObjective[] 
GetDesignStudyObjectives ()
 Returns the objectives More...
 
unsafe
NXOpen.Optimization.DesignStudyBuilder.DesignStudyVariable[] 
GetDesignStudyVariables ()
 Returns the variables More...
 
unsafe void RemoveAllObjectives ()
 Remove all the objectives More...
 
unsafe void RemoveAllVariables ()
 Remove all the variables More...
 
unsafe void RunDesignStudy ()
 Run design study process More...
 
unsafe void SetDesignStudyObjectives (string[] attributeNames, NXOpen.NXObject[] attributeObjects, NXOpen.Optimization.DesignStudyBuilder.DesignStudyAttributeType[] objectiveTypes, double[] warningLowerLimit, double[] warningUpperLimit, double[] failureLowerLimit, double[] failureUpperLimit)
 Sets the objectives More...
 
unsafe void SetDesignStudyVariables (string[] attributeNames, NXOpen.NXObject[] attributeObjects, NXOpen.Optimization.DesignStudyBuilder.DesignStudyAttributeType[] variableTypes, double[] variableLowerLimitValue, double[] variableUpperLimitValue, NXOpen.Optimization.DesignStudyBuilder.DesignStudyDistributeType[] distributeType, double[] locationParameter, double[] scaleParameter, double[] shapeParameter, int[] valuesCount)
 Sets the variables 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 IsShowGraph [get, set]
 Returns or sets the property - is show graph More...
 
unsafe bool IsUpdateDisp [get, set]
 Returns or sets the property - is update display More...
 
unsafe string StudyName [get, set]
 Returns or sets the study name which is unique in one part 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.Optimization.DesignStudyBuilder

To create a new instance of this class, use NXOpen.Optimization.DesignStudyCollection.CreateDesignStudyBuilder

Created in NX6.0.0

Member Enumeration Documentation

Attribute type

Enumerator
Expression 

Expression type

KFAttribute 

KF attribute type

GeometryParameter 

Geometry parameter type

Constraint limit type

Enumerator
Upper 

Upper limit type

Lower 

Lower limit type

Distribution type

Enumerator
Uniform 

Uniform distribution type

Normal 

Normal distribution type

Gamma 

Gamma distribution type

Member Function Documentation

unsafe void NXOpen.Optimization.DesignStudyBuilder.BuildAllObjectives ( )
inline

Build all the objectives

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.DesignStudyBuilder.BuildAllVariables ( )
inline

Build all the variables

Created in NX6.0.0

License requirements: None.

unsafe NXOpen.Optimization.DesignStudyBuilder.DesignStudyObjective [] NXOpen.Optimization.DesignStudyBuilder.GetDesignStudyObjectives ( )
inline

Returns the objectives

Created in NX6.0.0

License requirements: None.

Returns
Objectives
unsafe NXOpen.Optimization.DesignStudyBuilder.DesignStudyVariable [] NXOpen.Optimization.DesignStudyBuilder.GetDesignStudyVariables ( )
inline

Returns the variables

Created in NX6.0.0

License requirements: None.

Returns
Variables
unsafe void NXOpen.Optimization.DesignStudyBuilder.RemoveAllObjectives ( )
inline

Remove all the objectives

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.DesignStudyBuilder.RemoveAllVariables ( )
inline

Remove all the variables

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.DesignStudyBuilder.RunDesignStudy ( )
inline

Run design study process

Created in NX6.0.0

License requirements: None.

unsafe void NXOpen.Optimization.DesignStudyBuilder.SetDesignStudyObjectives ( string[]  attributeNames,
NXOpen.NXObject[]  attributeObjects,
NXOpen.Optimization.DesignStudyBuilder.DesignStudyAttributeType[]  objectiveTypes,
double[]  warningLowerLimit,
double[]  warningUpperLimit,
double[]  failureLowerLimit,
double[]  failureUpperLimit 
)
inline

Sets the objectives

Created in NX6.0.0

License requirements: None.

Parameters
attributeNamesObjective attribute name array
attributeObjectsObjective attribute object array
objectiveTypesObjective attribute type array
warningLowerLimitWarning lower limit
warningUpperLimitWarning upper limit
failureLowerLimitFailure lower limit
failureUpperLimitFailure upper limit
unsafe void NXOpen.Optimization.DesignStudyBuilder.SetDesignStudyVariables ( string[]  attributeNames,
NXOpen.NXObject[]  attributeObjects,
NXOpen.Optimization.DesignStudyBuilder.DesignStudyAttributeType[]  variableTypes,
double[]  variableLowerLimitValue,
double[]  variableUpperLimitValue,
NXOpen.Optimization.DesignStudyBuilder.DesignStudyDistributeType[]  distributeType,
double[]  locationParameter,
double[]  scaleParameter,
double[]  shapeParameter,
int[]  valuesCount 
)
inline

Sets the variables

Created in NX6.0.0

License requirements: None.

Parameters
attributeNamesVariable attribute name array
attributeObjectsVariable attribute object array
variableTypesVariable attribute type array
variableLowerLimitValueVariable lower limit value array
variableUpperLimitValueVariable upper limit value array
distributeTypeDistribute type
locationParameterLocation parameter
scaleParameterScale parameter
shapeParameterShape parameter
valuesCountValues count

Property Documentation

unsafe bool NXOpen.Optimization.DesignStudyBuilder.IsShowGraph
getset

Returns or sets the property - is show graph

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe bool NXOpen.Optimization.DesignStudyBuilder.IsUpdateDisp
getset

Returns or sets the property - is update display

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.Optimization.DesignStudyBuilder.StudyName
getset

Returns or sets the study name which is unique in one part

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.


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