Motion_MechatronicsBuilder.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
// C++接口到JA API的头文件
//--------------------------------------------------------------------------
//
// 源文件:
//     Motion_MechatronicsBuilder.ja
//
// 生成工具:
//     apiwrap
//
// 警告:
//    此文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/ExternalFileReferenceAdapter.hxx>
#include <NXOpen/Motion_ConfigurationParameter.hxx>
#include <NXOpen/Motion_InputPortAssociation.hxx>
#include <NXOpen/Motion_OutputPortAssociation.hxx>
#include <NXOpen/Motion_PortVariable.hxx>
#include <NXOpen/IExternalFileReferencer.hxx>
#include <NXOpen/Motion_MotionBuilder.hxx>
#include <NXOpen/ObjectList.hxx>
#include <NXOpen/libnxopencpp_motion_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 Motion
    {
        class MechatronicsBuilder;
    }
    class Expression;
    class ExternalFileReferenceAdapter;
    class IExternalFileReferencer;
    namespace Motion
    {
        class ConfigurationParameter;
    }
    namespace Motion
    {
        class ConfigurationParameterList;
    }
    namespace Motion
    {
        class InputPortAssociation;
    }
    namespace Motion
    {
        class InputPortAssociationList;
    }
    namespace Motion
    {
        class MotionBuilder;
    }
    namespace Motion
    {
        class OutputPortAssociation;
    }
    namespace Motion
    {
        class OutputPortAssociationList;
    }
    namespace Motion
    {
        class PortVariable;
    }
    namespace Motion
    {
        class PortVariableList;
    }
    namespace Motion
    {
        class _MechatronicsBuilderBuilder;
        class MechatronicsBuilderImpl;
        class NXOPENCPP_MOTIONEXPORT  MechatronicsBuilder : public NXOpen::Motion::MotionBuilder, public virtual NXOpen::IExternalFileReferencer
        {
            public: enum MechatronicsModelType
            {
                MechatronicsModelTypeAmesim ,
                MechatronicsModelTypeSimulink ,
                MechatronicsModelTypeGeneric ,
                MechatronicsModelTypeFmi
            };

            public: enum PurposeType
            {
                PurposeTypeImport ,
                PurposeTypeExport
            };

            public: enum SolverIntegrationType
            {
                SolverIntegrationTypeCoSimulation ,
                SolverIntegrationTypeModelExchange
            };

            public: enum SolverSimulationType
            {
                SolverSimulationTypeCoSimulation ,
                SolverSimulationTypeModelExchange
            };

            public: enum SolverCommunicationIntervalType
            {
                SolverCommunicationIntervalTypeConstant ,
                SolverCommunicationIntervalTypeVariable
            };

            public: enum SolverCommunicationRunType
            {
                SolverCommunicationRunTypeSerial ,
                SolverCommunicationRunTypeParallel
            };

public: enum Main
            {
                MainNo ,
                MainYes
            };

            public: enum ReferenceObjectId
            {
                ReferenceObjectIdModalFile ,
                ReferenceObjectIdHeaderFile ,
                ReferenceObjectIdParameterFile
            };
            private: MechatronicsBuilderImpl * m_mechatronicsbuilder_impl;
            private: friend class  _MechatronicsBuilderBuilder;
            protected: MechatronicsBuilder();
            public: ~MechatronicsBuilder();
            public: NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType MechatronicsType
            (
            );
            public: void SetMechatronicsType
            (
                NXOpen::Motion::MechatronicsBuilder::MechatronicsModelType mechatronicsType 
            );
            public: NXOpen::Motion::MechatronicsBuilder::PurposeType Purpose
            (
            );
            public: void SetPurpose
            (
                NXOpen::Motion::MechatronicsBuilder::PurposeType purpose 
            );
            public: NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType CommunicationIntervalType
            (
            );
            public: void SetCommunicationIntervalType
            (
                NXOpen::Motion::MechatronicsBuilder::SolverCommunicationIntervalType communicationIntervalType 
            );
            public: NXOpen::Expression * CommunicationInterval
            (
            );
            public: void SetCommunicationInterval
            (
                NXOpen::Expression * communicationInterval 
            );
            public: NXString Name
            (
            );
            public: void SetName
            (
                const NXString & name 
            );
            void SetName
            (
                const char * name 
            );
            public: NXString ActiveParameterGroupName
            (
            );
            public: void SetActiveParameterGroupName
            (
                const NXString & name 
            );
            void SetActiveParameterGroupName
            (
                const char * name 
            );
            public: NXString ActivePortVariableGroupName
            (
            );
            public: void SetActivePortVariableGroupName
            (
                const NXString & name 
            );
            void SetActivePortVariableGroupName
            (
                const char * name 
            );
            public: void ReadInterfaceFromFile
            (
                const NXString & filePath 
            );
            void ReadInterfaceFromFile
            (
                const char * filePath 
            );
            public: void RefreshLists
            (
            );
            public: std::vector<NXString> GetParameterGroupNames
            (
            );
            public: std::vector<NXString> GetPortVariableGroupNames
            (
            );
            public: NXOpen::Motion::InputPortAssociation * GetInput
            (
                const NXString & inputName 
            );
            NXOpen::Motion::InputPortAssociation * GetInput
            (
                const char * inputName 
            );
            public: NXOpen::Motion::OutputPortAssociation * GetOutput
            (
                const NXString & inputName 
            );
            NXOpen::Motion::OutputPortAssociation * GetOutput
            (
                const char * inputName 
            );
            public: NXOpen::Motion::PortVariable * GetPortVariable
            (
                const NXString & inputName 
            );
            NXOpen::Motion::PortVariable * GetPortVariable
            (
                const char * inputName 
            );
            public: NXOpen::Motion::ConfigurationParameter * GetConfigurationParameter
            (
                const NXString & inputName 
            );
            NXOpen::Motion::ConfigurationParameter * GetConfigurationParameter
            (
                const char * inputName 
            );
            public: NXOpen::Motion::InputPortAssociationList * InputPortsListAmesimAndSimulink
            (
            );
            public: NXOpen::Motion::InputPortAssociationList * InputPortsListGeneric
            (
            );
            public: NXOpen::Motion::InputPortAssociationList * InputPortsListFMI
            (
            );
            public: NXOpen::Motion::OutputPortAssociationList * OutputPortsListAmesimAndSimulink
            (
            );
            public: NXOpen::Motion::OutputPortAssociation * NewOutputListItem
            (
            );
            public: NXOpen::Motion::OutputPortAssociationList * OutputPortsListGeneric
            (
            );
            public: NXOpen::Motion::OutputPortAssociationList * OutputPortsListFMI
            (
            );
            public: NXOpen::Motion::InputPortAssociationList * InputPortsListExport
            (
            );
            public: NXOpen::Motion::OutputPortAssociationList * OutputPortsListExport
            (
            );
            public: NXOpen::Motion::InputPortAssociation * NewInputListItem
            (
            );
            public: NXOpen::Motion::ConfigurationParameterList * ConfigurationParametersList
            (
            );
            public: NXOpen::Motion::PortVariableList * PortVariablesList
            (
            );
            public: NXOpen::Motion::MechatronicsBuilder::SolverCommunicationRunType CommunicationRunType
            (
            );
            public: void SetCommunicationRunType
            (
                NXOpen::Motion::MechatronicsBuilder::SolverCommunicationRunType communicationRunType 
            );
            public: NXOpen::Motion::MechatronicsBuilder::Main IsMain
            (
            );
            public: void SetMain
            (
                NXOpen::Motion::MechatronicsBuilder::Main isMain 
            );
            public: NXString FunctionName
            (
            );
            public: void SetFunctionName
            (
                const NXString & functionName 
            );
            void SetFunctionName
            (
                const char * functionName 
            );
            public: int NumSolveIterations
            (
            );
            public: void SetNumSolveIterations
            (
                int numSolveIterations 
            );
            public: virtual NXOpen::ExternalFileReferenceAdapter * GetExternalFileReferenceAdapter
            (
                int referenceObjectId 
            );
            public: virtual void SetExternalFileReferenceAdapter
            (
                int referenceObjectId ,
                NXOpen::ExternalFileReferenceAdapter * adapter 
            );
            public: virtual NXString GetExternalFileDefinitionKey
            (
                NXOpen::ExternalFileReferenceAdapter * adapter 
            );
            public: virtual NXOpen::ExternalFileReferenceAdapter * EstablishReference
            (
                int referenceObjectId ,
                NXOpen::ExternalFileReferenceAdapter::Type referenceType ,
                const NXString & externalFileSpec 
            );
            virtual NXOpen::ExternalFileReferenceAdapter * EstablishReference
            (
                int referenceObjectId ,
                NXOpen::ExternalFileReferenceAdapter::Type referenceType ,
                const char * externalFileSpec 
            );
        };
    }
}
#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