RailwayRouteOptimization/scripts/simple_transaction.js

/**
 * Simple Transaction API, mainly designed for use in the ECMAScript console.
 */

/**
 * Starts a transaction. This can increase performance when adding multiple entities.
 * Entities are added in one transaction when endTransaction is called.
 * \ingroup ecma_simple
 *
 * \param d RDocument or RDocumentInterface to apply the transaction to
 * (defaults to current document).
 *
 * \code
 * startTransaction();
 * for (...) {
 *     addLine(...);
 * }
 * endTransaction();
 * \endcode
 */
function startTransaction(d) {
    __simpleUseOp = true;
    if (isOfType(d, RDocument)) {
        __simpleDoc = d;
        __simpleDi = undefined;
    }
    if (isOfType(d, RDocumentInterface)) {
        __simpleDi = d;
        __simpleDoc = d.getDocument();
    }

    if (!isNull(__simpleOp)) {
        destr(__simpleOp);
        __simpleOp = undefined;
    }

    return true;
}

/**
 * Ends a transaction.
 * \see startTransaction
 * \ingroup ecma_simple
 *
 * \return RTransaction object containing information about the transaction.
 */
function endTransaction() {
    var ret = undefined;
    if (!isNull(__simpleOp)) {

        // apply operation to document interface:
        if (!isNull(__simpleDi)) {
            __simpleDi.applyOperation(__simpleOp);
            __simpleDi = undefined;
            __simpleDoc = undefined;
        }

        // apply operation to off-screen document:
        else if (!isNull(__simpleDoc)) {
            ret = __simpleOp.apply(__simpleDoc);
            __simpleDoc = undefined;
        }

        // apply operation to current document:
        else {
            var di = getDocumentInterface();
            if (!isNull(di)) {
                ret = di.applyOperation(__simpleOp);
            }
        }
        __simpleOp = undefined;
    }
    __simpleUseOp = false;
    return ret;
}

/**
 * Returns the RDocument the current transaction applies to or the current document or undefined.
 * \ingroup ecma_simple
 */
function getTransactionDocument() {
    if (!isNull(__simpleDoc)) {
        return __simpleDoc;
    }
    else {
        return getDocument();
    }
}

function getAssignTransactionDocument(fileType) {
    if (!isNull(__simpleDoc)) {
        return __simpleDoc;
    }
    else {
        return getAssignDocument(fileType);
    }
}


/**
 * Returns the RDocumentInterface the current transaction applies to or
 * the current document interface or undefined.
 * \ingroup ecma_simple
 */
function getTransactionDocumentInterface() {
    if (!isNull(__simpleDi)) {
        return __simpleDi;
    }
    else {
        return getDocumentInterface();
    }
}

/**
 * Returns the current operation if we are in a transaction or a new operation.
 * \ingroup ecma_simple
 */
function getOperation() {
    if (!isNull(__simpleOp)) {
        return __simpleOp;
    }
    return new RAddObjectsOperation();
}