zid.hpp File Reference

#include "./aid.hpp"
#include <string>
#include <vector>

Include dependency graph for zid.hpp:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	scifir::zid
	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...

Namespaces
namespace	scifir
	The namespace scifir contains all scifir-units, excepting the string literals, which are outside.

Functions
string	scifir::to_string (const zid &x)
	Returns a string representation of zid, same as display().
string	scifir::to_string (const zid::type &x)
	Converts a value of the enum zid::type to its string representation, which is a single letter. The value COUNTRY returns C. The value REGION returns R. The value SETTLEMENT returns S. The value ZONE returns Z.
zid::type	scifir::create_zone_type (const string &zone_type_abbreviation)
	Creates an instance of a zid::type with the given string, which is the reverse as the to_string() function of zid::type.
bool	operator== (const scifir::zid &x, const scifir::zid &y)
	Returns true if the type and all data are the same between x and y.
bool	operator!= (const scifir::zid &x, const scifir::zid &y)
	Returns true if the type or any data is different between x and y.
bool	operator== (const scifir::zid &x, const string &init_zid_full)
	Returns true if x and the zid constructed with init_zid_full are equal.
bool	operator!= (const scifir::zid &x, const string &init_zid_full)
	Returns true if x and the zid constructed with init_zid_full are different.
bool	operator== (const string &init_zid_full, const scifir::zid &x)
	Returns true if x and the zid constructed with init_zid_full are equal.
bool	operator!= (const string &init_zid_full, const scifir::zid &x)
	Returns true if x and the zid constructed with init_zid_full are different.
void	operator+= (string &x, const scifir::zid &y)
	Concatenates the string representation of zid y to the string x.
string	operator+ (const string &x, const scifir::zid &y)
	Concatenates x with the string representation of zid y.
string	operator+ (const scifir::zid &y, const string &x)
	Concatenates x with the string representation of zid y.
ostream &	operator<< (ostream &os, const scifir::zid &x)
	Adds the string representation of the zid x to an output stream os.
istream &	operator>> (istream &is, scifir::zid &x)
	Allows that an istream initializes by string a zid x.

Function Documentation

operator!=() [1/3]

bool operator!=	(	const scifir::zid &	x,
		const scifir::zid &	y
	)

Returns true if the type or any data is different between x and y.

Definition at line 369 of file zid.cpp.

{
    return !(x == y);
}

operator!=() [2/3]

bool operator!=	(	const scifir::zid &	x,
		const string &	init_zid_full
	)

Returns true if x and the zid constructed with init_zid_full are different.

Definition at line 380 of file zid.cpp.

{
    return !(x == init_zid_full);
}

operator!=() [3/3]

bool operator!=	(	const string &	init_zid_full,
		const scifir::zid &	x
	)

Returns true if x and the zid constructed with init_zid_full are different.

Definition at line 391 of file zid.cpp.

{
    return !(init_zid_full == x);
}

operator+() [1/2]

string operator+	(	const scifir::zid &	y,
		const string &	x
	)

Concatenates x with the string representation of zid y.

Definition at line 411 of file zid.cpp.

{
    ostringstream output;
    output << y;
    output << x;
    return output.str();
}

operator+() [2/2]

string operator+	(	const string &	x,
		const scifir::zid &	y
	)

Concatenates x with the string representation of zid y.

Definition at line 403 of file zid.cpp.

{
    ostringstream output;
    output << x;
    output << y;
    return output.str();
}

operator+=()

void operator+=	(	string &	x,
		const scifir::zid &	y
	)

Concatenates the string representation of zid y to the string x.

Definition at line 396 of file zid.cpp.

{
    ostringstream output;
    output << y;
    x += output.str();
}

operator<<()

ostream & operator<<	(	ostream &	os,
		const scifir::zid &	x
	)

Adds the string representation of the zid x to an output stream os.

Definition at line 419 of file zid.cpp.

{
    return os << to_string(x);
}

operator==() [1/3]

bool operator==	(	const scifir::zid &	x,
		const scifir::zid &	y
	)

Returns true if the type and all data are the same between x and y.

Definition at line 336 of file zid.cpp.

{
    if (x.aid == y.aid)
    {
        if (x.country == y.country)
        {
            for (unsigned int i = 0; i < x.regions.size(); i++)
            {
                if (x.regions[i] != y.regions[i])
                {
                    return false;
                }
            }
            if (x.zone == y.zone)
            {
                return true;
            }
            else
            {
                return false;
            }
        }
        else
        {
            return false;
        }
    }
    else
    {
        return false;
    }
}

operator==() [2/3]

bool operator==	(	const scifir::zid &	x,
		const string &	init_zid_full
	)

Returns true if x and the zid constructed with init_zid_full are equal.

Definition at line 374 of file zid.cpp.

{
    scifir::zid y = scifir::zid(init_zid_full);
    return (x == y);
}

operator==() [3/3]

bool operator==	(	const string &	init_zid_full,
		const scifir::zid &	x
	)

Returns true if x and the zid constructed with init_zid_full are equal.

Definition at line 385 of file zid.cpp.

{
    scifir::zid y = scifir::zid(init_zid_full);
    return (x == y);
}

operator>>()

istream & operator>>	(	istream &	is,
		scifir::zid &	x
	)

Allows that an istream initializes by string a zid x.

Definition at line 424 of file zid.cpp.

{
    char a[256];
    is.getline(a, 256);
    string b(a);
    boost::trim(b);
    x = scifir::zid(b);
    return is;
}