NXOpen::Optimization::DesignStudyBuilder Class Reference

Represents a Optimization::DesignStudyBuilder
To create a new instance of this class, use Optimization::DesignStudyCollection::CreateDesignStudyBuilder

Created in NX6.0.0. More...

Inheritance diagram for NXOpen::Optimization::DesignStudyBuilder:

Classes
struct	DesignStudyObjective
	Defined Objective Structure. More...
struct	DesignStudyVariable
	Defined variable structure. More...

Public Types
enum	DesignStudyAttributeType { DesignStudyAttributeTypeExpression, DesignStudyAttributeTypeKFAttribute, DesignStudyAttributeTypeGeometryParameter }
	Attribute type. More...
enum	DesignStudyConstraintLimitType { DesignStudyConstraintLimitTypeUpper, DesignStudyConstraintLimitTypeLower }
	Constraint limit type. More...
enum	DesignStudyDistributeType { DesignStudyDistributeTypeUniform, DesignStudyDistributeTypeNormal, DesignStudyDistributeTypeGamma }
	Distribution type. More...

Public Member Functions
void	BuildAllObjectives ()
	Build all the objectives Created in NX6.0.0.
void	BuildAllVariables ()
	Build all the variables Created in NX6.0.0.
std::vector < NXOpen::Optimization::DesignStudyBuilder::DesignStudyObjective >	GetDesignStudyObjectives ()
	Returns the objectives.
std::vector < NXOpen::Optimization::DesignStudyBuilder::DesignStudyVariable >	GetDesignStudyVariables ()
	Returns the variables.
bool	IsShowGraph ()
	Returns the property - is show graph Created in NX6.0.0.
bool	IsUpdateDisp ()
	Returns the property - is update display Created in NX6.0.0.
void	RemoveAllObjectives ()
	Remove all the objectives Created in NX6.0.0.
void	RemoveAllVariables ()
	Remove all the variables Created in NX6.0.0.
void	RunDesignStudy ()
	Run design study process Created in NX6.0.0.
void	SetDesignStudyObjectives (std::vector< NXString > &attributeNames, const std::vector< NXOpen::NXObject * > &attributeObjects, const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyAttributeType > &objectiveTypes, const std::vector< double > &warningLowerLimit, const std::vector< double > &warningUpperLimit, const std::vector< double > &failureLowerLimit, const std::vector< double > &failureUpperLimit)
	Sets the objectives Created in NX6.0.0.
void	SetDesignStudyVariables (std::vector< NXString > &attributeNames, const std::vector< NXOpen::NXObject * > &attributeObjects, const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyAttributeType > &variableTypes, const std::vector< double > &variableLowerLimitValue, const std::vector< double > &variableUpperLimitValue, const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyDistributeType > &distributeType, const std::vector< double > &locationParameter, const std::vector< double > &scaleParameter, const std::vector< double > &shapeParameter, const std::vector< int > &valuesCount)
	Sets the variables Created in NX6.0.0.
void	SetShowGraph (bool isShowGraph)
	Sets the property - is show graph Created in NX6.0.0.
void	SetStudyName (const NXString &studyName)
	Sets the study name which is unique in one part Created in NX6.0.0.
void	SetStudyName (const char *studyName)
	Sets the study name which is unique in one part Created in NX6.0.0.
void	SetUpdateDisp (bool isUpdateDisp)
	Sets the property - is update display Created in NX6.0.0.
NXString	StudyName ()
	Returns the study name which is unique in one part Created in NX6.0.0.
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br>    Use Tag instead.
tag_t	Tag () const
	Returns the tag of this object.

Detailed Description

Represents a Optimization::DesignStudyBuilder
To create a new instance of this class, use Optimization::DesignStudyCollection::CreateDesignStudyBuilder

Created in NX6.0.0.

Member Enumeration Documentation

enum NXOpen::Optimization::DesignStudyBuilder::DesignStudyAttributeType

Attribute type.

Enumerator:

DesignStudyAttributeTypeExpression	Expression type.
DesignStudyAttributeTypeKFAttribute	KF attribute type.
DesignStudyAttributeTypeGeometryParameter	Geometry parameter type.

enum NXOpen::Optimization::DesignStudyBuilder::DesignStudyConstraintLimitType

Constraint limit type.

Enumerator:

DesignStudyConstraintLimitTypeUpper	Upper limit type.
DesignStudyConstraintLimitTypeLower	Lower limit type.

enum NXOpen::Optimization::DesignStudyBuilder::DesignStudyDistributeType

Distribution type.

Enumerator:

DesignStudyDistributeTypeUniform	Uniform distribution type.
DesignStudyDistributeTypeNormal	Normal distribution type.
DesignStudyDistributeTypeGamma	Gamma distribution type.

Member Function Documentation

void NXOpen::Optimization::DesignStudyBuilder::BuildAllObjectives

(

)

Build all the objectives
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::DesignStudyBuilder::BuildAllVariables

(

)

Build all the variables
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::Optimization::DesignStudyBuilder::DesignStudyObjective> NXOpen::Optimization::DesignStudyBuilder::GetDesignStudyObjectives

(

)

Returns the objectives.

Returns

Objectives
Created in NX6.0.0.

License requirements : None

std::vector<NXOpen::Optimization::DesignStudyBuilder::DesignStudyVariable> NXOpen::Optimization::DesignStudyBuilder::GetDesignStudyVariables

(

)

Returns the variables.

Returns

Variables
Created in NX6.0.0.

License requirements : None

bool NXOpen::Optimization::DesignStudyBuilder::IsShowGraph

(

)

Returns the property - is show graph
Created in NX6.0.0.

License requirements : None

bool NXOpen::Optimization::DesignStudyBuilder::IsUpdateDisp

(

)

Returns the property - is update display
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::DesignStudyBuilder::RemoveAllObjectives

(

)

Remove all the objectives
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::DesignStudyBuilder::RemoveAllVariables

(

)

Remove all the variables
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::DesignStudyBuilder::RunDesignStudy

(

)

Run design study process
Created in NX6.0.0.

License requirements : None

void NXOpen::Optimization::DesignStudyBuilder::SetDesignStudyObjectives	(	std::vector< NXString > &	attributeNames,
		const std::vector< NXOpen::NXObject * > &	attributeObjects,
		const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyAttributeType > &	objectiveTypes,
		const std::vector< double > &	warningLowerLimit,
		const std::vector< double > &	warningUpperLimit,
		const std::vector< double > &	failureLowerLimit,
		const std::vector< double > &	failureUpperLimit
	)

Sets the objectives
Created in NX6.0.0.

License requirements : None

Parameters

attributeNames	Objective attribute name array NOTE: The full Unicode character set is not supported for this parameter.
attributeObjects	Objective attribute object array
objectiveTypes	Objective attribute type array
warningLowerLimit	Warning lower limit
warningUpperLimit	Warning upper limit
failureLowerLimit	Failure lower limit
failureUpperLimit	Failure upper limit

void NXOpen::Optimization::DesignStudyBuilder::SetDesignStudyVariables	(	std::vector< NXString > &	attributeNames,
		const std::vector< NXOpen::NXObject * > &	attributeObjects,
		const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyAttributeType > &	variableTypes,
		const std::vector< double > &	variableLowerLimitValue,
		const std::vector< double > &	variableUpperLimitValue,
		const std::vector< NXOpen::Optimization::DesignStudyBuilder::DesignStudyDistributeType > &	distributeType,
		const std::vector< double > &	locationParameter,
		const std::vector< double > &	scaleParameter,
		const std::vector< double > &	shapeParameter,
		const std::vector< int > &	valuesCount
	)

Sets the variables
Created in NX6.0.0.

License requirements : None

Parameters

attributeNames	Variable attribute name array NOTE: The full Unicode character set is not supported for this parameter.
attributeObjects	Variable attribute object array
variableTypes	Variable attribute type array
variableLowerLimitValue	Variable lower limit value array
variableUpperLimitValue	Variable upper limit value array
distributeType	Distribute type
locationParameter	Location parameter
scaleParameter	Scale parameter
shapeParameter	Shape parameter
valuesCount	Values count

void NXOpen::Optimization::DesignStudyBuilder::SetShowGraph

(

bool

isShowGraph

)

Sets the property - is show graph
Created in NX6.0.0.

License requirements : None

Parameters

isShowGraph

isshowgraph

void NXOpen::Optimization::DesignStudyBuilder::SetStudyName

(

const NXString &

studyName

)

Sets the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

Parameters

studyName

studyname

void NXOpen::Optimization::DesignStudyBuilder::SetStudyName

(

const char *

studyName

)

Sets the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

Parameters

studyName

studyname

void NXOpen::Optimization::DesignStudyBuilder::SetUpdateDisp

(

bool

isUpdateDisp

)

Sets the property - is update display
Created in NX6.0.0.

License requirements : None

Parameters

isUpdateDisp

isupdatedisp

NXString NXOpen::Optimization::DesignStudyBuilder::StudyName

(

)

Returns the study name which is unique in one part
Created in NX6.0.0.

License requirements : None

---

The documentation for this class was generated from the following file:

• Optimization_DesignStudyBuilder.hxx