System: do_all_taxes

Directory path: /home/oo1/oo1home/mt1/le_demos/tax_example/

Created on: Tue Aug 25 20:10:07 2015

HAMILTON TECHNOLOGIES INC. Collector Version: 6.1; Copyright 1991-2015.

This system has been defined in USL, automatically analyzed, automatically generatated/resource allocated (RAT)ed to C code, and automatically documented in HTML using the 001 Toolsuite.

Video describing the life cycle process.

CONTENTS

• 1 do_all_taxes
• 1.1 forall
• 1.1.1 isSetOK_1
• 1.2 compute_tax

Overview of Models

The following section gives an overview of the functionality of the system. The functions in the overview are listed in the order in which they first appear.

• 1 do_all_taxes.

  Interface: DB:taxDB=Do_All_Taxes(DB0:taxDB)

  do_all_taxes will access the tax rate from the database (db0) and for each person in the employees database calculate and update their tax entry. This process will be repeated for the friends database. The final result will be returned to the central database as DB.

• 1.1 forall.

  Interface: set:Any=ForALL(set0:Any)

  forall checks set0, a set, to see if it is REJECT, an empty OMap PLACE or an EMPTY set. If not, the first element is located; then, all the elements of set are processed by DoFunction.

  e1:Any=DoFunction(element:Any,P:Any)

  When all elements of set set0 have been processed, the completed set is returned as the output of ForALL.

• 1.1.1 isSetOK_1.

  Interface: c1:Any=isSetOK_1(c0:Any)

  issetok_1 checks c0, a set, to see if it is REJECT, a PLACE or EMPTY. If any of these conditions exist for c0; then it is simply returned as c1. If not, the following function is called:

  c1:Any=F(c0:Any,1:Any)

• 1.2 compute_tax.

  Interface: fred_with_tax:PERSON=Compute_Tax(fred:PERSON)

  compute_tax will compute the tax of fred, a PERSON, with a given rate, a rate. The resulting tax is used to update fred who will now be fred_with_tax.

TMAP

Type: TaxDB Extends TupleOf

Primitive Operations:

Create (K) or Delete (D) a TaxDB object:

• TaxDB=K:TaxDB(Any)
• TaxDB=K:Reject,taxDB(Any)
• Boolean=D:TaxDB(TaxDB)

Query the state of a TaxDB object:

• Boolean=Is:Place,taxDB(TaxDB) Is TaxDB an empty OMap place?
• Boolean=Is:Reject,taxDB(TaxDB) Is TaxDB a Reject value?

Conversions to work with TaxDB as an OMap object:

• OMap=Convert:OMap,TaxDB(TaxDB)
• TaxDB=Convert:TaxDB,OMap(OMap)

Access a TaxDB child object:

• Rat=Moveto:rate,taxDB(TaxDB)
• Employees=Moveto:Employees,taxDB(TaxDB)
• Friends=Moveto:Friends,taxDB(TaxDB)

Access the TaxDB container of an OMap child object:

• TaxDB=Upto:taxDB,Employees(Employees)
• TaxDB=Upto:taxDB,Friends(Friends)

Get a TaxDB child object from its OMap place:

• Rat,TaxDB=get:Rate,TaxDB(TaxDB)
• Employees,TaxDB=get:Employees,TaxDB(TaxDB)
• Friends,TaxDB=get:Friends,TaxDB(TaxDB)

Put a TaxDB child object into its OMap place:

• TaxDB=put:Rate,TaxDB(Rat,TaxDB)
• TaxDB=put:Employees,TaxDB(Employees,TaxDB)
• TaxDB=put:Friends,TaxDB(Friends,TaxDB)

Type: PERSON Extends TupleOf

Primitive Operations:

Create (K) or Delete (D) a PERSON object:

• PERSON=K:PERSON(Any)
• PERSON=K:Reject,PERSON(Any)
• Boolean=D:PERSON(PERSON)

Query the state of a PERSON object:

• Boolean=Is:Place,PERSON(PERSON) Is PERSON an empty OMap place?
• Boolean=Is:Reject,PERSON(PERSON) Is PERSON a Reject value?

Conversions to work with PERSON as an OMap object:

• OMap=Convert:OMap,PERSON(PERSON)
• PERSON=Convert:PERSON,OMap(OMap)

Access a PERSON child object:

• Str=Moveto:Name,PERSON(PERSON)
• Rat=Moveto:decuctions,PERSON(PERSON)
• Rat=Moveto:Income,PERSON(PERSON)
• Rat=Moveto:Tax,PERSON(PERSON)

Get a PERSON child object from its OMap place:

• Str,PERSON=get:Name,PERSON(PERSON)
• Rat,PERSON=get:deductions,PERSON(PERSON)
• Rat,PERSON=get:Income,PERSON(PERSON)
• Rat,PERSON=get:Tax,PERSON(PERSON)

Put a PERSON child object into its OMap place:

• PERSON=put:Name,PERSON(Str,PERSON)
• PERSON=put:deductions,PERSON(Rat,PERSON)
• PERSON=put:Income,PERSON(Rat,PERSON)
• PERSON=put:Tax,PERSON(Rat,PERSON)

Type: Employees Extends OSetOf

Primitive Operations:

Create (K) or Delete (D) a Employees object:

• Employees=K:Employees(Any)
• Employees=K:Reject,Employees(Any)
• Boolean=D:Employees(Employees)

Query the state of a Employees object:

• Boolean=Is:Place,Employees(Employees) Is Employees an empty OMap place?
• Boolean=Is:Reject,Employees(Employees) Is Employees a Reject value?

Conversions to work with Employees as an OMap object:

• OMap=Convert:OMap,Employees(Employees)
• Employees=Convert:Employees,OMap(OMap)

Access a Employees child object:

• PERSON=Moveto:Employee,Employees(Employees)

Access the Employees container of an OMap child object:

• Employees=Upto:Employees,Employee(PERSON)

Get a Employees child object from its OMap place:

• PERSON,Employees=get:Employee,Employees(Employees)

Put a Employees child object into its OMap place:

• Employees=put:Employee,Employees(PERSON,Employees)

Primitive Operations specific to OSetOf Employees used in this system:

• Boolean=AtNull:Employees(Employees)
• Boolean=is:EMPTY,Employees(Employees)
• Employees=Locate:Employees(Nat,Employees)
• Employees=Next:Employees(Char,Employees)

Type: Friends Extends OSetOf

Primitive Operations:

Create (K) or Delete (D) a Friends object:

• Friends=K:Friends(Any)
• Friends=K:Reject,Friends(Any)
• Boolean=D:Friends(Friends)

Query the state of a Friends object:

• Boolean=Is:Place,Friends(Friends) Is Friends an empty OMap place?
• Boolean=Is:Reject,Friends(Friends) Is Friends a Reject value?

Conversions to work with Friends as an OMap object:

• OMap=Convert:OMap,Friends(Friends)
• Friends=Convert:Friends,OMap(OMap)

Access a Friends child object:

• PERSON=Moveto:friend,Friends(Friends)

Access the Friends container of an OMap child object:

• Friends=Upto:Friends,friend(PERSON)

Get a Friends child object from its OMap place:

• PERSON,Friends=get:friend,Friends(Friends)

Put a Friends child object into its OMap place:

• Friends=put:friend,Friends(PERSON,Friends)

Primitive Operations specific to OSetOf Friends used in this system:

• Boolean=AtNull:Friends(Friends)
• Boolean=is:EMPTY,Friends(Friends)
• Friends=Locate:Friends(Nat,Friends)
• Friends=Next:Friends(Char,Friends)

OPERATIONS and STRUCTURES

1 do_all_taxes.

do_all_taxes will access the tax rate from the database (db0) and for each person in the employees database calculate and update their tax entry. This process will be repeated for the friends database. The final result will be returned to the central database as DB.

(do_all_taxes.c)

do_all_taxes uses DB0 (which is of type taxDB) to produce DB (which is of type taxDB). Following is a list of the types of objects being used by this FMap:

• FRIENDS,
• EMPLOYEES,
• PERSON,
• TAXDB and
• RAT.

Interface: DB:taxDB=Do_All_Taxes(DB0:taxDB)

Move to rate, taxrate, of taxDB, DB0. Move to employees, emps0, of taxDB, DB0. ForEmployees checks emps0, a employees, to see if it is REJECT, an empty OMap PLACE or an EMPTY set. If not, the first employee is located; then, all the employees of employees are processed by Compute_Tax.

anEMP:PERSON=Compute_Tax(anEMP0:PERSON,taxrate:rat)

When all employees of employees emps0 have been processed, the completed EMPs is returned as the output of ForEmployees.

Compute_Tax will compute the tax of anEMP0, a PERSON, with a given rate, a taxrate. The resulting tax is used to update anEMP0 who will now be anEMP. Go upto the taxDB, DB1, containing EMPs. Move to friends, friends0, of taxDB, DB1. ForFriends checks friends0, a friends, to see if it is REJECT, an empty OMap PLACE or an EMPTY set. If not, the first friend is located; then, all the friends of friends are processed by Compute_Tax.

aFRIEND:PERSON=Compute_Tax(aFRIEND0:PERSON,taxrate:rat)

When all friends of friends friends0 have been processed, the completed friends is returned as the output of ForFriends.

Compute_Tax will compute the tax of aFRIEND0, a PERSON, with a given rate, a taxrate. The resulting tax is used to update aFRIEND0 who will now be aFRIEND. Go upto the taxDB, DB, containing friends.

1.1 forall.

forall checks set0, a set, to see if it is REJECT, an empty OMap PLACE or an EMPTY set. If not, the first element is located; then, all the elements of set are processed by DoFunction.

e1:Any=DoFunction(element:Any,P:Any)

When all elements of set set0 have been processed, the completed set is returned as the output of ForALL.

()

forall uses set0 (which is of type Any) and P (which is of type Any) to produce set (which is of type Any). All objects in this FMap are of type Any.

Interface: set:Any=ForALL(set0:Any)

ForALL checks set0, a set, to see if it is REJECT, a PLACE or EMPTY. If any of these conditions exist for set0; then it is simply returned as set. If not, the following function is called:

set:Any=process_set_elements(set0:Any,P:Any)

Locate element 1 of set0 which will now become set1 with a new currency. The function REPEAT is to be repeated. The decision, REPEAT, chooses one of the following alternatives based on the result of atnull:set: process_an_element or clone1:any.

If atnull:set (of REPEAT) returns FALSE, then process_an_element is done as follows. Function, moveto:element:set, uses inputs: set1 to produce: element (of type Any).

Plugin Interface: e1:Any=DoFunction(element:Any)

Function, upto:set:element, uses inputs: e1 to produce: set2 (of type Any). Function, next:set, uses inputs: R and set2 to produce: setn (of type Any). Repeat the ancestor function REPEAT with the following input changes: replace set1 with setn and P with P.

If atnull:set (of REPEAT) returns TRUE, then clone1:any is done as follows. set is assigned to be the same object as set1.

1.1.1 isSetOK_1.

issetok_1 checks c0, a set, to see if it is REJECT, a PLACE or EMPTY. If any of these conditions exist for c0; then it is simply returned as c1. If not, the following function is called:

c1:Any=F(c0:Any,1:Any)

()

issetok_1 uses c0 (which is of type Any) and 1 (which is of type Any) to produce c1 (which is of type Any). All objects in this FMap are of type Any.

Interface: c1:Any=isSetOK_1(c0:Any)

The decision, isSetOK_1, chooses one of the following alternatives based on the result of is:REJECT:SET: NULL_or_NOT or clone1:any.

If is:REJECT:SET (of isSetOK_1) returns FALSE, then NULL_or_NOT is done as follows. The decision, NULL_or_NOT, chooses one of the following alternatives based on the result of is:PLACE:SET: EMPTY_or_NOT or clone1:any.

If is:PLACE:SET (of NULL_or_NOT) returns FALSE, then EMPTY_or_NOT is done as follows. The decision, EMPTY_or_NOT, chooses one of the following alternatives based on the result of is:EMPTY:SET: F or clone1:any.

If is:EMPTY:SET (of EMPTY_or_NOT) returns FALSE, then F is done as follows.

Plugin Interface: c1:Any=F(c0:Any)

If is:EMPTY:SET (of EMPTY_or_NOT) returns TRUE, then clone1:any is done as follows. c1 is assigned to be the same object as c0.

If is:PLACE:SET (of NULL_or_NOT) returns TRUE, then clone1:any is done as follows. c1 is assigned to be the same object as c0.

If is:REJECT:SET (of isSetOK_1) returns TRUE, then clone1:any is done as follows. c1 is assigned to be the same object as c0.

1.2 compute_tax.

compute_tax will compute the tax of fred, a PERSON, with a given rate, a rate. The resulting tax is used to update fred who will now be fred_with_tax.

(compute_tax.c)

compute_tax uses fred (which is of type PERSON) and rate (which is of type rat) to produce fred_with_tax (which is of type PERSON). Following is a list of the types of objects being used by this FMap:

• RAT and
• PERSON.

Interface: fred_with_tax:PERSON=Compute_Tax(fred:PERSON)

Move to income, i, of PERSON, fred. Multiply i and rate to get tax. Put tax (a rat) into fred (a PERSON) to produce fred_with_tax.