File : data/Route.js

/*

Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/

This  program is free software;

you can redistribute it and/or modify it under the terms of the

GNU General Public License as published by the Free Software Foundation;

either version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program; if not, write to the Free Software

Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

*/

/*

Changes:

    - v4.0.0:

        - created from v3.6.0

Doc reviewed 202208

 */

import theConfig from '../data/Config.js';

import ObjId from '../data/ObjId.js';

import ObjType from '../data/ObjType.js';

import Collection from '../data/Collection.js';

import WayPoint from '../data/WayPoint.js';

import Itinerary from '../data/Itinerary.js';

import Note from '../data/Note.js';

import theHTMLSanitizer from '../core/htmlSanitizer/HTMLSanitizer.js';

import TravelObject from '../data/TravelObject.js';

import { ROUTE_EDITION_STATUS, DISTANCE, ZERO, ONE, INVALID_OBJ_ID, LAT_LNG } from '../main/Constants.js';

/* ------------------------------------------------------------------------------------------------------------------------- */

/**

This class represent a route

*/

/* ------------------------------------------------------------------------------------------------------------------------- */

class Route extends TravelObject {

    /**

    The object type for routes

    @type {ObjType}

    */

    static #objType = new ObjType (

        'Route',

        [

            'name',

            'wayPoints',

            'notes',

            'itinerary',

            'width',

            'color',

            'dashIndex',

            'chain',

            'chainedDistance',

            'distance',

            'duration',

            'editionStatus',

            'hidden',

            'objId'

        ]

    );

    /**

    the name of the Route

    @type {String}

    */

    #name = '';

    /**

    a Collection of WayPoints

    @type {Collection.<WayPoint>}

    */

    #wayPoints = new Collection ( WayPoint );

    /**

    a Collection of Notes

    @type {Collection.<Note>}

    */

    #notes = new Collection ( Note );

    /**

    the Route Itinerary

    @type {Itinerary}

    */

    #itinerary = new Itinerary ( );

    /**

    the width of the Leaflet polyline used to represent the Route on the map

    @type {Number}

    */

    #width = theConfig.route.width;

    /**

    the color of the Leaflet polyline used to represent the Route on the map

    using the css format '#rrggbb'

    @type {String}

    */

    #color = theConfig.route.color;

    /**

    the dash of the Leaflet polyline used to represent the Route on the map.

    It's the index of the dash in the array Config.route.dashChoices

    @type {Number}

    */

    #dashIndex = theConfig.route.dashIndex;

    /**

    boolean indicates if the route is chained

    @type {Boolean}

    */

    #chain = true;

    /**

    the distance between the starting point of the travel and the starting point

    of the route if the route is chained, otherwise DISTANCE.defaultValue

    @type {Number}

    */

    #chainedDistance = DISTANCE.defaultValue;

    /**

    the length of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

    @type {Number}

    */

    #distance = DISTANCE.defaultValue;

    /**

    the duration of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

    @type {Number}

    */

    #duration = DISTANCE.defaultValue;

    /**

    A number indicating the status of the route.

    See ROUTE_EDITION_STATUS for possible values

    @type {Number}

    */

    #editionStatus = ROUTE_EDITION_STATUS.notEdited;

    /**

    a boolean set to true when the route is hidden on the map

    @type {Boolean}

    */

    #hidden = false;

    /**

    the objId of the route

    @type {Number}

    */

    #objId = INVALID_OBJ_ID;

    /**

    The constructor

    */

    constructor ( ) {

        super ( );

        this.#wayPoints.add ( new WayPoint ( ) );

        this.#wayPoints.add ( new WayPoint ( ) );

        this.#objId = ObjId.nextObjId;

    }

    /**

    the name of the Route

    @type {String}

    */

    get name ( ) { return this.#name; }

    set name ( Name ) {

        this.#name =

            'string' === typeof ( Name )

                ?

                theHTMLSanitizer.sanitizeToJsString ( Name )

                :

                '';

    }

    /**

    a Collection of WayPoints

    @type {Collection.<WayPoint>}

    */

    get wayPoints ( ) { return this.#wayPoints; }

    /**

    a Collection of Notes

    @type {Collection.<Note>}

    */

    get notes ( ) { return this.#notes; }

    /**

    the Route Itinerary

    @type {Itinerary}

    */

    get itinerary ( ) { return this.#itinerary; }

    /**

    the width of the Leaflet polyline used to represent the Route on the map

    @type {Number}

    */

    get width ( ) { return this.#width; }

    set width ( width ) {

        this.#width = 'number' === typeof ( width ) ? width : theConfig.route.width;

    }

    /**

    the color of the Leaflet polyline used to represent the Route on the map

    using the css format '#rrggbb'

    @type {String}

    */

    get color ( ) { return this.#color; }

    set color ( color ) {

        this.#color =

            'string' === typeof ( color )

                ?

                theHTMLSanitizer.sanitizeToColor ( color ) || theConfig.route.color

                :

                theConfig.route.color;

    }

    /**

    The index of the dash in the array Config.route.dashChoices

    @type {Number}

    */

    get dashIndex ( ) { return this.#dashIndex; }

    set dashIndex ( dashIndex ) {

        this.#dashIndex =

            'number' === typeof ( dashIndex ) && theConfig.route.dashChoices [ dashIndex ]

                ?

                dashIndex

                :

                ZERO;

    }

    /**

    The string used by Leaflet for the dash to display the route

    @type {String}

    */

    get dashString ( ) {

        let dashString = '';

        theConfig.route.dashChoices [ this.#dashIndex ].iDashArray.forEach (

            iDash => dashString += String ( iDash * this.#width ) + ','

        );

        return dashString.substring ( ZERO, dashString.length - ONE );

    }

    /**

    A boolean indicating if the route is chained

    @type {Boolean}

    */

    get chain ( ) { return this.#chain; }

    set chain ( chain ) { this.#chain = 'boolean' === typeof ( chain ) ? chain : false; }

    /**

    the distance betwween the starting point of the travel and the starting point

    of the route if the route is chained, otherwise DISTANCE.defaultValue

    @type {Number}

    */

    get chainedDistance ( ) { return this.#chainedDistance; }

    set chainedDistance ( chainedDistance ) {

        this.#chainedDistance = 'number' === typeof ( chainedDistance ) ? chainedDistance : DISTANCE.defaultValue;

    }

    /**

    the length of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

    @type {Number}

    */

    get distance ( ) { return this.#distance; }

    set distance ( distance ) {

        this.#distance = 'number' === typeof ( distance ) ? distance : DISTANCE.defaultValue;

    }

    /**

    the duration of the route or DISTANCE.defaultValue if the Itinerary is not anymore computed

    @type {Number}

    */

    get duration ( ) { return this.#duration; }

    set duration ( duration ) {

        this.#duration = 'number' === typeof ( duration ) ? duration : DISTANCE.defaultValue;

    }

    /**

    A number indicating the status of the route.

    See ROUTE_EDITION_STATUS for possible values

    @type {Number}

    */

    get editionStatus ( ) { return this.#editionStatus; }

    set editionStatus ( editionStatus ) {

        this.#editionStatus =

            'number' === typeof ( editionStatus )

                ?

                editionStatus

                :

                ROUTE_EDITION_STATUS.notEdited;

    }

    /**

    a boolean set to true when the route is hidden on the map

    @type {Boolean}

    */

    get hidden ( ) { return this.#hidden; }

    set hidden ( hidden ) {

        this.#hidden = 'boolean' === typeof ( hidden ) ? hidden : false;

    }

    /**

    A name computed from the starting WayPoint and ending WayPoint names and addresses

    @type {String}

    */

    get computedName ( ) {

        let computedName = this.name;

        if ( '' === computedName ) {

            computedName =

                ( '' === this.wayPoints.first.fullName ? '???' : this.wayPoints.first.fullName ) +

                ' ⮞ ' +

                ( '' === this.wayPoints.last.fullName ? '???' : this.wayPoints.last.fullName );

        }

        return computedName;

    }

    /**

    the objId of the Route. objId are unique identifier given by the code

    @type {Number}

    */

    get objId ( ) { return this.#objId; }

    /**

    the ObjType of the Route.

    @type {ObjType}

    */

    get objType ( ) { return Route.#objType; }

    /**

    This method verify that all waypoints have valid coordinates ( reminder: a route have always a startpoint

    and an endpoint!)

    @return {Boolean} true when all waypoints have valid coordinates

    */

    haveValidWayPoints ( ) {

        let haveValidWayPoints = true;

        this.wayPoints.forEach (

            wayPoint => {

                haveValidWayPoints =

                    haveValidWayPoints

                    &&

                    LAT_LNG.defaultValue !== wayPoint.lat

                    &&

                    LAT_LNG.defaultValue !== wayPoint.lng;

            }

        );

        return haveValidWayPoints;

    }

    /**

    An object literal with the WayPoint properties and without any methods.

    This object can be used with the JSON object

    @type {JsonObject}

    */

    get jsonObject ( ) {

        return {

            name : this.name,

            wayPoints : this.wayPoints.jsonObject,

            notes : this.notes.jsonObject,

            itinerary : this.itinerary.jsonObject,

            width : this.width,

            color : this.color,

            dashIndex : this.dashIndex,

            chain : this.chain,

            distance : parseFloat ( this.distance.toFixed ( DISTANCE.fixed ) ),

            duration : this.duration,

            editionStatus : this.editionStatus,

            hidden : this.hidden,

            chainedDistance : parseFloat ( this.chainedDistance.toFixed ( DISTANCE.fixed ) ),

            objId : this.#objId,

            objType : this.objType.jsonObject

        };

    }

    set jsonObject ( something ) {

        const otherthing = this.validateObject ( something );

        this.name = otherthing.name;

        this.wayPoints.jsonObject = otherthing.wayPoints;

        this.notes.jsonObject = otherthing.notes;

        this.itinerary.jsonObject = otherthing.itinerary;

        this.width = otherthing.width;

        this.color = otherthing.color;

        this.dashIndex = otherthing.dashIndex;

        this.chain = otherthing.chain;

        this.distance = otherthing.distance;

        this.duration = otherthing.duration;

        this.editionStatus = otherthing.editionStatus;

        this.hidden = otherthing.hidden;

        this.chainedDistance = otherthing.chainedDistance;

        this.#objId = ObjId.nextObjId;

    }

}

export default Route;

/* --- End of file --------------------------------------------------------------------------------------------------------- */