gem::AddressInfo Class Reference

AddressInfo object. More...

Inheritance diagram for gem::AddressInfo:

Collaboration diagram for gem::AddressInfo:

Public Member Functions
	AddressInfo (const AddressInfo &)=default
	Default copy constructor.
	AddressInfo (AddressInfo &&)=default
	Default move constructor noexcept is deduced.
AddressInfo &	operator= (const AddressInfo &ai)=default
	Default copy assignment.
AddressInfo &	operator= (AddressInfo &&ai)=default
	Default move assignment noexcept is deduced.
bool	operator== (const AddressInfo &addr) const
	Equality operator.
bool	operator!= (const AddressInfo &addr) const
	Comparison operator not equal.
const StringRef	getField (EAddressField field) const noexcept
	Get address field name.
AddressInfo &	setField (const String &str, EAddressField field) noexcept
	Set address field name.
String	format (const IntList &excludeFields=IntList(), const IntList &includeFields=IntList()) const noexcept
	Formats the address as a string.

Detailed Description

AddressInfo object.

Holds textual address information about a location. Typically the information is e.g. street address.

Implements share-read / copy-on-write Api object over IAddressInfo. The information is divided into fields( e.g. street, postal code, city, etc.). Defined field constants can be used to retrieve field data.

Member Function Documentation

format()

String gem::AddressInfo::format ( const IntList & excludeFields = IntList(), const IntList & includeFields = IntList() ) const

inlinenoexcept

Formats the address as a string.

Parameters

[in]	excludeFields	Fields to be excluded from result. If not specified nothing is excluded
[in]	includeFields	Fields to be included from result. If not specified all are included

Returns

Formatted string.

getField()

const StringRef gem::AddressInfo::getField ( EAddressField field ) const

inlinenoexcept

Get address field name.

Parameters

field

Address field requested.

Returns

Field name.

operator!=()

bool gem::AddressInfo::operator!= ( const AddressInfo & addr ) const

inline

Comparison operator not equal.

Parameters

addr	AddressInfo

Returns

true if not equal

operator=() [1/2]

AddressInfo & gem::AddressInfo::operator= ( AddressInfo && ai )

default

Default move assignment noexcept is deduced.

Returns

reference to this AddressInfo

Parameters

ai	AddressInfo

operator=() [2/2]

AddressInfo & gem::AddressInfo::operator= ( const AddressInfo & ai )

default

Default copy assignment.

Returns

reference to this AddressInfo

Parameters

ai	AddressInfo

operator==()

bool gem::AddressInfo::operator== ( const AddressInfo & addr ) const

inline

Equality operator.

Parameters

addr	AddressInfo

Returns

true if equal

setField()

AddressInfo & gem::AddressInfo::setField ( const String & str, EAddressField field )

inlinenoexcept

Set address field name.

Parameters

field	Address field to be updated.
str	New value of the address field.

Returns

Reference to this object.