Class that allows to store information about a zone, including the astronomical object inside which the zone is. The zone can be in any astronomical object, not only the Earth is supported. Initialization string example: "(P) universe:milky-way:solar-system:earth (Z) chile:region-metropolitana:santiago:providencia". More...

#include <zid.hpp>

Collaboration diagram for scifir::zid:

[legend]

Public Types
enum	type : int8_t { NONE , COUNTRY , REGION , SETTLEMENT , ZONE }
	Type of zone. More...

Public Member Functions
	zid ()
	Default constructor. There's no data about any zone, the aid member-variable is also empty.

	zid (const zid &x)
	Copy constructor. The zid is initialized copying the member-variables of the zid x.

	zid (zid &&x)
	Move constructor. The zid is initialized moving the member-variables of the zid x.

	zid (const scifir::aid &new_aid, const zid::type &new_zid_type, const string &new_country)
	Constructor. It initializes a country as the entire zone of zid.

	zid (const scifir::aid &new_aid, const string &new_country, const vector< string > &new_regions)
	Constructor. It initializes a region as the entire zone of zid, which is the last region specified, the one inside the other regions given if there's more than one region initialized.

	zid (const scifir::aid &new_aid, const zid::type &new_zid_type, const string &new_country, const vector< string > &new_regions, const string &new_zone)
	Constructor. The aid is new_aid, the country is new_country, the regions are new_regions and zone is new_zone. The zone_type can be ZONE or SETTLEMENT.

	zid (const scifir::aid &new_aid, const string &init_zid)
	Constructor. The aid is new_aid, init_zid initializes the other member-variables.

	zid (const string &init_zid_full)
	Constructor. Initializes all the member-variables with init_zid_full, which is a union is init_aid and init_zid.

zid &	operator= (const zid &x)
	Copy assigment. The member-variables are copied from the zid x.

zid &	operator= (zid &&x)
	Move assigment. The member-variables are moved from the zid x.

zid &	operator= (const string &init_zid_full)
	Assignment. Initializes all the member-variables with init_zid_full, which is a union is init_aid and init_zid.

bool	has_no_country () const
	Returns true if the value of country is the predefined value 'no-country'.

bool	has_unknown_country () const
	Returns true if the value of country is the predefined value 'unknown-country'.

string	display () const
	Returns a string representation of zid, including the string representation of his aid.

string	partial_display () const
	Returns a string representation of zid, without the string representation of his aid.

Public Attributes
scifir::aid	aid
	The aid of the astronomical object where the zone is.

vector< string >	regions
	The different administrative regions where the zone is. There can be any number of administrative regions, each inside the other. There can't be regions that aren't inside another region here.

string	country
	The country where the zone is. In extraterrestrial planets, it's considered a country any division of territory ruled with their own laws. The predefined value no-country means that the zone is not inside a country. The predefined value unknown-country means that it's not known the country where the zone is, but that it's known that it's a country.

string	zone
	The name of the zone. Personal zones with a personal name are allowed, it's not necessary that the zone is registered by a country or another organization.

zid::type	zone_type
	The type of zone. It can be any value of the enum zid::type. The possible values are COUNTRY, REGION and ZONE. A zone can be any surface inside an astronomical object, of any shape, and it's not necessary to be a zone registered by a country or organization. A personal zone with a personal name is allowed.

Private Member Functions
void	initialize_from_string (const string &init_zid_full)
	Internal function. It's used by the string constructor and the string assignment of zid to initialize the member-variables using the initialization string init_zid_full.

Detailed Description

Class that allows to store information about a zone, including the astronomical object inside which the zone is. The zone can be in any astronomical object, not only the Earth is supported. Initialization string example: "(P) universe:milky-way:solar-system:earth (Z) chile:region-metropolitana:santiago:providencia".

Definition at line 13 of file zid.hpp.

Member Enumeration Documentation

◆ type

enum scifir::zid::type : int8_t

Type of zone.

Enumerator
NONE	No zone.
COUNTRY	A country.
REGION	A region.
SETTLEMENT	A settlement.
ZONE	A zone. A zone is any surface inside an astronomical object, of any shape. It's not necessary to be a zone registered by a country or organization, personal zones are allowed.

Definition at line 16 of file zid.hpp.

16: int8_t {NONE,COUNTRY,REGION,SETTLEMENT,ZONE};

scifir::zid::REGION

@ REGION

A region.

Definition zid.hpp:16

scifir::zid::ZONE

@ ZONE

A zone. A zone is any surface inside an astronomical object, of any shape. It's not necessary to be a...

Definition zid.hpp:16

scifir::zid::COUNTRY

@ COUNTRY

A country.

Definition zid.hpp:16

scifir::zid::SETTLEMENT

@ SETTLEMENT

A settlement.

Definition zid.hpp:16

scifir::zid::NONE

@ NONE

No zone.

Definition zid.hpp:16

Constructor & Destructor Documentation

◆ zid() [1/8]

zid::zid ( )

Default constructor. There's no data about any zone, the aid member-variable is also empty.

Definition at line 12 of file zid.cpp.

12 : aid(),regions(),country(),zone(),zone_type(zid::NONE)

13 {}

scifir::zid::zone_type

zid::type zone_type

The type of zone. It can be any value of the enum zid::type. The possible values are COUNTRY,...

Definition zid.hpp:41

scifir::zid::aid

scifir::aid aid

The aid of the astronomical object where the zone is.

Definition zid.hpp:37

scifir::zid::regions

vector< string > regions

The different administrative regions where the zone is. There can be any number of administrative reg...

Definition zid.hpp:38

scifir::zid::zone

string zone

The name of the zone. Personal zones with a personal name are allowed, it's not necessary that the zo...

Definition zid.hpp:40

scifir::zid::country

string country

The country where the zone is. In extraterrestrial planets, it's considered a country any division of...

Definition zid.hpp:39

◆ zid() [2/8]

zid::zid ( const zid & x )

Copy constructor. The zid is initialized copying the member-variables of the zid x.

Definition at line 15 of file zid.cpp.

15 : aid(x.aid),regions(x.regions),country(x.country),zone(x.zone),zone_type(x.zone_type)

16 {}

◆ zid() [3/8]

zid::zid ( zid && x )

Move constructor. The zid is initialized moving the member-variables of the zid x.

Definition at line 18 of file zid.cpp.

18 : aid(std::move(x.aid)),regions(std::move(x.regions)),country(std::move(x.country)),zone(std::move(x.zone)),zone_type(std::move(x.zone_type))

19 {}

◆ zid() [4/8]

zid::zid	(	const scifir::aid &	new_aid,
		const zid::type &	new_zid_type,
		const string &	new_country
	)

explicit

Constructor. It initializes a country as the entire zone of zid.

Definition at line 21 of file zid.cpp.

                                                                                           : aid(),country(),regions(),zone(),zone_type(zid::NONE)
    {
        if (new_zid_type == zid::COUNTRY)
        {
            aid = new_aid;
            country = new_country;
            zone_type = zid::COUNTRY;
        }
    }

◆ zid() [5/8]

zid::zid	(	const scifir::aid &	new_aid,
		const string &	new_country,
		const vector< string > &	new_regions
	)

explicit

Constructor. It initializes a region as the entire zone of zid, which is the last region specified, the one inside the other regions given if there's more than one region initialized.

Definition at line 31 of file zid.cpp.

31 : aid(new_aid),country(new_country),regions(new_regions),zone(),zone_type(zid::REGION)

32 {}

◆ zid() [6/8]

zid::zid	(	const scifir::aid &	new_aid,
		const zid::type &	new_zid_type,
		const string &	new_country,
		const vector< string > &	new_regions,
		const string &	new_zone
	)

explicit

Constructor. The aid is new_aid, the country is new_country, the regions are new_regions and zone is new_zone. The zone_type can be ZONE or SETTLEMENT.

Definition at line 34 of file zid.cpp.

                                                                                                                                                    : aid(),country(),regions(),zone(),zone_type(zid::NONE)
    {
        if (new_zid_type != zid::COUNTRY and new_zid_type != zid::REGION)
        {
            aid = new_aid;
            regions = new_regions;
            country = new_country;
            zone = new_zone;
            zone_type = new_zid_type;
        }
    }

◆ zid() [7/8]

zid::zid	(	const scifir::aid &	new_aid,
		const string &	init_zid
	)

explicit

Constructor. The aid is new_aid, init_zid initializes the other member-variables.

Definition at line 46 of file zid.cpp.

                                                            : aid(new_aid),regions(),country(),zone(),zone_type(zid::NONE)
    {
        if (init_zid != "")
        {
            vector<string> values;
            boost::split(values,init_zid,boost::is_any_of(":"));
            if (values[0].front() == '(' and isalpha(values[0][1]))
            {
                zone_type = create_zone_type(values[0].substr(1,1));
                string new_country;
                if (values[0][3] != ' ')
                {
                    new_country = values[0].substr(3);
                }
                else
                {
                    new_country = values[0].substr(4);
                }
                if (values.size() == 1 and zone_type == zid::COUNTRY)
                {
                    country = new_country;
                }
                if ((values.size() >= 2 and zone_type == zid::REGION) or (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)))
                {
                    country = new_country;
                    int total_for_values;
                    if (zone_type == zid::REGION)
                    {
                        total_for_values = int(values.size());
                    }
                    else if (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)
                    {
                        total_for_values = int(values.size()) - 1;
                    }
                    for (int i = 1; i < total_for_values; i++)
                    {
                        regions.push_back(values[i]);
                    }
                }
                if (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT))
                {
                    country = new_country;
                    zone = values.back();
                }
                if (country == "")
                {
                    zone_type = zid::NONE;
                }
            }
        }
    }

◆ zid() [8/8]

zid::zid ( const string & init_zid_full )

explicit

Constructor. Initializes all the member-variables with init_zid_full, which is a union is init_aid and init_zid.

Definition at line 98 of file zid.cpp.

                                        : zid()
    {
        initialize_from_string(init_zid_full);
    }

Member Function Documentation

◆ display()

string zid::display ( ) const

Returns a string representation of zid, including the string representation of his aid.

Definition at line 139 of file zid.cpp.

    {
        if (country != "")
        {
            ostringstream out;
            out << to_string(aid) << " (" << to_string(zone_type) << ") " << country;
            if (regions.size() > 0 and zone != "")
            {
                out << ":";
            }
            for (const string& x_region : regions)
            {
                out << x_region << ":";
            }
            out << zone;
            return out.str();
        }
        else
        {
            return "";
        }
    }

◆ has_no_country()

bool zid::has_no_country ( ) const

Returns true if the value of country is the predefined value 'no-country'.

Definition at line 129 of file zid.cpp.

    {
        return (country == "no-country");
    }

◆ has_unknown_country()

bool zid::has_unknown_country ( ) const

Returns true if the value of country is the predefined value 'unknown-country'.

Definition at line 134 of file zid.cpp.

    {
        return (country == "unknown-country");
    }

◆ initialize_from_string()

void zid::initialize_from_string ( const string & init_zid_full )

private

Internal function. It's used by the string constructor and the string assignment of zid to initialize the member-variables using the initialization string init_zid_full.

Definition at line 181 of file zid.cpp.

    {
        if (init_zid_full != "")
        {
            if (!(init_zid_full[1] == 'C' or init_zid_full[1] == 'R' or init_zid_full[1] == 'Z'))
            {
                std::size_t last_whitespace = init_zid_full.find(" (");
                string init_aid = init_zid_full.substr(0,last_whitespace);
                string init_zid = init_zid_full.substr(last_whitespace + 1);
                aid = scifir::aid(init_aid);
                vector<string> values;
                boost::split(values,init_zid,boost::is_any_of(":"));
                if (values[0].front() == '(' and isalpha(values[0][1]))
                {
                    zone_type = create_zone_type(values[0].substr(1,1));
                    string new_country;
                    if (values[0][3] != ' ')
                    {
                        new_country = values[0].substr(3);
                    }
                    else
                    {
                        new_country = values[0].substr(4);
                    }
                    if (values.size() == 1 and zone_type == zid::COUNTRY)
                    {
                        country = new_country;
                    }
                    if ((values.size() >= 2 and zone_type == zid::REGION) or (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)))
                    {
                        country = new_country;
                        int total_for_values;
                        if (zone_type == zid::REGION)
                        {
                            total_for_values = int(values.size());
                        }
                        else if (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)
                        {
                            total_for_values = int(values.size()) - 1;
                        }
                        for (int i = 1; i < total_for_values; i++)
                        {
                            regions.push_back(values[i]);
                        }
                    }
                    if (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT))
                    {
                        country = new_country;
                        zone = values.back();
                    }
                    if (country == "")
                    {
                        zone_type = zid::NONE;
                    }
                }
            }
            else
            {
                vector<string> values;
                boost::split(values,init_zid_full,boost::is_any_of(":"));
                if (values[0].front() == '(' and isalpha(values[0][1]))
                {
                    zone_type = create_zone_type(values[0].substr(1,1));
                    string new_country;
                    if (values[0][3] != ' ')
                    {
                        new_country = values[0].substr(3);
                    }
                    else
                    {
                        new_country = values[0].substr(4);
                    }
                    if (values.size() == 1 and zone_type == zid::COUNTRY)
                    {
                        country = new_country;
                    }
                    if ((values.size() >= 2 and zone_type == zid::REGION) or (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)))
                    {
                        country = new_country;
                        int total_for_values;
                        if (zone_type == zid::REGION)
                        {
                            total_for_values = int(values.size());
                        }
                        else if (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT)
                        {
                            total_for_values = int(values.size()) - 1;
                        }
                        for (int i = 1; i < total_for_values; i++)
                        {
                            regions.push_back(values[i]);
                        }
                    }
                    if (values.size() >= 3 and (zone_type == zid::ZONE or zone_type == zid::SETTLEMENT))
                    {
                        country = new_country;
                        zone = values.back();
                    }
                    if (country == "")
                    {
                        zone_type = zid::NONE;
                    }
                }
            }
        }
    }

◆ operator=() [1/3]

zid & zid::operator= ( const string & init_zid_full )

Assignment. Initializes all the member-variables with init_zid_full, which is a union is init_aid and init_zid.

Definition at line 123 of file zid.cpp.

    {
        initialize_from_string(init_zid_full);
        return *this;
    }

◆ operator=() [2/3]

zid & zid::operator= ( const zid & x )

Copy assigment. The member-variables are copied from the zid x.

Definition at line 103 of file zid.cpp.

    {
        aid = x.aid;
        regions = x.regions;
        country = x.country;
        zone = x.zone;
        zone_type = x.zone_type;
        return *this;
    }

◆ operator=() [3/3]

zid & zid::operator= ( zid && x )

Move assigment. The member-variables are moved from the zid x.

Definition at line 113 of file zid.cpp.

    {
        aid = std::move(x.aid);
        regions = std::move(x.regions);
        country = std::move(x.country);
        zone = std::move(x.zone);
        zone_type = std::move(x.zone_type);
        return *this;
    }

◆ partial_display()

string zid::partial_display ( ) const

Returns a string representation of zid, without the string representation of his aid.

Definition at line 162 of file zid.cpp.

    {
        if (country != "")
        {
            ostringstream out;
            out << "(" << to_string(zone_type) << ") " << country << ":";
            for (const string& x_region : regions)
            {
                out << x_region << ":";
            }
            out << zone;
            return out.str();
        }
        else
        {
            return "";
        }
    }

Member Data Documentation

◆ aid

scifir::aid zid::aid

The aid of the astronomical object where the zone is.

Definition at line 37 of file zid.hpp.

◆ country

string zid::country

The country where the zone is. In extraterrestrial planets, it's considered a country any division of territory ruled with their own laws. The predefined value no-country means that the zone is not inside a country. The predefined value unknown-country means that it's not known the country where the zone is, but that it's known that it's a country.

Definition at line 39 of file zid.hpp.

◆ regions

vector< string > zid::regions

The different administrative regions where the zone is. There can be any number of administrative regions, each inside the other. There can't be regions that aren't inside another region here.

Definition at line 38 of file zid.hpp.

◆ zone

string zid::zone

The name of the zone. Personal zones with a personal name are allowed, it's not necessary that the zone is registered by a country or another organization.

Definition at line 40 of file zid.hpp.

◆ zone_type

string zid::zone_type

The type of zone. It can be any value of the enum zid::type. The possible values are COUNTRY, REGION and ZONE. A zone can be any surface inside an astronomical object, of any shape, and it's not necessary to be a zone registered by a country or organization. A personal zone with a personal name is allowed.

Definition at line 41 of file zid.hpp.

The documentation for this class was generated from the following files:

coordinates/zid.hpp
coordinates/zid.cpp
docs/dox/special_units/zid.dox

Public Types

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Member Enumeration Documentation

◆ type

Constructor & Destructor Documentation

◆ zid() [1/8]

◆ zid() [2/8]

◆ zid() [3/8]

◆ zid() [4/8]

◆ zid() [5/8]

◆ zid() [6/8]

◆ zid() [7/8]

◆ zid() [8/8]

Member Function Documentation

◆ display()

◆ has_no_country()

◆ has_unknown_country()

◆ initialize_from_string()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]

◆ partial_display()

Member Data Documentation

◆ aid

◆ country

◆ regions

◆ zone

◆ zone_type