AutomationAPI.h

//
//  $Id: AutomationAPI.h 4470 2021-02-04 17:33:12Z ansgar.horstmann $
//  (c) ceapoint aec technologies GmbH
//


#pragma once


#include "CoreAPI.h"


namespace domainBim
{

    class BimProject;

    class AutomationAPI : public CoreAPI
    {

        Q_OBJECT

    public:

        /*
        \param isAutomation Affects access rights
        */
        AutomationAPI( BimProject* bimPrj, bool isAutomation, QObject* parent = 0 );
        virtual ~AutomationAPI();
    public slots:


#pragma region FIND OBJECTS

        bool hasElement(QString id);

        QStringList getRootContainerList(QString modelName);            

        QString findContainerByName( const QString& parentId, const QString& name, const QString& lookupDomain = "all" );


        QString getContainerByName(QString parentId, QString name);


        bool isContainer( QString id );                 

        QVariantList findDocumentsByLocationGps( double lat, double lon, double distance, QStringList idList = QStringList() );

        QVariantList findDocumentsByLocationRangeGps( QStringList gpsCoordinates, double distance, QStringList idList = QStringList() );

        QVariantList findDocumentsByLocationGk( double rw, double hw, double distance, QStringList idList = QStringList() );

        QStringList findDocumentsByDate( QDateTime start, QDateTime end, QStringList idList = QStringList(), bool useRef = false );
        
        
#pragma endregion


#pragma region DOCUMENTS - SYNC, METADATA

        int synchronizeDocumentContainer( QString containerId, QScriptValue callback = QScriptValue(), bool blockExecution = false );

        void resetDocumentMetaData( QString objId );

#pragma endregion


#pragma region ACTIVITIES - TOOLS
        
        QVariantMap getVisualisationList();

        int setVisualisationByID( QString taskIDList, QString visID );

        int removeVisualisation( QString taskIDList );

        int setTaskMode( QString taskID, int mode );

        QVariantMap calcPropertyValuesOverTime( QString propName, QString propType, QVariantMap options );

#pragma endregion


#pragma region GEOMETRIC TOOLS
        

        int hasContact( QString objId1, QString objId2, QVariantMap options = QVariantMap() );

        QString createContactObject( QString parentId, QString objId1, QString objId2, QString matId, QVariantMap options = QVariantMap() );

        QStringList cutObject( QString parentId, QString objId, QVariantMap plane = QVariantMap() );

        
        QString mergeObjects( QString parentContainerId, QString idList, bool skipClosed = false, bool keepTransparency = false );


        bool isIncludedIn(QString objId1, QString objId2);

        int isPointIncludedIn(double x, double y, double z, QString objId, double tol = 1.e-5 );


        int checkIntersection( QString objId1, QString objId2, double tolerance = -0.00001 );

        int transformObject( QString objId, QString transformation );

        int setAsOpening( QString objId, QString openingIDList );

        QString getProjectionAsSvg( QString idList, QVariantMap options = QVariantMap() );


        double calcDistance( QString objId1, QString objId2 );


#pragma endregion


#pragma region SELECTION_SETS

        QString createSelectionSets( QString propertyTypes, QString rootName, QVariantMap config = QVariantMap() ); 
        
        QStringList getRootNodeListSelectionSets( QString domainFilter = "all" );

        int addToSelectionSetGeometry( QString setId, QString objectIDList );

        int removeFromSelectionSetGeometry( QString setId, QString objectIDList );
        
        QString createSelectionSet( QString name, QString parentID = QString() ); // , QString domain = "geometry" );

        bool removeSelectionSet( QString selsetID );

#pragma endregion


#pragma region MODELS

        QString getModelByName( QString name, QString domainFilter = "geometry" );
        
        QString getModelByElement( QString id, QString domainFilter = "all" );


        QString getRootContainerByName(QString modelName, QString rootContainerName);


        QStringList getModelListByName( QString name, QString domain = "geometry" );

        QStringList getModelListByDomain( QString domainFilter = "all" );
        
        QString getRootNodeByModel( QString modelId );

        QStringList getRootNodeListByDomain( QString domainFilter = "all" );        

        QString createModel(QString name, bool createRootC = true, QString domain = "geometry" );           


        QVariantMap getModelMetaData( QString modelId );
        

        int deleteModel( const QString& id );

#pragma endregion


#pragma region PROJECT

        void setCloudSettings( QVariantMap vm );

        void setTempValue( QString name, QVariant value );

        QVariant getTempValue( QString name );
        
        QStringList getListOfTempValues();

        void clearListOfTempValues();

#pragma endregion


#pragma region LINKED OBJECTS

        int setLinkedObjects( const QString& elementID, const QString& IDList );
        
        int removeAllLinkedObjects( QString id );

        int removeLinkedObjects( QString id, QString linkedIdList );

#pragma endregion


#pragma region PROPERTY TYPES

        int createPropertyType( const QString& propName, const QString& propDatatype, const QString& uomCode, bool isInh, int target, const QString& domainName = "all" );  

        int setPropertyTypeMetaData( QString pName, QString ptype, QVariantMap metadata );

        int deletePropertyType( QString propName, QString propDatatype, QString domainName = "all" );

        QList<QVariant> getPropertyTypeBookmarkList( );

        QVariantMap getPropertyTypeBookmarkByID( QString bookmarkId );

        int activatePropertyTypeBookmark( QString bkmId );

        bool setPropertyTypeActive(QString pName, QString ptype, QString domain, bool active);

        int setAllPropertyTypesActive();

        int removePropertyTypeBookmarkByID( QString bkmId );

        QString addPropertyTypeBookmark( QVariantMap bookmarkConfig);

#pragma endregion


#pragma region PROPERTIES

        int setPropertyValue( QString objId, QString propName, QString propDataType, QVariant value );

        int setPropertyValueRepository( QString objId, QString propName, QString propDataType, QVariant value, bool createType = true );
                
        int deleteProperty( QString objId, QString propName, QString propDatatype );
        
        QList<QVariant> getAvailablePropertyValues( QString propName, QString propDatatype, int maxValues, QString domainName = "geometry" );
        

        QList<QVariant> getPropertyValues( QString propName, QString propDatatype, int maxValues = 0, QString domainName = "all", bool getNullValues = false );
        
        QList<QVariant> getPropertyValuesByObjectList( 
                                        QString propName, 
                                        QString propDatatype, 
                                        bool checkInh, 
                                        QString objIdList, 
                                        int maxValues = 0, 
                                        QString domainName = "all",
                                        bool getNullValues = false );
        
        QVariantMap getPropertyListAsJSON( QVariantMap options );

        void setPropertyListAsJSON( QVariantMap propmap, QVariantMap opt );

#pragma endregion


#pragma region PROPERTY SCRIPTS

        QVariantMap getPropertyScriptList() const;

        QString getPropertyScriptCode( QString domain, QString pname, QString datatype ) const;

        QString getPropertyScriptFgColor( QString domain, QString pname, QString datatype ) const;

        QString getPropertyScriptBgColor( QString domain, QString pname, QString datatype ) const;

        int setPropertyScriptCode( QString domain, QString pname, QString datatype, QString code );

        int setPropertyScriptFgColor( QString domain, QString pname, QString datatype, QString code );

        int setPropertyScriptBgColor( QString domain, QString pname, QString datatype, QString code );

        QVariantMap addPropertyScript( QString domain, QString pname, QString datatype, QString code = QString() );
        
        int removePropertyScript( QString domain, QString pname, QString datatype );

        void propertyScriptClearCache();
        
        void propertyScriptClearCache( QString domain, QString pname, QString datatype );

        QVariantMap getPropertyScriptOptions( QString domain, QString pname, QString datatype );

        int setPropertyScriptOptions( QString domain, QString pname, QString datatype, QVariantMap opt );


#pragma endregion


#pragma region GEOMETRY - MATERIALS

        QString createMaterial( QString matXml, QString modelId = QString() );

        int deleteMaterial( QString matId );

        QStringList getMaterialList();

        QString getMaterialAsXmlByID( QString matId );

        QVariantMap getMaterial( const QString& matId );

        QString getMaterialIDByName( QString matName );

        void updateMaterial( QString matId, QString xmlMat );

        int setMaterialToObjects( QString matId, QString objectIds );

        int setTransparency( QString objectIds, float defaultTransparency = 0.95 );

        void resetMaterials( bool updateUI = true );

        void reorderElements();

#pragma endregion

        
#pragma region GEOMETRY - COLOR SCHEMA

        QString createColorSchema( QString setContainerId, QString name );

        QString createColorSchemaFromCurrentMaterials(QString name, bool updateExisting, QVariantMap options = QVariantMap() );

        int deleteColorSchema( QString namePattern );

        QStringList getColorSchemaList();

        QString getCurrentColorSchema();
        
        bool activateColorSchemaByName( QString name );

        
#pragma endregion


#pragma region GEOMETRY- WIREMODE

        void showWireModeSchema( QString name );

        void clearWireMode();

        void setObjectsToWireMode( QString ids, bool wired );

        QString createWireModeSchema( QString ids, QString wmName, bool overwrite = false );

        QString getWired();

        int countWired();


#pragma endregion


#pragma region BBOX

        double getBBoxMinX();

        double getBBoxMaxX();

        double getBBoxMinY();

        double getBBoxMaxY();

        double getBBoxMinZ();
        
        double getBBoxMaxZ();

        void updateBoundingBox3DView();

        int calcOOBB( QString objIdList, double eps = 0.001 );

        int updateOOBB( QString obIDList, double eps = 0.001 );

        int calcOOBBxy( QString objIdList, double eps = 0.001 );

        int updateOOBBxy( QString objIdList, double eps = 0.001 );
        
        QVariantMap getBoundingBoxCommon( QString objIdList );

        QVariantMap getOOBBCommon( QString objIdList );

        QVariantMap getOOBBxyCommon( QString objIdList );

        double checkOverlapOBB( QString id1, QString id2, double eps );

#pragma endregion

         
#pragma region CREATE / DELETE OBJECTS / GET OBJECTS        
    
        int startProjectTransaction( const QString& domain = "geometry" );

        int endProjectTransaction( const QString& domain = "geometry" );

        QString createObjectFromXml( const QString& parentId, const QString& objectXML );


        int deleteObjects( QString idList );


        void setName( QString objIdList, QString name );
        

        QString createObject( QString parentId, QString name );     

        QVariantMap getAsJSON( QString objId );

        int setAsComposite( const QString& id, bool composite );


#pragma endregion


#pragma region REGIONS OF ALIGNMENTS

        QString addRegionToAlignment( QString alignmentId, QVariantMap setting );

        int removeAllRegionsFromAlignment( QString alignmentId );

        int addRangeToRegion( QString regionId, double fromStation, double toStation, QString alignmentId = QString() );

        int removeRangeFromRegion( QString regionId, double fromStation, double toStation, QString alignmentId = QString() );

        int removeAllRangesFromRegion( QString regionId, QString alignmentId = QString() );

#pragma endregion


#pragma region FILE OPERATIONS

        int createDirectory( QString path, QString dirName );

        bool writeFile( QString filePath, const QString& content, const QString& encoding = QString() );

        
        bool appendToFile(QString filePath, const QString& content, const QString& encoding = QString() );

        bool removeFile(QString filePath);

        bool copyFile( QString fnFrom, QString fnTo );

        bool moveFile( QString fnFrom, QString fnTo );

        bool checkIfFileExists(QString filePath);

        bool openFile( QString filePath, const QString& encoding = QString() );
        
        bool writeToFile(QString content);

        bool closeFile();

        QStringList readTextFile( QString filename, bool ignoreLineBreakesInDoubleQuotes = false, QString codec = QString() );
        
        QString readTextFileAsString( QString filename, QString codec = QString() );

        QVariantMap readCsvFile( QString filename, QString delimiter = ";", QString quoteSign = "\"" );

        int csvOpen( QString filename, QString delimiter = ";", QString quoteSign = "\"" );

        QStringList csvNextLine( );

        bool csvHasNextLine();

        bool csvClose( );




        QString readImageFile( QString filename, QString targetFormat = "" );


        QVariantList getDirectoryEntryList( QString dirPath, bool filesOnly = false, QString orderBy = "Name" );


#pragma endregion


#pragma region DATABASE

        bool dbIsLocalCopy();

        QString dbGetFilepath() const;

        int dbOpen(const QVariant connectionData = QVariant());

        bool dbClose();

        void dbCheckIn();

        void dbCheckOut(const QStringList& propList);

        bool dbQueryExec(const QString& sqlQuery);

        QVariantMap dbQueryRecordset(const QString& sqlQuery, const QString& key, int maxNumberOfRows = 0 );

        bool dbEndQueryExec();

        bool dbQueryNext();

        QVariant dbQueryValue(int column);          

        QString dbQueryLastError();

        int setPropertyValueDB(const QString& objIdList, const QString& propName, const QString& propDataType, const QString& propDomain, const QVariant& value, bool createType = true);                   

        int writePropertyValueDB(const QString& objIdList, const QString& propName, const QString& propDataType, const QString& propDomain, const QVariant& value, bool createType = true );

        bool startTransaction();

        bool endTransaction();

        bool dbGetImmediateUpdate();

        void dbSetImmediateUpdate(bool);

        int dbClearCache( const QString& propName, const QString& propType );

        void dbClearCacheAll();

        int dbDeleteProperty( const QString& objIdList, const QString& propName, const QString& propType );

        int dbAssertTable( const QString& tableName, const QStringList& columnsList );

#pragma endregion


#pragma region OBJECT TOOLTIPS


        QStringList getListOfObjTooltips();                     

        void addObjectListToTooltip( QString idList, QString tooltipname );

        void removeObjectListFromTooltip( QString idList, QString tooltipname );


#pragma endregion


#pragma region LOCKING OF OBJECTS

        void lockObjects( QString idList );

        void unlockObjects( QString idList );

        void unlockAllObjects();

        QString getLocked();

        int countLocked();

#pragma endregion


#pragma region OBJECT ITERATOR

        void itClear();

        int itByFilter(QString propName, QString propDatatype, QString filterPattern, bool checkInh = true, QString domain = "geometry" );


        int itFilterByStatus(QString status, bool enabled = true, QString domain = "geometry");


        int itByObjectList( QString idList );

        QString itGetObjectList();

        bool itHasNext();

        QString itNext();

        int itCount();

        void itToFront();

        QList<QVariant> itGetAvailablePropertyValues(QString propName, QString propDatatype, int maxValues );

        void itSetupDbCache( QString propName, QString propType );

        void itSetMaterial(QString matId);

        void itColorCode( QString propName, QString propDT );

        void itColorCodeNumber( QString propName, QString propDT, double intervalSize );    

        void itCalcOOBB( double eps );

        void itUpdateOOBB( double eps );

        void itCalcOOBBxy( double eps );

        void itUpdateOOBBxy( double eps );

#pragma endregion

    private:    

        QFile*          _file;
        QTextStream*    _textstream;
        QFile*          _csvFile;
        QTextStream*    _csvTextStream;

        char            _c_delimiter;
        char            _c_quoteSign;
        bool            _isAutomation;

        /*
        Check if a given filePath actually contains a path, or just the filename.
        If path included: input unmodified, return true
        If path not included and project open: prepend project path to input, return true
        If path not included and no project open: input unmodified, return false

        \since 2.4.2, 2019-03-01, ah
        */
        bool _checkCompleteFilePath(QString& filePath);

    };

}