Portuguese eID Middleware SDK  Version: 3.12.0
eIDMW::PTEID_Address Class Reference

#include <eidlib.h>

Public Member Functions

virtual PTEIDSDK_API ~PTEID_Address ()
 
PTEIDSDK_API bool isNationalAddress ()
 
PTEIDSDK_API const char * getCountryCode ()
 
PTEIDSDK_API const char * getDistrict ()
 
PTEIDSDK_API const char * getDistrictCode ()
 
PTEIDSDK_API const char * getMunicipality ()
 
PTEIDSDK_API const char * getMunicipalityCode ()
 
PTEIDSDK_API const char * getCivilParish ()
 
PTEIDSDK_API const char * getCivilParishCode ()
 
PTEIDSDK_API const char * getAbbrStreetType ()
 
PTEIDSDK_API const char * getStreetType ()
 
PTEIDSDK_API const char * getStreetName ()
 
PTEIDSDK_API const char * getAbbrBuildingType ()
 
PTEIDSDK_API const char * getBuildingType ()
 
PTEIDSDK_API const char * getDoorNo ()
 
PTEIDSDK_API const char * getFloor ()
 
PTEIDSDK_API const char * getSide ()
 
PTEIDSDK_API const char * getLocality ()
 
PTEIDSDK_API const char * getPlace ()
 
PTEIDSDK_API const char * getZip4 ()
 
PTEIDSDK_API const char * getZip3 ()
 
PTEIDSDK_API const char * getPostalLocality ()
 
PTEIDSDK_API const char * getGeneratedAddressCode ()
 
PTEIDSDK_API const char * getForeignCountry ()
 
PTEIDSDK_API const char * getForeignAddress ()
 
PTEIDSDK_API const char * getForeignCity ()
 
PTEIDSDK_API const char * getForeignRegion ()
 
PTEIDSDK_API const char * getForeignLocality ()
 
PTEIDSDK_API const char * getForeignPostalCode ()
 
- Public Member Functions inherited from eIDMW::PTEID_Object
virtual PTEIDSDK_API ~PTEID_Object ()=0
 
NOEXPORT_PTEIDSDK void Init (const SDK_Context *context, void *impl)
 
NOEXPORT_PTEIDSDK void Release ()
 

Friends

PTEID_AddressPTEID_EIDCard::getAddr ()
 

Additional Inherited Members

- Protected Member Functions inherited from eIDMW::PTEID_Object
 PTEID_Object (const SDK_Context *context, void *impl)
 
void addObject (PTEID_Object *impl)
 
void backupObject (unsigned long idx)
 
PTEID_ObjectgetObject (unsigned long idx)
 
PTEID_ObjectgetObject (void *impl)
 
void delObject (unsigned long idx)
 
void delObject (void *impl)
 
void checkContextStillOk () const
 
 PTEID_Object (const PTEID_Object &obj)
 
PTEID_Objectoperator= (const PTEID_Object &obj)
 
- Protected Attributes inherited from eIDMW::PTEID_Object
bool m_delimpl
 
void * m_impl
 
unsigned long m_ulIndexExtAdd
 
std::map< unsigned long, PTEID_Object * > m_objects
 
SDK_Context * m_context
 

Detailed Description

Class for the Address document on a EID Card. You can get such an object from PTEID_EIDCard::getAddr().

Constructor & Destructor Documentation

◆ ~PTEID_Address()

virtual PTEIDSDK_API eIDMW::PTEID_Address::~PTEID_Address ( )
virtual

Destructor

Member Function Documentation

◆ getAbbrBuildingType()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getAbbrBuildingType ( )

Return field Abbreviated building type

◆ getAbbrStreetType()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getAbbrStreetType ( )

Return field Abbreviated street type

◆ getBuildingType()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getBuildingType ( )

Return field Building Type

◆ getCivilParish()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getCivilParish ( )

Return field Civil Parish

◆ getCivilParishCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getCivilParishCode ( )

Return field Civil Parish Code

◆ getCountryCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getCountryCode ( )

Return field country

◆ getDistrict()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getDistrict ( )

Return field District

◆ getDistrictCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getDistrictCode ( )

Return field District Code

◆ getDoorNo()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getDoorNo ( )

Return field Door Number

◆ getFloor()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getFloor ( )

Return field Floor

◆ getForeignAddress()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignAddress ( )

Return foreign address generic address field - may contain street name, door number, or other address elements

◆ getForeignCity()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignCity ( )

Return foreign address city

◆ getForeignCountry()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignCountry ( )

Return foreign address 2-letter ISO 3166-1 country code

◆ getForeignLocality()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignLocality ( )

Return foreign address locality

◆ getForeignPostalCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignPostalCode ( )

Return foreign address postal code - format is country-dependent

◆ getForeignRegion()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getForeignRegion ( )

Return foreign address region

◆ getGeneratedAddressCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getGeneratedAddressCode ( )

Return field Address Code

◆ getLocality()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getLocality ( )

Return field Locality

◆ getMunicipality()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getMunicipality ( )

Return field Municipality

◆ getMunicipalityCode()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getMunicipalityCode ( )

Return field Municipality Code

◆ getPlace()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getPlace ( )

Return field Place

◆ getPostalLocality()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getPostalLocality ( )

Return field Postal Locality

◆ getSide()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getSide ( )

Return field Side

◆ getStreetName()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getStreetName ( )

Return field StreetName

◆ getStreetType()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getStreetType ( )

Return field StreetType

◆ getZip3()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getZip3 ( )

Return field Zip3

◆ getZip4()

PTEIDSDK_API const char* eIDMW::PTEID_Address::getZip4 ( )

Return field Zip4

◆ isNationalAddress()

PTEIDSDK_API bool eIDMW::PTEID_Address::isNationalAddress ( )

Is this address a portuguese address?

Friends And Related Function Documentation

◆ PTEID_EIDCard::getAddr

For internal use : This method must access protected constructor