Template:— representing_address_location (rep_add_locn)
Capability:representing_location
Date: 2005/08/15 08:20:35 :
Revision: 1.6

This section specifies the template representing_address_location.

NOTE  The template has been defined in the context of the capability representing_location which provides an overall description of the relevant parts of the ISO 10303-239 information model and a description of related templates.

NOTE  An explanation of a template and the associated instantiation path is provided in the Template overview section.

Description
This template describes the representation of an Address_based_location_representation. Postal Addresses are, generally, assigned by the national postal authority, with the agreement of the local administrative authority, and published in gazetteers.
Model diagrams
The EXPRESS-G diagram in Figure  shows the templates and EXPRESS entities that are required to represent the template "representing_address_location". The text highlighted in blue shows the template parameters.


Figure 1 —  

Figure 1 —  

The graphic for the template to be used in other EXPRESS-G diagrams is shown in Figure  below.


Figure 2 —  

Figure 2 —  

Input parameters
The following input parameters are defined for this template:
address_id (Default=Uknown,Type='STRING')
The identifier of this address location
address_type_code (Default=Address_based_location_identification_code,Type='CLASS', Optional)
The class name of the corresponding to the address id
The following classes and their sub-classes can be used:
classifications: "Address_based_location_identification_code" (urn:plcs:rdl:std:Address_based_location_identification_code)
address_ecl_id (Default=urn:plcs:rdl:std,Type='URN')
The identifier of the External_class_library storing the definition of the class referenced by the parameter @address_class_name.
name (Type='STRING', Optional)
The name or identifier of the address. Parameter is optional.
street_number (Type='STRING', Optional)
The number of a location on a street. . Parameter is optional.
street (Type='STRING', Optional)
The name of a street. Parameter is optional.
postal_box (Type='STRING', Optional)
The number of a postal box. Parameter is optional.
town (Type='STRING', Optional)
The name of a town. Parameter is optional.
region (Type='STRING', Optional)
The name or identifier of a region. Parameter is optional.
postal_code (Type='STRING', Optional)
The code that is used by the country's postal service. Parameter is optional.
country (Type='STRING', Optional)
The name of a country. Parameter is optional.
internal_location (Type='STRING', Optional)
An organization-defined address for internal mail delivery. Parameter is optional.
facsimile_number (Type='STRING', Optional)
The number to which facsimiles may be sent. Parameter is optional.
telephone_number (Type='STRING', Optional)
The number at which telephone calls may be received. Parameter is optional.
electronic_mail_address (Type='STRING', Optional)
The electronic address to which electronic mail may be sent. Parameter is optional.
telex_number (Type='STRING', Optional)
The number where telex messages may be received. Parameter is optional.
url (Type='STRING', Optional)
The text that specifies the Uniform Resource Locator associated with the address. Parameter is optional.
Reference parameters
The following reference parameters are defined for this template:
address(Type='ENTITY (Address)')
Allow the Address entity instantiated in this path to be referenced when this template is used.
Note: The Address entity can be referenced in a template path by:
%^target = $representing_address_location.address%
where target is the parameter to which the Address is bound.
address_loc_rep(Type='ENTITY (Address_based_location_representation)')
Allow the Address_based_location_representation entity instantiated in this path to be referenced when this template is used.
Note: The Address_based_location_representation entity can be referenced in a template path by:
%^target = $representing_address_location.address_loc_rep%
where target is the parameter to which the Address_based_location_representation is bound.
Instantiation path
The instantiation path shown below specifies the entities that are to be instantiated by the template.
A description of templates and the syntax for the instantiation path is provided in the Templates Help/Information section.
-- Instantiate an Address_based_location_representation
Address_based_location_representation

-- Bind the Address_based_location_representation to the parameter ^address_loc_rep.
-- The parameter is a reference parameter so the Address_based_location_representation
-- entity can be referred to when this template is used.
%^address_loc_rep = Address_based_location_representation%

-- Assign reference data to Address_assignment
/assigning_identification_with_no_organization(
    items=^address_loc_rep,
    id=@address_id,
    id_class_name=@address_type_code,
    id_ecl_id=@address_ecl_id)/

-- Instantiate and point at an entity Address
Address_based_location_representation.postal_address -> Address

-- Set the Address attributes
Address.name -> @name
Address.street_number -> @street_number
Address.street -> @street
Address.postal_box -> @postal_box
Address.town -> @town
Address.region -> @region
Address.postal_code -> @postal_code
Address.country -> @country
Address.internal_location -> @internal_location
Address.facsimile_number -> @facsimile_number
Address.telephone_number -> @telephone_number
Address.electronic_mail_address -> @electronic_mail_address
Address.telex_number -> @telex_number
Address.url -> @url

-- Bind the Address entity to the parameter ^address.
-- The parameter is a reference parameter so the Address
-- entity can be referred to when this template is used.
%^address = Address%
Instance diagrams
The instance diagram in Figure  shows an example of the EXPRESS entities and templates that are instantiated by the template:


Figure 3 —  

Figure 3 —  

Characterizations
No common characterizations of the template representing_address_location have been identified. However, the ISO 10303-239 EXPRESS model may enable other assignments to the entities instantiated by the template.

© OASIS 2010 — All rights reserved