Optimization_OptimizationBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  JA API的C++接口头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Optimization_OptimizationBuilder.ja
//
//  生成工具:
//     apiwrap
//
//  警告:
//    此文件为自动生成，请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/Builder.hxx>
#include <NXOpen/libnxopencpp_optimization_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    namespace Optimization
    {
        class OptimizationBuilder;
    }
    class Builder;
    class NXObject;
    namespace Optimization
    {
        class _OptimizationBuilderBuilder;
        class OptimizationBuilderImpl;
        class NXOPENCPP_OPTIMIZATIONEXPORT  OptimizationBuilder : public NXOpen::Builder
        {
            public: enum OptimizationTargetType
            {
                OptimizationTargetTypeMinimum,
                OptimizationTargetTypeMaximum,
                OptimizationTargetTypeTarget
            };

            public: enum OptimizationAttributeType
            {
                OptimizationAttributeTypeExpression,
                OptimizationAttributeTypeKFAttribute,
                OptimizationAttributeTypeGeometryParameter
            };

            public: enum OptimizationConstraintLimitType
            {
                OptimizationConstraintLimitTypeUpper,
                OptimizationConstraintLimitTypeLower
            };

            public: enum OptimizationAlgorithmType
            {
                OptimizationAlgorithmTypeSimulatedAnnealing,
                OptimizationAlgorithmTypeGlobalSimplex,
                OptimizationAlgorithmTypePowell,
                OptimizationAlgorithmTypeConjugateGradient,
                OptimizationAlgorithmTypeLexicographic,
                OptimizationAlgorithmTypePatternSwarm
            };

            public: enum OptimizationConvergenceSpeedType
            {
                OptimizationConvergenceSpeedTypeSlow,
                OptimizationConvergenceSpeedTypeMedium,
                OptimizationConvergenceSpeedTypeFast,
                OptimizationConvergenceSpeedTypeInfinite
            };

            public:
            struct OptimizationObjective
            {
                public: NXString AttributeName;
                public: NXOpen::NXObject * AttributeObject;
                public: NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType ObjectiveType;
                public: double ObjectiveTargetValue;
                public: OptimizationObjective() :
                    AttributeName(),
                    AttributeObject(),
                    ObjectiveType((NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType)0),
                    ObjectiveTargetValue()
{
                }
                public: OptimizationObjective(const NXString &attributeNameInitial ,
                        NXOpen::NXObject * attributeObjectInitial ,
                        NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType objectiveTypeInitial ,
                        double objectiveTargetValueInitial ) :
                    AttributeName(attributeNameInitial),
                    AttributeObject(attributeObjectInitial),
                    ObjectiveType(objectiveTypeInitial),
                    ObjectiveTargetValue(objectiveTargetValueInitial)
                {
                }
            };

            public:
            struct OptimizationVariable
            {
                public: NXString AttributeName;
                public: NXOpen::NXObject * AttributeObject;
                public: NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType VariableType;
                public: double VariableLowerLimitValue;
                public: double VariableUpperLimitValue;
                public: OptimizationVariable() :
                    AttributeName(),
                    AttributeObject(),
                    VariableType((NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType)0),
                    VariableLowerLimitValue(),
                    VariableUpperLimitValue()
                {
                }
                public: OptimizationVariable(const NXString &attributeNameInitial ,
                        NXOpen::NXObject * attributeObjectInitial ,
                        NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType variableTypeInitial ,
                        double variableLowerLimitValueInitial ,
                        double variableUpperLimitValueInitial ) :
                    AttributeName(attributeNameInitial),
                    AttributeObject(attributeObjectInitial),
                    VariableType(variableTypeInitial),
                    VariableLowerLimitValue(variableLowerLimitValueInitial),
                    VariableUpperLimitValue(variableUpperLimitValueInitial)
                {
                }
            };

            public:
            struct OptimizationConstraint
            {
                public: NXString AttributeName;
                public: NXOpen::NXObject * AttributeObject;
                public: NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType ConstraintType;
                public: double ConstraintLowerLimitValue;
                public: double ConstraintUpperLimitValue;
                public: NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType ConstraintLimitType;
                public: OptimizationConstraint() :
                    AttributeName(),
                    AttributeObject(),
                    ConstraintType((NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType)0),
                    ConstraintLowerLimitValue(),
                    ConstraintUpperLimitValue(),
                    ConstraintLimitType((NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType)0)
                {
                }
                public: OptimizationConstraint(const NXString &attributeNameInitial ,
                        NXOpen::NXObject * attributeObjectInitial ,
                        NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType constraintTypeInitial ,
                        double constraintLowerLimitValueInitial ,
                        double constraintUpperLimitValueInitial ,
                        NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType constraintLimitTypeInitial ) :
                    AttributeName(attributeNameInitial),
                    AttributeObject(attributeObjectInitial),
                    ConstraintType(constraintTypeInitial),
                    ConstraintLowerLimitValue(constraintLowerLimitValueInitial),
                    ConstraintUpperLimitValue(constraintUpperLimitValueInitial),
                    ConstraintLimitType(constraintLimitTypeInitial)
                {
                }
            };
            private: OptimizationBuilderImpl * m_optimizationbuilder_impl;
            private: friend class  _OptimizationBuilderBuilder;
            protected: OptimizationBuilder();
            public: ~OptimizationBuilder();
            public: NXString StudyName
            (
            );
            public: void SetStudyName
            (
                const NXString & studyName 
            );
            void SetStudyName
            (
                const char * studyName 
            );
            public: NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType OptimizationType
            (
            );
            public: void SetOptimizationType
            (
                NXOpen::Optimization::OptimizationBuilder::OptimizationTargetType optimizationType 
            );
            public: NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType AlgorithmType
            (
            );
            public: void SetAlgorithmType
            (
                NXOpen::Optimization::OptimizationBuilder::OptimizationAlgorithmType algorithmType 
            );
            public: void RunOptimization
            (
            );
            public: NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType ConvergenceSpeedType
            (
            );
            public: void SetConvergenceSpeedType
            (
                NXOpen::Optimization::OptimizationBuilder::OptimizationConvergenceSpeedType convergenceSpeedType 
            );
            public: int MaxNumberIteration
            (
            );
            public: void SetMaxNumberIteration
            (
                int maxNumberIteration 
            );
            public: int MaxTime
            (
            );
            public: void SetMaxTime
            (
                int maxTime 
            );
            public: double AbsoluteConvergenceCriteria
            (
            );
            public: void SetAbsoluteConvergenceCriteria
            (
                double absoluteConvergenceCriteria 
            );
            public: double RelativeConvergenceCriteria
            (
            );
            public: void SetRelativeConvergenceCriteria
            (
                double relativeConvergenceCriteria 
            );
            public: bool IsUpdateDisp
            (
            );
            public: void SetUpdateDisp
            (
                bool isUpdateDisp 
            );
            public: bool IsShowGraph
            (
            );
            public: void SetShowGraph
            (
                bool isShowGraph 
            );
            public: std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationObjective> GetOptimizationObjectives
            (
            );
            public: void SetOptimizationObjectives
            (
                std::vector<NXString> & attributeNames ,
                const std::vector<NXOpen::NXObject *> & attributeObjects ,
                const std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType> & objectiveTypes ,
                const std::vector<double> & objectiveTargetValues 
            );
            public: std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationVariable> GetOptimizationVariables
            (
            );
            public: void SetOptimizationVariables
            (
                std::vector<NXString> & attributeNames ,
                const std::vector<NXOpen::NXObject *> & attributeObjects ,
                const std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType> & variableTypes ,
                const std::vector<double> & variableLowerLimitValue ,
                const std::vector<double> & variableUpperLimitValue 
            );
            public: std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationConstraint> GetOptimizationConstraints
            (
            );
            public: void SetOptimizationConstraints
            (
                std::vector<NXString> & attributeNames ,
                const std::vector<NXOpen::NXObject *> & attributeObjects ,
                const std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationAttributeType> & constraintTypes ,
                const std::vector<double> & constraintLowerLimitValue ,
                const std::vector<double> & constraintUpperLimitValue ,
                const std::vector<NXOpen::Optimization::OptimizationBuilder::OptimizationConstraintLimitType> & constraintLimitType 
            );
            public: void BuildAllObjectives
            (
            );
            public: void RemoveAllObjectives
            (
            );
            public: void BuildAllVariables
            (
            );
            public: void RemoveAllVariables
            (
            );
            public: void BuildAllConstraints
            (
            );
            public: void RemoveAllConstraints
            (
            );
        };
    }
}
#ifdef _MSC_VER
#pragma warning(pop)
#endif
#ifdef __GNUC__
#ifndef NX_NO_GCC_DEPRECATION_WARNINGS
#pragma GCC diagnostic warning "-Wdeprecated-declarations"
#endif
#endif
#undef EXPORTLIBRARY