diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..412eeda --- /dev/null +++ b/.gitattributes @@ -0,0 +1,22 @@ +# Auto detect text files and perform LF normalization +* text=auto + +# Custom for Visual Studio +*.cs diff=csharp +*.sln merge=union +*.csproj merge=union +*.vbproj merge=union +*.fsproj merge=union +*.dbproj merge=union + +# Standard to msysgit +*.doc diff=astextplain +*.DOC diff=astextplain +*.docx diff=astextplain +*.DOCX diff=astextplain +*.dot diff=astextplain +*.DOT diff=astextplain +*.pdf diff=astextplain +*.PDF diff=astextplain +*.rtf diff=astextplain +*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b9d6bd9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,215 @@ +################# +## Eclipse +################# + +*.pydevproject +.project +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.classpath +.settings/ +.loadpath + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# CDT-specific +.cproject + +# PDT-specific +.buildpath + + +################# +## Visual Studio +################# + +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. + +# User-specific files +*.suo +*.user +*.sln.docstates + +# Build results + +[Dd]ebug/ +[Rr]elease/ +x64/ +build/ +[Bb]in/ +[Oo]bj/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +*_i.c +*_p.c +*.ilk +*.meta +*.obj +*.pch +*.pdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.log +*.scc + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opensdf +*.sdf +*.cachefile + +# Visual Studio profiler +*.psess +*.vsp +*.vspx + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# NCrunch +*.ncrunch* +.*crunch*.local.xml + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.Publish.xml +*.pubxml + +# NuGet Packages Directory +## TODO: If you have NuGet Package Restore enabled, uncomment the next line +#packages/ + +# Windows Azure Build Output +csx +*.build.csdef + +# Windows Store app package directory +AppPackages/ + +# Others +sql/ +*.Cache +ClientBin/ +[Ss]tyle[Cc]op.* +~$* +*~ +*.dbmdl +*.[Pp]ublish.xml +*.pfx +*.publishsettings + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file to a newer +# Visual Studio version. Backup files are not needed, because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm + +# SQL Server files +App_Data/*.mdf +App_Data/*.ldf + +############# +## Windows detritus +############# + +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Mac crap +.DS_Store + + +############# +## Python +############# + +*.py[co] + +# Packages +*.egg +*.egg-info +dist/ +build/ +eggs/ +parts/ +var/ +sdist/ +develop-eggs/ +.installed.cfg + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox + +#Translations +*.mo + +#Mr Developer +.mr.developer.cfg diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/SimSharp.Samples/App.config b/SimSharp.Samples/App.config new file mode 100644 index 0000000..74ade9d --- /dev/null +++ b/SimSharp.Samples/App.config @@ -0,0 +1,6 @@ + + + + + + diff --git a/SimSharp.Samples/MachineShopSimulation.cs b/SimSharp.Samples/MachineShopSimulation.cs new file mode 100644 index 0000000..561348b --- /dev/null +++ b/SimSharp.Samples/MachineShopSimulation.cs @@ -0,0 +1,178 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace SimSharp.Samples { + public class MachineShopSimulation { + /* +Machine shop example + +Covers: + +- Interrupts +- Resources: PreemptiveResource + +Scenario: + A workshop has *n* identical machines. A stream of jobs (enough to + keep the machines busy) arrives. Each machine breaks down + periodically. Repairs are carried out by one repairman. The repairman + has other, less important tasks to perform, too. Broken machines + preempt theses tasks. The repairman continues them when he is done + with the machine repair. The workshop works continuously. +*/ + + private const int RANDOM_SEED = 42; + private const double PT_MEAN = 10.0; // Avg. processing time in minutes + private const double PT_SIGMA = 2.0; // Sigma of processing time + private const double MTTF = 300.0; // Mean time to failure in minutes + private const double BREAK_MEAN = 1 / MTTF; // Param. for expovariate distribution + private const double REPAIR_TIME = 30.0; // Time it takes to repair a machine in minutes + private const double JOB_DURATION = 30.0; // Duration of other jobs in minutes + private const int NUM_MACHINES = 10; // Number of machines in the machine shop + private static readonly TimeSpan SIM_TIME = TimeSpan.FromDays(28); // Simulation time in minutes + + private static readonly Random random = new Random(RANDOM_SEED); + + public static double time_per_part() { + // Return actual processing time for a concrete part. + return RandomDist.Normal(random, PT_MEAN, PT_SIGMA); + } + + public static double time_to_failure() { + // Return time until next failure for a machine. + return RandomDist.Exponential(random, BREAK_MEAN); + } + + public class Machine : ActiveObject { + /* + A machine produces parts and my get broken every now and then. + If it breaks, it requests a *repairman* and continues the production + after the it is repaired. + + A machine has a *name* and a numberof *parts_made* thus far. + */ + + public string name; + public int parts_made; + public bool broken; + public Process process; + + public Machine(Environment env, string name, Resource repairman) + : base(env) { + this.name = name; + this.parts_made = 0; + this.broken = false; + + // Start "working" and "break_machine" processes for this machine. + this.process = env.Process(working(repairman)); + env.Process(break_machine()); + } + + private IEnumerable working(Resource repairman) { + /* + Produce parts as long as the simulation runs. + + While making a part, the machine may break multiple times. + Request a repairman when this happens. + */ + while (true) { + // Start making a new part + var doneIn = TimeSpan.FromMinutes(time_per_part()); + while (doneIn > TimeSpan.Zero) { + // Working on the part + var start = Environment.Now; + yield return Environment.Timeout(doneIn); + if (Environment.ActiveProcess.HandleFault()) { + broken = true; + doneIn -= Environment.Now - start; + // How much time left? + // Request a repairman. This will preempt its "other_job". + using (var req = repairman.Request(priority: 1, preempt: true)) { + yield return req; + yield return Environment.Timeout(TimeSpan.FromMinutes(REPAIR_TIME)); + } + broken = false; + } else { + doneIn = TimeSpan.Zero; // Set to 0 to exit while loop. + } + } + // Part is done. + parts_made++; + } + } + + private IEnumerable break_machine() { + // Break the machine every now and then. + while (true) { + yield return Environment.Timeout(TimeSpan.FromMinutes(time_to_failure())); + if (!broken) { + // Only break the machine if it is currently working. + process.Interrupt(); + } + } + } + } + + private static IEnumerable other_jobs(Environment env, Resource repairman) { + // The repairman's other (unimportant) job. + while (true) { + // Start a new job + var done_in = TimeSpan.FromMinutes(JOB_DURATION); + while (done_in > TimeSpan.Zero) { + // Retry the job until it is done. + // It's priority is lower than that of machine repairs. + using (var req = repairman.Request(priority: 2)) { + yield return req; + var start = env.Now; + yield return env.Timeout(done_in); + if (env.ActiveProcess.HandleFault()) + done_in -= env.Now - start; + else done_in = TimeSpan.Zero; + } + } + } + } + + public static void Main(string[] args) { + // Setup and start the simulation + Console.Out.WriteLine("Machine shop"); + // Create an environment and start the setup process + var start = new DateTime(2014, 2, 1); + var env = new Environment(start); + var repairman = new PreemptiveResource(env, 1); + var machines = Enumerable.Range(0, NUM_MACHINES).Select(x => new Machine(env, "Machine " + x, repairman)).ToArray(); + env.Process(other_jobs(env, repairman)); + + var startPerf = DateTime.UtcNow; + // Execute! + env.Run(SIM_TIME); + var perf = DateTime.UtcNow - startPerf; + + // Analyis/results + Console.Out.WriteLine("Machine shop results after {0} days.", (env.Now - start).TotalDays); + foreach (var machine in machines) + Console.Out.WriteLine("{0} made {1} parts.", machine.name, machine.parts_made); + Console.Out.WriteLine(); + Console.Out.WriteLine("Processed {0} events in {1} seconds ({2} events/s).", env.ProcessedEvents, perf.TotalSeconds, (env.ProcessedEvents / perf.TotalSeconds)); + Console.In.ReadLine(); + } + } +} diff --git a/SimSharp.Samples/Properties/AssemblyInfo.cs b/SimSharp.Samples/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..1a41934 --- /dev/null +++ b/SimSharp.Samples/Properties/AssemblyInfo.cs @@ -0,0 +1,53 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Reflection; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("SimSharp.Samples")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("HEAL")] +[assembly: AssemblyProduct("SimSharp.Samples")] +[assembly: AssemblyCopyright("Copyright © HEAL 2014")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("04641eff-4cc6-4405-8341-8b043293a8f2")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/SimSharp.Samples/SimSharp.Samples.csproj b/SimSharp.Samples/SimSharp.Samples.csproj new file mode 100644 index 0000000..28e5769 --- /dev/null +++ b/SimSharp.Samples/SimSharp.Samples.csproj @@ -0,0 +1,69 @@ + + + + + Debug + AnyCPU + {160EE4A5-D14D-4147-BE99-536F03A68CCB} + Exe + Properties + SimSharp.Samples + SimSharp.Samples + v4.0 + 512 + + + + AnyCPU + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + SimSharp.Samples.MachineShopSimulation + + + + + + + + + + + + + + + + + + + + + {9fe9c740-7859-4d01-ad07-7d4e15a6320b} + SimSharp + + + + + \ No newline at end of file diff --git a/SimSharp.Samples/SteelFactorySimulation.cs b/SimSharp.Samples/SteelFactorySimulation.cs new file mode 100644 index 0000000..76dcd62 --- /dev/null +++ b/SimSharp.Samples/SteelFactorySimulation.cs @@ -0,0 +1,56 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; +using System.Collections.Generic; + +namespace SimSharp.Samples { + class SteelFactorySimulation { + class MySlab { + public TimeSpan CastTime { get; private set; } + public MySlab(double castTimeInMinutes) { + CastTime = TimeSpan.FromMinutes(castTimeInMinutes); + } + } + + private static IEnumerable Cast(Environment environment, Resource crane, string name, IEnumerable castQueue) { + foreach (var slab in castQueue) { + yield return environment.Timeout(slab.CastTime); + Console.Out.WriteLine("Caster {0} finished at {1}", name, environment.Now); + var token = crane.Request(); + yield return token; + environment.Process(Transport(environment, crane, token, name)); + } + } + + private static IEnumerable Transport(Environment environment, Resource crane, Request token, string caster) { + Console.Out.WriteLine("Crane transporting from caster {0} at {1}", caster, environment.Now); + yield return environment.Timeout(TimeSpan.FromMinutes(4)); + crane.Release(token); + } + + static void Main(string[] args) { + var env = new Environment(); + var crane = new Resource(env, 1); + env.Process(Cast(env, crane, "CC1", new[] { new MySlab(4), new MySlab(4), new MySlab(8), new MySlab(3), new MySlab(2) })); + env.Process(Cast(env, crane, "CC2", new[] { new MySlab(2), new MySlab(3), new MySlab(3), new MySlab(4), new MySlab(3) })); + env.Run(TimeSpan.FromMinutes(100)); + Console.ReadLine(); + } + } +} diff --git a/SimSharp.Tests/EnvironmentTests.cs b/SimSharp.Tests/EnvironmentTests.cs new file mode 100644 index 0000000..eefbee6 --- /dev/null +++ b/SimSharp.Tests/EnvironmentTests.cs @@ -0,0 +1,99 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; +using System.Collections.Generic; +using System.Linq; +using Microsoft.VisualStudio.TestTools.UnitTesting; + +namespace SimSharp.Tests { + [TestClass] + public class EnvironmentTests { + + private static IEnumerable AProcess(Environment env, List log) { + while (env.Now < new DateTime(1970, 1, 1, 0, 2, 0)) { + log.Add(env.Now.ToString("mm")); + yield return env.Timeout(TimeSpan.FromMinutes(1)); + } + } + + [TestMethod] + public void test_event_queue_empty() { + /*The simulation should stop if there are no more events, that means, no + more active process.*/ + var log = new List(); + var env = new Environment(); + env.Process(AProcess(env, log)); + env.Run(TimeSpan.FromMinutes(10)); + Assert.IsTrue(log.SequenceEqual(new[] { "00", "01" })); + } + + [TestMethod] + public void test_run_negative_until() { + /*Test passing a negative time to run.*/ + var env = new Environment(); + var errorThrown = false; + try { + env.Run(new DateTime(1969, 12, 30)); + } catch (InvalidOperationException) { + errorThrown = true; + } + Assert.IsTrue(errorThrown); + } + + [TestMethod] + public void test_run_resume() { + /* Stopped simulation can be resumed. */ + var env = new Environment(); + var events = new List() { + env.Timeout(TimeSpan.FromMinutes(5)), + env.Timeout(TimeSpan.FromMinutes(10)), + env.Timeout(TimeSpan.FromMinutes(15)) + }; + + Assert.AreEqual(env.Now, new DateTime(1970, 1, 1)); + Assert.IsFalse(events.Any(x => x.IsProcessed)); + + env.Run(TimeSpan.FromMinutes(10)); + Assert.AreEqual(env.Now, new DateTime(1970, 1, 1, 0, 10, 0)); + Assert.IsTrue(events[0].IsProcessed); + Assert.IsFalse(events[1].IsProcessed); + Assert.IsFalse(events[2].IsProcessed); + + env.Run(TimeSpan.FromMinutes(5)); + Assert.AreEqual(env.Now, new DateTime(1970, 1, 1, 0, 15, 0)); + Assert.IsTrue(events[0].IsProcessed); + Assert.IsTrue(events[1].IsProcessed); + Assert.IsFalse(events[2].IsProcessed); + + env.Run(); + Assert.AreEqual(env.Now, new DateTime(1970, 1, 1, 0, 15, 0)); + Assert.IsTrue(events[0].IsProcessed); + Assert.IsTrue(events[1].IsProcessed); + Assert.IsTrue(events[2].IsProcessed); + } + + [TestMethod] + public void test_run_until_value() { + /* Anything that can be converted to a float is a valid until value. */ + var env = new Environment(); + env.Run(new DateTime(1980, 9, 16, 18, 45, 0)); + Assert.AreEqual(env.Now, new DateTime(1980, 9, 16, 18, 45, 0)); + } + } +} diff --git a/SimSharp.Tests/Properties/AssemblyInfo.cs b/SimSharp.Tests/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..9ad833a --- /dev/null +++ b/SimSharp.Tests/Properties/AssemblyInfo.cs @@ -0,0 +1,53 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Reflection; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("SimSharp.Tests")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("FH-Hagenberg")] +[assembly: AssemblyProduct("SimSharp.Tests")] +[assembly: AssemblyCopyright("Copyright © FH-Hagenberg 2014")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("27d3a92a-3d2e-41c2-84c3-bc052ed4e5c9")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/SimSharp.Tests/SimSharp.Tests.csproj b/SimSharp.Tests/SimSharp.Tests.csproj new file mode 100644 index 0000000..f0f687e --- /dev/null +++ b/SimSharp.Tests/SimSharp.Tests.csproj @@ -0,0 +1,90 @@ + + + + Debug + AnyCPU + {40F8848F-605E-4CAA-9512-B2812476CC9A} + Library + Properties + SimSharp.Tests + SimSharp.Tests + v4.0 + 512 + {3AC096D0-A1C2-E12C-1390-A8335801FDAB};{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC} + 10.0 + $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) + $(ProgramFiles)\Common Files\microsoft shared\VSTT\$(VisualStudioVersion)\UITestExtensionPackages + False + UnitTest + + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + + + + + + + + {9fe9c740-7859-4d01-ad07-7d4e15a6320b} + SimSharp + + + + + + + False + + + False + + + False + + + False + + + + + + + + \ No newline at end of file diff --git a/SimSharp.sln b/SimSharp.sln new file mode 100644 index 0000000..7ca3956 --- /dev/null +++ b/SimSharp.sln @@ -0,0 +1,40 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 2013 +VisualStudioVersion = 12.0.30110.0 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimSharp", "SimSharp\SimSharp.csproj", "{9FE9C740-7859-4D01-AD07-7D4E15A6320B}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{5BC56A42-5229-4380-BF91-3A2EB70332C3}" + ProjectSection(SolutionItems) = preProject + LICENSE.txt = LICENSE.txt + TODO.txt = TODO.txt + EndProjectSection +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimSharp.Samples", "SimSharp.Samples\SimSharp.Samples.csproj", "{160EE4A5-D14D-4147-BE99-536F03A68CCB}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SimSharp.Tests", "SimSharp.Tests\SimSharp.Tests.csproj", "{40F8848F-605E-4CAA-9512-B2812476CC9A}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {9FE9C740-7859-4D01-AD07-7D4E15A6320B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {9FE9C740-7859-4D01-AD07-7D4E15A6320B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {9FE9C740-7859-4D01-AD07-7D4E15A6320B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {9FE9C740-7859-4D01-AD07-7D4E15A6320B}.Release|Any CPU.Build.0 = Release|Any CPU + {160EE4A5-D14D-4147-BE99-536F03A68CCB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {160EE4A5-D14D-4147-BE99-536F03A68CCB}.Debug|Any CPU.Build.0 = Debug|Any CPU + {160EE4A5-D14D-4147-BE99-536F03A68CCB}.Release|Any CPU.ActiveCfg = Release|Any CPU + {160EE4A5-D14D-4147-BE99-536F03A68CCB}.Release|Any CPU.Build.0 = Release|Any CPU + {40F8848F-605E-4CAA-9512-B2812476CC9A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {40F8848F-605E-4CAA-9512-B2812476CC9A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {40F8848F-605E-4CAA-9512-B2812476CC9A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {40F8848F-605E-4CAA-9512-B2812476CC9A}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection +EndGlobal diff --git a/SimSharp/App.config b/SimSharp/App.config new file mode 100644 index 0000000..74ade9d --- /dev/null +++ b/SimSharp/App.config @@ -0,0 +1,6 @@ + + + + + + diff --git a/SimSharp/Core/ActiveObject.cs b/SimSharp/Core/ActiveObject.cs new file mode 100644 index 0000000..f2884e5 --- /dev/null +++ b/SimSharp/Core/ActiveObject.cs @@ -0,0 +1,27 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +namespace SimSharp { + public abstract class ActiveObject where T : Environment { + protected T Environment { get; private set; } + + protected ActiveObject(T environment) { + Environment = environment; + } + } +} diff --git a/SimSharp/Core/Environment.cs b/SimSharp/Core/Environment.cs new file mode 100644 index 0000000..dcbb6ef --- /dev/null +++ b/SimSharp/Core/Environment.cs @@ -0,0 +1,120 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace SimSharp { + public class Environment { + public DateTime Now { get; set; } + public Random Random { get; protected set; } + + private SortedList, Queue>> queue; + public Process ActiveProcess { get; set; } + + public int ProcessedEvents { get; protected set; } + + public Environment() : this(new DateTime(1970, 1, 1)) { } + public Environment(DateTime initialDateTime) { + Now = initialDateTime; + Random = new Random(); + queue = new SortedList, Queue>>(); + } + public Environment(DateTime initialDateTime, int randomSeed) { + Now = initialDateTime; + Random = new Random(randomSeed); + queue = new SortedList, Queue>>(); + } + + public Process Process(IEnumerable generator) { + return new Process(this, generator); + } + + public Timeout Timeout(TimeSpan delay) { + return new Timeout(this, delay); + } + + public virtual void Reset(DateTime initialTime, int randomSeed) { + Now = initialTime; + Random = new Random(randomSeed); + queue = new SortedList, Queue>>(); + } + + public virtual void Schedule(Event @event, bool urgent = false) { + Schedule(TimeSpan.FromSeconds(0), @event, urgent); + } + + public virtual void Schedule(TimeSpan delay, Event @event, bool urgent = false) { + var eventTime = Now + delay; + if (queue.ContainsKey(eventTime)) { + if (urgent) queue[eventTime].Item1.Enqueue(@event); + else queue[eventTime].Item2.Enqueue(@event); + } else { + if (urgent) queue.Add(eventTime, Tuple.Create(new Queue(new[] { @event }), new Queue())); + else queue.Add(eventTime, Tuple.Create(new Queue(), new Queue(new[] { @event }))); + } + } + + public virtual object Run(TimeSpan span) { + return Run(Now + span); + } + + public virtual object Run(DateTime? until = null) { + var limit = until ?? DateTime.MaxValue; + if (limit <= Now) throw new InvalidOperationException("Simulation end date must lie in the future."); + var stopEvent = new Event(this); + if (limit < DateTime.MaxValue) + Schedule(limit - Now, stopEvent, urgent: true); + return Run(stopEvent); + } + + public virtual object Run(Event stopEvent) { + stopEvent.CallbackList.Add(StopSimulation); + try { + while (queue.Count > 0) { + Step(); + ProcessedEvents++; + } + } catch (EmptyScheduleException) { } + if (!stopEvent.IsTriggered) return null; + if (!stopEvent.IsOk) throw stopEvent.Exception; + return stopEvent.Value; + } + + protected virtual void Step() { + var nextEvents = queue.First(); + Now = nextEvents.Key; + var @event = nextEvents.Value.Item1.Count > 0 ? nextEvents.Value.Item1.Dequeue() : nextEvents.Value.Item2.Dequeue(); + if (nextEvents.Value.Item1.Count == 0 && nextEvents.Value.Item2.Count == 0) + queue.Remove(Now); + foreach (var callback in @event.Callbacks) + callback(@event); + @event.CallbackList = null; + if (!@event.IsOk && @event.Exception != null) throw @event.Exception; + } + + protected virtual void StopSimulation(Event @event) { + throw new EmptyScheduleException(); + } + + public void Log(string message) { + Console.Out.WriteLine(message); + } + } +} diff --git a/SimSharp/Core/Events/Event.cs b/SimSharp/Core/Events/Event.cs new file mode 100644 index 0000000..f1513aa --- /dev/null +++ b/SimSharp/Core/Events/Event.cs @@ -0,0 +1,77 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; +using System.Collections.Generic; + +namespace SimSharp { + public class Event { + public static readonly object PENDING = new object(); + + protected Environment Environment { get; private set; } + protected internal List> CallbackList { get; set; } + public IEnumerable> Callbacks { get { return CallbackList.AsReadOnly(); } } + + private object value; + public object Value { + get { + if (value == PENDING) throw new InvalidOperationException("Value of event is not yet available."); + return value; + } + protected set { this.value = value; } + } + + public Exception Exception { get; protected set; } + + public bool IsOk { get; protected set; } + public bool IsProcessed { get { return CallbackList == null; } } + public bool IsTriggered { get { return value != PENDING; } } + + public Event(Environment environment) : this(environment, PENDING) { } + public Event(Environment environment, object value) { + Environment = environment; + CallbackList = new List>(); + this.value = value; + } + + public virtual void Trigger(Event @event) { + IsOk = @event.IsOk; + value = @event.value; + Exception = @event.Exception; + Environment.Schedule(this); + } + + public virtual Event Succeed(object value = null) { + if (this.value != PENDING) + throw new InvalidOperationException("Event has already been triggered"); + IsOk = true; + this.value = value; + Environment.Schedule(this); + return this; + } + + public virtual Event Fail(Exception ex) { + if (value != PENDING) + throw new InvalidOperationException("Event has already been triggered"); + IsOk = false; + this.value = null; + Exception = ex; + Environment.Schedule(this); + return this; + } + } +} diff --git a/SimSharp/Core/Events/Process.cs b/SimSharp/Core/Events/Process.cs new file mode 100644 index 0000000..6dcb846 --- /dev/null +++ b/SimSharp/Core/Events/Process.cs @@ -0,0 +1,100 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; +using System.Collections.Generic; + +namespace SimSharp { + public class Process : Event { + private readonly IEnumerator generator; + private Event target; + public bool IsFaulted { get; protected set; } + public object Fault { get; protected set; } + + public Process(Environment environment, IEnumerable generator) + : base(environment) { + this.generator = generator.GetEnumerator(); + target = new Initialize(environment, this); + } + + public virtual void Interrupt(object cause = null) { + if (IsTriggered) throw new InvalidOperationException("The process has terminated and cannot be interrupted."); + if (Environment.ActiveProcess == this) throw new InvalidOperationException("A process is not allowed to interrupt itself."); + + var interruptEvent = new Event(Environment, cause); + interruptEvent.CallbackList.Add(Resume); + Environment.Schedule(interruptEvent, urgent: true); + } + + protected virtual void Resume(Event @event) { + if (IsTriggered) return; + if (@event != target) target.CallbackList.Remove(Resume); + Environment.ActiveProcess = this; + if (@event.IsOk) { + if (generator.MoveNext()) ProceedToEvent(); + else FinishProcess(); + } else { + // Fault handling differs from SimPy as in .NET it is not possible to inject an + // exception into an enumerator. It is even impossible to put a yield return inside + // a try-catch block, so here the Process will set IsFaulted and will then move to + // the next yield in the generator. However, if after this move IsFaulted is still + // true we know that the error was not handled. It is assumed the error is handled + // if HandleFault() is called on the environment's ActiveProcess which will reset + // the flag. + IsFaulted = true; + Fault = @event.Value; + if (generator.MoveNext()) { + // if we move next, but IsFaulted is still true + if (IsFaulted) throw new InvalidOperationException("The process continued despite being faulted."); + // otherwise HandleFault was called and the fault was handled + ProceedToEvent(); + } else if (IsFaulted) throw new InvalidOperationException("The process cannot finish when it is faulted."); + else FinishProcess(); + } + Environment.ActiveProcess = null; + } + + protected void ProceedToEvent() { + target = generator.Current; + if (target.CallbackList != null) + target.CallbackList.Add(Resume); + else throw new InvalidOperationException("Resuming on an event that was already triggered."); + } + + protected void FinishProcess() { + IsOk = true; + Value = null; + Environment.Schedule(this); + } + + public virtual bool HandleFault() { + if (!IsFaulted) return false; + IsFaulted = false; + return true; + } + + private class Initialize : Event { + public Initialize(Environment environment, Process process) + : base(environment) { + CallbackList.Add(process.Resume); + Value = null; + IsOk = true; + environment.Schedule(this); + } + } + } +} diff --git a/SimSharp/Core/Events/Release.cs b/SimSharp/Core/Events/Release.cs new file mode 100644 index 0000000..f6fbe7f --- /dev/null +++ b/SimSharp/Core/Events/Release.cs @@ -0,0 +1,30 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; + +namespace SimSharp { + public sealed class Release : Event { + public Request Request { get; private set; } + + public Release(Environment environment, Request request, Action callback) + : base(environment) { + Request = request; + CallbackList.Add(callback); + } + } +} diff --git a/SimSharp/Core/Events/Request.cs b/SimSharp/Core/Events/Request.cs new file mode 100644 index 0000000..30c2d2b --- /dev/null +++ b/SimSharp/Core/Events/Request.cs @@ -0,0 +1,42 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; + +namespace SimSharp { + public sealed class Request : Event, IDisposable { + private readonly Action disposeCallback; + public int Priority { get; private set; } + public bool Preempt { get; private set; } + public DateTime Time { get; private set; } + public Process Process { get; private set; } + + public Request(Environment environment, Action callback, Action disposeCallback, int priority = 1, bool preempt = false) + : base(environment) { + CallbackList.Add(callback); + this.disposeCallback = disposeCallback; + Priority = priority; + Preempt = preempt; + Time = environment.Now; + Process = environment.ActiveProcess; + } + + public void Dispose() { + if (disposeCallback != null) disposeCallback(this); + } + } +} diff --git a/SimSharp/Core/Events/Timeout.cs b/SimSharp/Core/Events/Timeout.cs new file mode 100644 index 0000000..9451287 --- /dev/null +++ b/SimSharp/Core/Events/Timeout.cs @@ -0,0 +1,29 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; + +namespace SimSharp { + public class Timeout : Event { + public Timeout(Environment environment, TimeSpan delay) + : base(environment) { + Value = null; + IsOk = true; + environment.Schedule(delay, this); + } + } +} diff --git a/SimSharp/Core/Exceptions/EmptyScheduleException.cs b/SimSharp/Core/Exceptions/EmptyScheduleException.cs new file mode 100644 index 0000000..61b3b00 --- /dev/null +++ b/SimSharp/Core/Exceptions/EmptyScheduleException.cs @@ -0,0 +1,33 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion +using System; +using System.Runtime.Serialization; + +namespace SimSharp { + [Serializable] + public class EmptyScheduleException : Exception { + public EmptyScheduleException() { } + public EmptyScheduleException(string message) : base(message) { } + public EmptyScheduleException(string message, Exception inner) : base(message, inner) { } + + protected EmptyScheduleException( + SerializationInfo info, + StreamingContext context) + : base(info, context) { } + } +} diff --git a/SimSharp/Core/Preempted.cs b/SimSharp/Core/Preempted.cs new file mode 100644 index 0000000..e20486a --- /dev/null +++ b/SimSharp/Core/Preempted.cs @@ -0,0 +1,31 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; + +namespace SimSharp { + public sealed class Preempted { + public Process By { get; private set; } + public DateTime UsageSince { get; private set; } + + public Preempted(Process by, DateTime usageSince) { + By = by; + UsageSince = usageSince; + } + } +} diff --git a/SimSharp/Core/PreemptiveResource.cs b/SimSharp/Core/PreemptiveResource.cs new file mode 100644 index 0000000..f5ec290 --- /dev/null +++ b/SimSharp/Core/PreemptiveResource.cs @@ -0,0 +1,37 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Linq; + +namespace SimSharp { + public class PreemptiveResource : PriorityResource { + public PreemptiveResource(Environment environment, int capacity = 1) : base(environment, capacity) { } + + protected override void Request(Request request) { + if (Users.Count >= MaxCapacity && request.Preempt) { + // Check if we can preempt another process + var oldest = Users.OrderByDescending(x => x.Priority).ThenByDescending(x => x.Time).First(); + if (oldest.Priority > request.Priority || (oldest.Priority == request.Priority && oldest.Time > request.Time)) { + Users.Remove(oldest); + oldest.Process.Interrupt(new Preempted(request.Process, oldest.Time)); + } + } + base.Request(request); + } + } +} diff --git a/SimSharp/Core/PriorityResource.cs b/SimSharp/Core/PriorityResource.cs new file mode 100644 index 0000000..b2df93c --- /dev/null +++ b/SimSharp/Core/PriorityResource.cs @@ -0,0 +1,59 @@ + +using System.Collections.Generic; +using System.Linq; +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +namespace SimSharp { + public class PriorityResource : Resource { + + protected SortedList> RequestQueue { get; private set; } + protected List ReleaseQueue { get; private set; } + + public PriorityResource(Environment environment, int capacity = 1) + : base(environment, capacity) { + RequestQueue = new SortedList>(); + ReleaseQueue = new List(); + } + + protected override IEnumerable Requests { + get { return RequestQueue.SelectMany(x => x.Value); } + } + + protected override IEnumerable Releases { + get { return ReleaseQueue; } + } + + protected override void AddRequest(Request request) { + if (RequestQueue.ContainsKey(request.Priority)) RequestQueue[request.Priority].Add(request); + else RequestQueue.Add(request.Priority, new List() { request }); + } + + protected override void RemoveRequest(Request request) { + RequestQueue[request.Priority].Remove(request); + } + + protected override void AddRelease(Release release) { + ReleaseQueue.Add(release); + } + + protected override void RemoveRelease(Release release) { + ReleaseQueue.Remove(release); + } + } +} diff --git a/SimSharp/Core/Resource.cs b/SimSharp/Core/Resource.cs new file mode 100644 index 0000000..fe6678c --- /dev/null +++ b/SimSharp/Core/Resource.cs @@ -0,0 +1,57 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Collections.Generic; + +namespace SimSharp { + public class Resource : ResourceBase { + + protected List RequestQueue { get; private set; } + protected List ReleaseQueue { get; private set; } + + public Resource(Environment environment, int capacity = 1) + : base(environment, capacity) { + RequestQueue = new List(); + ReleaseQueue = new List(); + } + + protected override IEnumerable Requests { + get { return RequestQueue; } + } + + protected override IEnumerable Releases { + get { return ReleaseQueue; } + } + + protected override void AddRequest(Request request) { + RequestQueue.Add(request); + } + + protected override void RemoveRequest(Request request) { + RequestQueue.Remove(request); + } + + protected override void AddRelease(Release release) { + ReleaseQueue.Add(release); + } + + protected override void RemoveRelease(Release release) { + ReleaseQueue.Remove(release); + } + } +} diff --git a/SimSharp/Core/ResourceBase.cs b/SimSharp/Core/ResourceBase.cs new file mode 100644 index 0000000..104d3c2 --- /dev/null +++ b/SimSharp/Core/ResourceBase.cs @@ -0,0 +1,91 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Collections.Generic; + +namespace SimSharp { + public abstract class ResourceBase { + + protected readonly int MaxCapacity; + protected Environment Environment { get; private set; } + protected List Users { get; private set; } + + protected ResourceBase(Environment environment, int capacity = 1) { + MaxCapacity = capacity; + Environment = environment; + Users = new List(); + } + + public virtual Request Request(int priority = 1, bool preempt = false) { + var request = new Request(Environment, TriggerRelease, ReleaseCallback, priority, preempt); + AddRequest(request); + Request(request); + return request; + } + + public virtual Release Release(Request request) { + var release = new Release(Environment, request, TriggerRequest); + AddRelease(release); + Release(release); + return release; + } + + protected void ReleaseCallback(Event @event) { + var request = @event as Request; + if (request != null) Release(request); + } + + protected virtual void Request(Request request) { + if (Users.Count < MaxCapacity) { + Users.Add(request); + request.Succeed(); + } + } + + protected virtual void Release(Release release) { + if (!release.Request.IsTriggered) RemoveRequest(release.Request); + Users.Remove(release.Request); + release.Succeed(); + if (!release.IsTriggered) RemoveRelease(release); + } + + protected virtual void TriggerRequest(Event @event) { + RemoveRelease((Release)@event); + foreach (var requestEvent in Requests) { + if (!requestEvent.IsTriggered) Request(requestEvent); + if (!requestEvent.IsTriggered) break; + } + } + + protected virtual void TriggerRelease(Event @event) { + RemoveRequest((Request)@event); + foreach (var releaseEvent in Releases) { + if (!releaseEvent.IsTriggered) Release(releaseEvent); + if (!releaseEvent.IsTriggered) break; + } + } + + protected abstract IEnumerable Requests { get; } + protected abstract IEnumerable Releases { get; } + + protected abstract void AddRequest(Request request); + protected abstract void RemoveRequest(Request request); + protected abstract void AddRelease(Release release); + protected abstract void RemoveRelease(Release release); + } +} diff --git a/SimSharp/Properties/AssemblyInfo.cs b/SimSharp/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..2729b3f --- /dev/null +++ b/SimSharp/Properties/AssemblyInfo.cs @@ -0,0 +1,53 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System.Reflection; +using System.Runtime.InteropServices; + +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +[assembly: AssemblyTitle("SimSharp")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("HEAL")] +[assembly: AssemblyProduct("SimSharp")] +[assembly: AssemblyCopyright("Copyright © HEAL 2014")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// Setting ComVisible to false makes the types in this assembly not visible +// to COM components. If you need to access a type in this assembly from +// COM, set the ComVisible attribute to true on that type. +[assembly: ComVisible(false)] + +// The following GUID is for the ID of the typelib if this project is exposed to COM +[assembly: Guid("d51e9cc2-c26b-4df5-94f8-ca8f63f75db9")] + +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Build and Revision Numbers +// by using the '*' as shown below: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/SimSharp/Random/RandomDist.cs b/SimSharp/Random/RandomDist.cs new file mode 100644 index 0000000..ceeda9c --- /dev/null +++ b/SimSharp/Random/RandomDist.cs @@ -0,0 +1,70 @@ +#region License Information +/* SimSharp - A .NET port of SimPy, discrete event simulation framework +Copyright (C) 2014 Heuristic and Evolutionary Algorithms Laboratory (HEAL) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see .*/ +#endregion + +using System; + +namespace SimSharp { + public static class RandomDist { + private static readonly double NormalMagicConst = 4 * Math.Exp(-0.5) / Math.Sqrt(2.0); + + public static double Uniform(Random urand, double a, double b) { + return a + (b - a) * urand.NextDouble(); + } + + public static double Triangular(Random random, double low, double high) { + var u = random.NextDouble(); + if (u > 0.5) + return high + (low - high) * Math.Sqrt(((1.0 - u) / 2)); + return low + (high - low) * Math.Sqrt(u / 2); + } + public static double Triangular(Random random, double low, double high, double mode) { + var u = random.NextDouble(); + var c = (mode - low) / (high - low); + if (u > c) + return high + (low - high) * Math.Sqrt(((1.0 - u) * (1.0 - c))); + return low + (high - low) * Math.Sqrt(u * c); + } + + public static double Exponential(Random urand, double lambda) { + return -Math.Log(1 - urand.NextDouble()) / lambda; + } + + public static double Normal(Random urand, double mu, double sigma) { + double z, zz, u1, u2; + do { + u1 = urand.NextDouble(); + u2 = 1 - urand.NextDouble(); + z = NormalMagicConst * (u1 - 0.5) / u2; + zz = z * z / 4.0; + } while (zz > -Math.Log(u2)); + return mu + z * sigma; + } + + public static double LogNormal(Random urand, double mu, double sigma) { + return Math.Exp(Normal(urand, mu, sigma)); + } + + public static double Cauchy(Random urand, double x0, double gamma) { + return x0 + gamma * Math.Tan(Math.PI * (urand.NextDouble() - 0.5)); + } + + public static double Weibull(Random urand, double alpha, double beta) { + return alpha * Math.Pow(-Math.Log(1 - urand.NextDouble()), 1 / beta); + } + } +} diff --git a/SimSharp/SimSharp.csproj b/SimSharp/SimSharp.csproj new file mode 100644 index 0000000..4ea9f00 --- /dev/null +++ b/SimSharp/SimSharp.csproj @@ -0,0 +1,83 @@ + + + + + Debug + AnyCPU + {9FE9C740-7859-4D01-AD07-7D4E15A6320B} + Library + Properties + SimSharp + SimSharp + v4.0 + 512 + + + + AnyCPU + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + true + + + SimSharp.snk + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/SimSharp/SimSharp.csproj.DotSettings b/SimSharp/SimSharp.csproj.DotSettings new file mode 100644 index 0000000..e3e89b8 --- /dev/null +++ b/SimSharp/SimSharp.csproj.DotSettings @@ -0,0 +1,5 @@ + + True + True + True + True \ No newline at end of file diff --git a/SimSharp/SimSharp.snk b/SimSharp/SimSharp.snk new file mode 100644 index 0000000..c305837 Binary files /dev/null and b/SimSharp/SimSharp.snk differ diff --git a/TODO.txt b/TODO.txt new file mode 100644 index 0000000..88effa1 --- /dev/null +++ b/TODO.txt @@ -0,0 +1,9 @@ +notify simpy: + Process._resume: + "if self._value is not PENDING:" should be "if self.triggered:" + +To port: + * Condition + * Container (Resource) + * Store (Resource) + * Unit Tests \ No newline at end of file