# Hurricane Documentation

# Hurricane VLSI Database

Contacts.h
1 // ****************************************************************************************************
2 // File: ./hurricane/Contacts.h
3 // Authors: R. Escassut
4 // Copyright (c) BULL S.A. 2000-2018, All Rights Reserved
5 //
6 // This file is part of Hurricane.
7 //
8 // Hurricane is free software: you can redistribute it and/or modify it under the terms of the GNU
9 // Lesser General Public License as published by the Free Software Foundation, either version 3 of the
10 // License, or (at your option) any later version.
11 //
12 // Hurricane is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
13 // the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU
14 // General Public License for more details.
15 //
16 // You should have received a copy of the Lesser GNU General Public License along with Hurricane. If
17 // not, see <http://www.gnu.org/licenses/>.
18 // ****************************************************************************************************
19
20 #ifndef HURRICANE_CONTACTS
21 #define HURRICANE_CONTACTS
22
23 #include "hurricane/Collection.h"
24
25 namespace Hurricane {
26
27 class Contact;
28
29
30
31 // ****************************************************************************************************
32 // Contacts declaration
33 // ****************************************************************************************************
34
35 typedef GenericCollection<Contact*> Contacts;
36
37
38
39 // ****************************************************************************************************
40 // ContactLocator declaration
41 // ****************************************************************************************************
42
43 typedef GenericLocator<Contact*> ContactLocator;
44
45
46
47 // ****************************************************************************************************
48 // ContactFilter declaration
49 // ****************************************************************************************************
50
51 typedef GenericFilter<Contact*> ContactFilter;
52
53
54
55 // ****************************************************************************************************
56 // for_each_contact declaration
57 // ****************************************************************************************************
58
59 #define for_each_contact(contact, contacts)\
60 /******************************************/\
61 {\
62 ContactLocator _locator = contacts.getLocator();\
63 while (_locator.isValid()) {\
64 Contact* contact = _locator.getElement();\
65 _locator.progress();
66
67
68
69 } // End of Hurricane namespace.
70
71 #endif // HURRICANE_CONTACTS
72
73
74 // ****************************************************************************************************
75 // Copyright (c) BULL S.A. 2000-2018, All Rights Reserved
76 // ****************************************************************************************************
Hurricane::GenericLocator
Generic Locator auto-pointer.
Definition: Locator.h:113
Hurricane::GenericFilter
Generic Filter auto-pointer.
Definition: Filter.h:27
Hurricane::Contact
Contact description (API)
Definition: Contact.h:33
Hurricane::ContactLocator
GenericLocator< Contact * > ContactLocator
Definition: Contacts.h:43
Hurricane::GenericCollection
Generic Collection auto-pointer.
Definition: Collection.h:28
Hurricane::Contacts
GenericCollection< Contact * > Contacts
Definition: Contacts.h:27
Hurricane
The namespace dedicated to Hurricane.
Definition: Generalities.dox:5
Hurricane::ContactFilter
GenericFilter< Contact * > ContactFilter
Definition: Contacts.h:51