gem::vrp::Territory Class Reference

Defines a territory. More...

Inheritance diagram for gem::vrp::Territory:

Collaboration diagram for gem::vrp::Territory:

Public Member Functions
	Territory ()=default
	Default constructor.
	Territory (const Territory &)=default
	Default copy constructor.
	Territory (Territory &&) noexcept=default
	Default move constructor.
Territory &	operator= (const Territory &)=default
	Default copy assignment operator.
Territory &	operator= (Territory &&) noexcept=default
	Default move assignment operator.
bool	operator== (Territory const &territory) const
	Compares two Territory objects for equality.
bool	operator!= (Territory const &territory) const
	Compares two Territory objects for inequality.
LargeInteger	getId () const noexcept
	Retrieves the unique identifier of the territory.
const StringRef	getName () const noexcept
	Retrieves the name of the territory.
Territory &	setName (const String &name) noexcept
	Sets the name of the territory.
ETerritoryType	getType () const noexcept
	Retrieves the type of the territory.
Territory &	setType (ETerritoryType territoryType) noexcept
	Set the type of the territory.
const CoordinatesListRef	getData () noexcept
	Get the data of the territory.
Territory &	setData (const ICoordinatesList &data) noexcept
	Set the data of the territory.
const Rgba &	getColor () const noexcept
	Get the color of the territory.
Territory &	setColor (const Rgba &color) noexcept
	Set the color of the territory.
const OrderListRef	getOrders () noexcept
	Get the orders located inside the territory.

Detailed Description

Defines a territory.

Implements share-read / copy-on-write Api object over ITerritory.

Constructor & Destructor Documentation

Territory() [1/3]

gem::vrp::Territory::Territory ( )

default

Default constructor.

Initializes a new instance of the Territory class without setting any properties.

Territory() [2/3]

gem::vrp::Territory::Territory ( const Territory & )

default

Default copy constructor.

Creates a copy of an existing Territory object

Territory() [3/3]

gem::vrp::Territory::Territory ( Territory && )

defaultnoexcept

Default move constructor.

Moves an existing Territory object into a new instance.

Member Function Documentation

getColor()

const Rgba & gem::vrp::Territory::getColor ( ) const

inlinenoexcept

Get the color of the territory.

Returns

The color as a Rgba.

getData()

const CoordinatesListRef gem::vrp::Territory::getData ( )

inlinenoexcept

Get the data of the territory.

Returns

If territory type is :

• ETerritoryType::TT_Circle: a list with the center of the circle and the radius (in meters)
• ETerritoryType::TT_Rectangle: a list with 2 diagonally opposite points
• ETerritoryType::TT_Polygon: a list of points.

See also

ETerritoryType

getId()

LargeInteger gem::vrp::Territory::getId ( ) const

inlinenoexcept

Retrieves the unique identifier of the territory.

Returns

The ID of the territory, used for update or delete operations.

See also

Service::deleteTerritory(), Service::updateTerritory()

getName()

const StringRef gem::vrp::Territory::getName ( ) const

inlinenoexcept

Retrieves the name of the territory.

Returns

The name of the territory as a StringRef.

getOrders()

const OrderListRef gem::vrp::Territory::getOrders ( )

inlinenoexcept

Get the orders located inside the territory.

Returns

a list of Order objects

getType()

ETerritoryType gem::vrp::Territory::getType ( ) const

inlinenoexcept

Retrieves the type of the territory.

Returns

The type as an ETerritoryType enumeration value.

operator!=()

bool gem::vrp::Territory::operator!= ( Territory const & territory ) const

inline

Compares two Territory objects for inequality.

Parameters

territory

Another Territory object to compare against.

Returns

True if the Territory objects do not represent the same data, false otherwise.

operator=() [1/2]

Territory & gem::vrp::Territory::operator= ( const Territory & )

default

Default copy assignment operator.

Replaces the contents of this object with a copy of another Territory object.

Returns

A reference to the current object.

operator=() [2/2]

Territory & gem::vrp::Territory::operator= ( Territory && )

defaultnoexcept

Default move assignment operator.

Moves the contents of another Territory object into this one.

Returns

A reference to the current object.

operator==()

bool gem::vrp::Territory::operator== ( Territory const & territory ) const

inline

Compares two Territory objects for equality.

Parameters

territory

Another Territory object to compare against.

Returns

True if both Territory objects represent the same data, false otherwise.

setColor()

Territory & gem::vrp::Territory::setColor ( const Rgba & color )

inlinenoexcept

Set the color of the territory.

Parameters

color

The color of the territory as a Rgba object.

Returns

A reference to this Territory object after modification.

setData()

Territory & gem::vrp::Territory::setData ( const ICoordinatesList & data )

inlinenoexcept

Set the data of the territory.

Parameters

data

If territory type is : ETerritoryType::TT_Circle: the data should contain the the center of the circle and the coordinates of a point from the circle ETerritoryType::TT_Rectangle: the data should contain 2 diagonally opposite points ETerritoryType::TT_Polygon: the data should contain a list of points.

Returns

A reference to this Territory object after modification.

See also

ETerritoryType

setName()

Territory & gem::vrp::Territory::setName ( const String & name )

inlinenoexcept

Sets the name of the territory.

Parameters

name	The new name for the territory.

Returns

A reference to this Territory object after modification.

setType()

Territory & gem::vrp::Territory::setType ( ETerritoryType territoryType )

inlinenoexcept

Set the type of the territory.

Parameters

territoryType

The type as an ETerritoryType enumeration value.

Returns

A reference to this Territory object after modification.

See also

ETerritoryType