Expression.hxx

//--------------------------------------------------------------------------
// Copyright 2024 Siemens
//--------------------------------------------------------------------------
//  C++与JA API接口的头文件
//--------------------------------------------------------------------------
//
//  源文件:
//     Expression.ja
//
//  生成方式:
//     apiwrap
//
//  警告:
//    本文件为自动生成 - 请勿手动编辑
//
#pragma once
#include <NXOpen/NXDeprecation.hxx>
#include <vector>
#include <NXOpen/NXString.hxx>
#include <NXOpen/Callback.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/NXObject.hxx>
#include <NXOpen/ugmath.hxx>
#include <NXOpen/libnxopencpp_exports.hxx>
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable:4996)
#endif
#ifdef __GNUC__
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
#endif
namespace NXOpen
{
    class Expression;
    namespace Features
    {
        class Feature;
    }
    class NXObject;
    class Unit;
    class _ExpressionBuilder;
    class ExpressionImpl;
    class NXOPENCPPEXPORT  Expression : public NXOpen::NXObject
    {
        public: enum UnitsOption
        {
            UnitsOptionBase,
            UnitsOptionExpression,
            UnitsOptionDataEntry,
            UnitsOptionInfo
        };

        public: enum StatusOption
        {
            StatusOptionOutOfDate,
            StatusOptionUpToDate,
            StatusOptionLocked,
            StatusOptionDelayed,
            StatusOptionBroken,
            StatusOptionUnknown
        };

        public: enum AttributeSourceType
        {
            AttributeSourceTypeObject,
            AttributeSourceTypePart
        };
        private: ExpressionImpl * m_expression_impl;
        private: friend class  _ExpressionBuilder;
        protected: Expression();
        public: ~Expression();
        public: NXString ExpressionString
        (
        );
        public: NXString Equation
        (
        );
        public: NXString GetFormula
        (
        );
        public: void SetFormula
        (
            const NXString & rightHandSide 
        );
        void SetFormula
        (
            const char * rightHandSide 
        );
        public: NXString RightHandSide
        (
        );
        public: void SetRightHandSide
        (
            const NXString & rightHandSide 
        );
        void SetRightHandSide
        (
            const char * rightHandSide 
        );
        public: double NumberValue
        (
        );
        public: void SetNumberValue
        (
            double expressionValue 
        );
        public: double Value
        (
        );
        public: void SetValue
        (
            double expressionValue 
        );
        public: void SetNumberValueWithUnits
        (
            double numberValue  ,
            NXOpen::Unit * units 
        );
        public: void GetNumberValueWithUnits
        (
            NXOpen::Expression::UnitsOption unitsOption ,
            double* numberValue  ,
            NXOpen::Unit ** unit 
        );
        public: NXString StringValue
        (
        );
        public: bool BooleanValue
        (
        );
        public: int IntegerValue
        (
        );
        public: NXOpen::Point3d PointValue
        (
        );
        public: NXOpen::Point3d GetPointValueWithUnits
        (
            NXOpen::Expression::UnitsOption unitsOption 
        );
        public: NXOpen::Vector3d VectorValue
        (
        );
        public: NXOpen::Vector3d GetVectorValueWithUnits
        (
            NXOpen::Expression::UnitsOption unitsOption 
        );
        public: bool IsUserLocked
        (
        );
        public: void SetUserLocked
        (
            bool isLocked 
        );
        public: bool GetPersistentlyLocked
        (
        );
        public: void SetPersistentlyLocked
        (
            bool isLocked 
        );
        public: void EditComment
        (
            const NXString & newComment 
        );
        void EditComment
        (
            const char * newComment 
        );
        public: bool IsGeometricExpression
        (
        );
        public: std::vector<NXOpen::Features::Feature *> GetUsingFeatures
        (
        );
        public: NXOpen::Features::Feature * GetOwningFeature
        (
        );
        public: NXOpen::Features::Feature * GetOwningRpoFeature
        (
        );
        public: NXString GetDescriptor
        (
        );
        public: NXOpen::Unit * Units
        (
        );
        public: void SetUnits
        (
            NXOpen::Unit * unitType 
        );
        public: NXString Type
        (
        );
        public: bool IsMeasurementExpression
        (
        );
        public: NXString Description
        (
        );
        public: std::vector<NXOpen::Expression *> GetReferencingExpressions
        (
        );
        public: bool IsNoEdit
        (
        );
        public: void SetNoEdit
        (
            bool isNoEdit 
        );
        public: bool IsNoUpdate
        (
        );
        public: void SetNoUpdate
        (
            bool isNoUpdate 
        );
        public: bool IsInterpartExpression
        (
        );
        public: void GetInterpartExpressionNames
        (
            NXString* partName  ,
            NXString* expName 
        );
        public: bool IsRightHandSideLockedFromEdit
        (
        );
        public: double GetValueUsingUnits
        (
            NXOpen::Expression::UnitsOption unitsOption 
        );
        public: NXOpen::Expression::StatusOption Status
        (
        );
        public: void MakeConstant
        (
        );
        public: bool IsUserSpecified
        (
        );
        public: void SetUserSpecified
        (
            bool isUserSpecified 
        );
        public: bool IsMassManagementExp
        (
        );
        public: void SetMassManagementExp
        (
            bool isMassManagementExp 
        );
        public: bool HasReferencedAttribute
        (
        );
        public: NXOpen::NXObject::AttributeInformation GetReferencedAttribute
        (
        );
        public: bool HasReferencingPartAttribute
        (
        );
        public: bool HasReferencingObjectAttribute
        (
        );
        public: bool GetReferencingAttribute
        (
            NXOpen::Expression::AttributeSourceType attributeSourceType ,
            NXOpen::NXObject::AttributeInformation* info 
        );
        public: bool GetReferencingPartOrObjectAttribute
        (
            NXOpen::Expression::AttributeSourceType* attributeSourceType ,
            NXOpen::NXObject::AttributeInformation* info 
        );
    };
}
#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