class GEDCOMParser::Address

The class GEDCOMParser::Address implements the GEDCOM 5 5 ADDRESS_STRUCTURE structure.

Inheritance:


Public Methods

[more] Address (void)
Constructor
[more]virtual ~Address (void)
Destructor
[more]void concAddr (std::string const &)
Fill the ADDRESS_LINE value.
[more]void contAddr (std::string const &)
Fill the ADDRESS_LINE value.
[more]void setAdr1 (std::string const &)
Set the ADDRESS_LINE1 value
[more]void setAdr2 (std::string const &)
Set the ADDRESS_LINE2 value
[more]void setCity (std::string const &)
Set the ADDRESS_CITY value
[more]void setState (std::string const &)
set the ADDRESS_STATE value
[more]void setPost (std::string const &)
set the ADDRESS_POSTAL_CODE value
[more]void setCountry (std::string const &)
set the ADDRESS_COUNTRY value
[more]void setPhone (std::string const &)
set the PHONE_NUMBER value
[more]virtual std::string const& getAddr (void) const
get the ADDRESS_LINE value
[more]virtual std::string const& getAdr1 (void) const
get the ADDRESS_LINE1 value
[more]virtual std::string const& getAdr2 (void) const
get the ADDRESS_LINE2 value
[more]virtual std::string const& getCity (void) const
get the ADDRESS_CITY value
[more]virtual std::string const& getState (void) const
get the ADDRESS_STATE value
[more]virtual std::string const& getPost (void) const
get the ADDRESS_POSTAL_CODE value
[more]virtual std::string const& getCountry (void) const
get the ADDRESS_COUNTRY value
[more]virtual std::string const& getPhone (void) const
get the PHONE_NUMBER value
[more]virtual void Accept (GEDCOMParser::GEDCOMVisitor* )
Serialization method

Public Members

[more] ADDRESS_STRUCTURE


Documentation

The class GEDCOMParser::Address implements the GEDCOM 5 5 ADDRESS_STRUCTURE structure.

Warning: The integrity between multiples lines of Addr and other values (Adr1, Adr2, ...) is not assured by the class.

GEDCOM 5.5 definition:

      ADDRESS_STRUCTURE: =
      n  ADDR <ADDRESS_LINE>  {0:1}
      +1 CONT <ADDRESS_LINE>  {0:M}
      +1 ADR1 <ADDRESS_LINE1>  {0:1}
      +1 ADR2 <ADDRESS_LINE2>  {0:1}
      +1 CITY <ADDRESS_CITY>  {0:1}
      +1 STAE <ADDRESS_STATE>  {0:1}
      +1 POST <ADDRESS_POSTAL_CODE>  {0:1}
      +1 CTRY <ADDRESS_COUNTRY>  {0:1}
      n  PHON <PHONE_NUMBER>  {0:3}
      
The address structure should be formed as it would appear on a mailing label using the ADDR and ADDR.CONT lines. These lines are required if an ADDRess is present. Optionally, additional structure is provided for systems that have structured their addresses for indexing and sorting.

o Address(void)
Constructor

ovirtual ~Address(void)
Destructor

ovoid concAddr(std::string const &)
Fill the ADDRESS_LINE value. This method can be invoked multiple times. The resulting address is the concatenation of the multiples parameters.

Warning: this method is an extension to the GEDCOM 5.5 format

See Also:
ADDRESS_LINE

ovoid contAddr(std::string const &)
Fill the ADDRESS_LINE value. This method can be invoked multiple times. The resulting address is the concatenation of the multiples parameters, separated by a newline character.

See Also:
ADDRESS_LINE

ovoid setAdr1(std::string const &)
Set the ADDRESS_LINE1 value

See Also:
ADDRESS_LINE1

ovoid setAdr2(std::string const &)
Set the ADDRESS_LINE2 value

See Also:
ADDRESS_LINE2

ovoid setCity(std::string const &)
Set the ADDRESS_CITY value

See Also:
ADDRESS_CITY

ovoid setState(std::string const &)
set the ADDRESS_STATE value

See Also:
ADDRESS_STATE

ovoid setPost(std::string const &)
set the ADDRESS_POSTAL_CODE value

See Also:
ADDRESS_POSTAL_CODE

ovoid setCountry(std::string const &)
set the ADDRESS_COUNTRY value

See Also:
ADDRESS_COUNTRY

ovoid setPhone(std::string const &)
set the PHONE_NUMBER value

See Also:
PHONE_NUMBER

ovirtual std::string const& getAddr(void) const
get the ADDRESS_LINE value

See Also:
ADDRESS_LINE

ovirtual std::string const& getAdr1(void) const
get the ADDRESS_LINE1 value

See Also:
ADDRESS_LINE1

ovirtual std::string const& getAdr2(void) const
get the ADDRESS_LINE2 value

See Also:
ADDRESS_LINE2

ovirtual std::string const& getCity(void) const
get the ADDRESS_CITY value

See Also:
ADDRESS_CITY

ovirtual std::string const& getState(void) const
get the ADDRESS_STATE value

See Also:
ADDRESS_STATE

ovirtual std::string const& getPost(void) const
get the ADDRESS_POSTAL_CODE value

See Also:
ADDRESS_POSTAL_CODE

ovirtual std::string const& getCountry(void) const
get the ADDRESS_COUNTRY value

See Also:
ADDRESS_COUNTRY

ovirtual std::string const& getPhone(void) const
get the PHONE_NUMBER value

See Also:
PHONE_NUMBER

ovirtual void Accept(GEDCOMParser::GEDCOMVisitor* )
Serialization method

o ADDRESS_STRUCTURE
ADDRESS_STRUCTURE values

o ADDRESS_LINE
Address information that, when combined with NAME and CONTinuation lines, meets requirements for sending communications through the mail.

o ADDRESS_LINE1
The first line of the address used for indexing. This corresponds to the ADDRESS_LINE value of the ADDR line in the address structure.

o ADDRESS_LINE2
The second line of the address used for indexing. This corresponds to the ADDRESS_LINE value of the first CONT line subordinate to the ADDR tag in the address structure.

o ADDRESS_CITY
The name of the city used in the address. Isolated for sorting or indexing.

o ADDRESS_STATE
The name of the state used in the address. Isolated for sorting or indexing.

o ADDRESS_POSTAL_CODE
The ZIP or postal code used by the various localities in handling of mail. Isolated for sorting or indexing.

o ADDRESS_COUNTRY
The name of the country that pertains to the associated address. Isolated by some systems for sorting or indexing. Used in most cases to facilitate automatic sorting of mail.

o PHONE_NUMBER
A phone number.


This class has no child classes.
See Also:
ADDRESS_STRUCTURE

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.