CoreAPI.h

//
//  $Id: CoreAPI.h 6077 2022-03-22 11:30:05Z stefan.losch $
//  (c) ceapoint aec technologies GmbH
//



#pragma once


#include <basic/IProgressDelegate.h>
#include <model/IProject.h>
#include <model/IObject.h>

#include <domainDocuments/DocumentProject.h>
#include <domainDocuments/Document.h>

#include <domainQTO/QTOProject.h>
#include <domainQTO/ConstructionElement.h>


// test reading and parsing a json file with cache
//#define ENABLE_READJSON 1


namespace domainGeometry3D {
    class Project;
}


namespace domainBim
{

    class BimProject;

    class CoreAPI : public QObject, public basic::IProgressDelegate
    {
        Q_OBJECT

    public:

        static bool BLOCK_UNSAFE;


        CoreAPI::CoreAPI( BimProject* bimPrj, QObject* parent = 0);             
        virtual ~CoreAPI();

        BimProject* getBimProject() const { return _bimProject; }
        

    public slots:


#pragma region TOOLS

        QString addDays(QString dateStr, int nrDays);

        QString timeStamp( QString format = QString() );        

        int getCalendarWeek( QDateTime dt );

        QString format( double v, int dec = 2, QString frmt = "%L1", int fieldWidth = 10, QChar fillChar = QChar::Nbsp ) { return frmt.arg(v,fieldWidth,'f',dec,fillChar); }
        
        QString formatDateTime( QDateTime dt, QString formatstr = "iso" );
        
        QString createID();

        long calcHashcode( QString str );

        QString compressToIfcGuid(QString id);

        QString uncompressFromIfcGuid(QString ifcGuid);

        bool checkRegExp( QString value, QString pattern );

        double calcSlantedArea(QString objId, double angleMin = 0.0, double angleMax = 45.0);

        QVariantMap calcGpsCoordsByStation( QString objId, double station );

        QVariantMap calcGpsCoordsByModelCoords( double x, double y );

        QVariantMap calcModelCoordsByGpsCoords( double lat, double lon );

        QVariantMap calcGkCoordsByModelCoords( double x, double y, double z );

        QVariantMap calcModelCoordsByGkCoords( double r, double h );

        QVariantMap calcGkCoordsByGpsCoords( double lat, double lon );

        QVariantMap calcGpsCoordsByGkCoords( double rw, double hw );        

        QString idListToStr( QStringList idList );

        QStringList strToIdList( QString strIDList );
        

#pragma endregion

        
#pragma region TOOLS - FILES
        
        QVariantMap getFileInfo( QString filePath );

        QString getAbsolutePath( QString filePath );

        QString getBaseName( QString filePath );
                
        QString getFileName( QString filePath );
        



        /*
            test of caching a parsed json file
        */
#ifdef ENABLE_READJSON
        QVariantMap readJsonFromTextFile( QString filename, bool useCache = true, QString codec = QString() );
#endif
#pragma endregion


#pragma region APPLICATION

        QString getApplicationDirectory();

        QString getApplicationFilename();

        virtual QString getApplicationLanguage();

        QString getVersionAsString();

        int getVersionMAJOR();

        int getVersionMINOR();

        int getVersionBUILD();

        QVariantMap getVersion();

        bool requireVersion( int major, int minor, int patch );


#pragma endregion


#pragma region PROJECT

        QString getUserName();

        QString getProjectID();
        
        int getProjectVariantNumber();

        int getProjectVersionNumber();

        QString getProjectNumber();

        int setProjectNumber(QString s, bool overwriteExisting = false);        

        QString getProjectName();

        QString getProjectShortDescription();
        
        int setProjectShortDescription(QString s, bool overwriteExisting = false);
        
        QString getProjectLongDescription();

        int setProjectLongDescription(QString s, bool overwriteExisting = false);

        QString getProjectDirectory();
        

        QString getLocation();


        QVariantMap getProjectLocation() const;

        QVariantMap getCloudSettings();

        QVariantMap getProjectInfo();

#pragma endregion


#pragma region DOMAINS

        QString getDomainByElement( QString objId );

#pragma endregion


#pragma region PROPERTIES
        
        QVariant getPropertyValue(QString objId, QString propName, QString propType, bool inh = true ); // , bool evaluate = true, bool formatAsString = false );       

        QList<QVariant> getPropertyValuesByObject( QString objId, QString filterpattern = "*" );

        QVariant getPropertySource( QString objId, QString propName, QString propType, bool inh = true );


        QString getPropertyUnit(QString objId, QString propName, QString propType, bool inh = true );       


        QString getPropertyUnit( QString propName, QString propType );

        QVariant getPropertyValueByDate(QString objId, QString propName, QString propType, bool inh = true );

        QDateTime getPropertyLastDate(QString objId, QString propName, QString propType, bool inh = true );

        QDateTime getPropertyFirstDate(QString objId, QString propName, QString propType, bool inh /* = true */ );

        QVariantMap getPropertyDateListAsJSON( QString objId, QString propName, QString propType, bool inh = true );

        QVariantList getPropertyDateList(QString objectId, QString propertyBaseName, QString propertyType );

        QVariantMap getPropertyTypesByObject( QString objId, QString filterPattern = "*" );


        QVariantMap getPropertyTypesByDomain( QString domainName, QString filterPattern = "*" );


        QVariantMap getPropertyTypeMetaData( QString propName, QString propType );


        QList<QVariant> getPropertyTypeList( QString domain = "all", QString filterPattern = "*", bool activeOnly = false );


        QList<QVariant> getPropertyTypeListByObject( QString objId, QString filterPattern = "*" );


        bool isPropertyInherited(QString objId, QString propName, QString propType );


        QString getPropertyValueRange(QString idList, QString propName, QString propType, QString domainFilter = "geometry" );


        QStringList getPropertyValueList( QString propName, QString propType, int maxValues );


        QString getPropertyValueAsString(QString objId, QString propName, QString propType, bool inh = true );


        QVariant evaluateFormula( QString code, QString id, QString id_otherdomain = QString() );


        QString prepareJsCode( QString code, QString id, int dec = -1, QString frmt = "%L1", int fieldWidth = 10, QChar fillChar = QChar() );

        QStringList extractPropertyNames( const QString& code, const QString& startTag = "[[", const QString& endTag = "]]" );

#pragma endregion


#pragma region LINKS BETWEEN OBJECTS

        QStringList getLinkedObjects(QString objectIDList, QString resultDomains = "all", QString objectLookupDomains = "all");
        

        QStringList getTasksByObjectList(QString idList);
        
        QStringList getObjectsByTaskList(QString idList);
        

        QStringList getDocumentsByObjectList(QString idList);
        
        QStringList getObjectsByDocumentList(QString idList);


        QStringList getSectionsByObjectList(QString idList);
        
        QStringList getObjectsBySectionList(QString idList);


        QStringList getTypesByObjectList(QString idList);
        
        QStringList getObjectsByTypeList(QString idList);


        QStringList getResourcesByObjectList(QString idList);
        
        QStringList getObjectsByResourcesList(QString idList);


        QStringList getBoQItemsByObjectList(QString idList);                
        
        QStringList getObjectsByBoQItemList(QString idList);


        QStringList getPcItemsByObjectList(QString idList);             
        
        QStringList getObjectsByPcItemList(QString idList);

#pragma endregion


#pragma region OBJECT HIERARCHY

        QStringList getContainedElements(QString containerId, int maxDepth, bool loadExternal = true);

        int countContainedElements(QString containerId, int maxDepth, bool loadExternal = true);

        QString getParent(QString objId);

        QStringList getOpenings(QString objId);

        QStringList getParts(QString objId);

#pragma endregion


#pragma region STATUS

        bool isVisible(QString objId);

        bool isSelected(QString objId);
        
        bool isLocked(QString objId);

        bool isWired(QString objId);

#pragma endregion


#pragma region GEOMETRY

        QVariantList getPointList( QString objId );

#pragma endregion


#pragma region ALIGNMENTS / REGIONS

        QVariantMap getPointOnAlignmentAtStation( QString alignmentId, double d );

        double getStationOfProjectedPoint( QString alignmentId, double x, double y, double z = 0.0 );

        QStringList getRegionsOfAlignment( QString alignmentId );

        QVariantList getRangesOfRegion( QString alignmentID, QString regionID );


        double getValueOfAlignmentRegion( QString alignmentID, QString regionID );


#pragma endregion


#pragma region ACTIVITIES
    
        int getTaskMode(QString taskID);
        
        QString getTaskVisualisation(QString taskID);

        QString getTaskRestrictionsByTask(QString taskID);

#pragma endregion

#pragma region LINKRULES

        int updateRuleBasedLinks(QString domainName, bool visibleOnly = false);

        int removeRuleBasedLinks(QString domainName);

#pragma endregion

    protected:
        
        /*
        Get object, looks up also containers in project     
        */
        model::IContainerObject* getIContainerObject(const QString& id, model::eDomainType domainFilter = model::typeDomainAll );
        model::IContainer*       getIContainer(const QString& id, model::eDomainType domainFilter = model::typeDomainAll );
        model::Element*          getElement(const QString& id, model::eDomainType domainFilter = model::typeDomainAll );

        model::IProperty* _getProperty( QString objId, QString propName, QString propType, bool inh );
        QVariant _getPropertyValue( const QString& objId, const QString& propName, const QString& propType, bool inh, bool evaluate, bool formatAsString );

        /*
        Collect geometric elements and composite elements.
        */
        void collectGeoObjects( const QString& idList, QList<model::IObject*>& list );


    private:

        QList<QDateTime> _getPropertyDateList(const QString& objId, const QString& propBaseName, const QString& propType, const QTime& defaultTime );


        CoreAPI(QObject* parent = 0);
        
        BimProject* _bimProject;

#ifdef ENABLE_READJSON
        bool _firsttime;
        QVariantMap _fileCache;
#endif

    };

}