gdlc 3.0.0.0 → 3.1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 583f4e7997192e155acd950c48ee1d09d608aa8f
-  data.tar.gz: 9f5a38af7959c8db2fb03aad4b31af90c4fd56d2
+  metadata.gz: 97d5d01f1a71769e3ea3f69c37488d30cff32f91
+  data.tar.gz: 6eb7d4b9218d5a37c3c2ac1221c3aaa3024f8fbe
 SHA512:
-  metadata.gz: 0b9f116e45993071a4ef3983f32d9c2ee39fdadd1be5a1c903c1083a11a37df06c644e38020faa2c4c981efbe53c93a11ee5f79a961c94b13ff95da124a78bbc
-  data.tar.gz: e14439eb69dad310a9bb89d971b31da34fd7ceece8d0cf159dabda529d9878d707132a38436040b50b2be7afae85be9eb6a1f841b64a2ca5ef3a761321203ae4
+  metadata.gz: 8a196700104e6331f558b6c02bc58cb353d89e85d3628ed62d5dd8739380ecf7301abc493db0a049bea51975be6590310e420f2d9bcf734ce6b490f18bef0d2b
+  data.tar.gz: 334653caf03943ef349e1f00f94c2bfb6dff226d4f07a5442eacdc40a9a674ea2389bb51bd024e987d52b4c70a8c4baf7c934a8256a8fba67d313159edf8e733

data/docs/GDLC_manual.html

@@ -202,6 +202,7 @@
 <li><span class="h3toc"><a href="#Lookup.Files">Lookup Files</a></span></li>
 <li><span class="h3toc"><a href="#PowerLookup.Files">PowerLookup Files</a></span></li>
 <li><span class="h2toc"><a href="#XML.Functions">XML Functions</a></span></li>
+<li><span class="h3toc"><a href="#Argument.Flow.Type.Indicators">Argument Flow Type Indicators</a></span></li>
 <li><span class="h3toc"><a href="#Definitions.7">Definitions</a></span></li>
 <li><span class="h3toc"><a href="#References.6">References</a></span></li>
 <li><span class="h2toc"><a href="#Miscellaneous">Miscellaneous</a></span></li>
@@ -1220,7 +1221,7 @@ end // guideline MyGuideline
 <a name="XML.Functions"></a>
 <h2>XML Functions</h2>
 
-<pre><code>xmlfunc identifier( [IN|OUT] dpmVariable, [IN|OUT] "constant", [IN|OUT] 15.5 );
+<pre><code>xmlfunc identifier( [FLOW_TYPE] dpmVariable, [FLOW_TYPE] "constant", [FLOW_TYPE] 15.5 );
 </code></pre>
 
 <p>XML Functions are defined and provided by the engine. The compiler does not
@@ -1229,7 +1230,19 @@ the function exists before using it in your guideline.</p>
 
 <p>To use an XML function, it must first be defined. The compiler does check the
 argument count against the function definition when it is referenced within a
-rule. Errors will be thrown if the argument count doesn't match.</p>
+rule. Errors will be thrown if the <em>required</em> argument count doesn't match.</p>
+
+<a name="Argument.Flow.Type.Indicators"></a>
+<h3>Argument Flow Type Indicators</h3>
+
+<p>Available flow types:</p>
+
+<pre><code>IN
+OUT
+OPT
+INOPT
+OUTOPT
+</code></pre>
 
 <p>In both definitions and references, the <code>IN</code> and <code>OUT</code> keywords can be used in
 front of each argument. These keywords are optional. They affect nothing and
@@ -1237,6 +1250,12 @@ are only used as an indicator for the user as to whether the variable is used
 for INput to the function or OUTput from the function. <code>IN</code> and <code>OUT</code> can be
 used in either definitions, or references, or both.</p>
 
+<p><code>OPT</code>, <code>INOPT</code>, and <code>OUTOPT</code> are <em>optional</em> indicators. They indicate that the
+argument is <strong>optional</strong> (ie. not required). <em>The compiler will not flag
+a function reference (throw an error) that doesn't include optional arguments.</em>
+<code>INOPT</code> and <code>OUTOPT</code> are used to indicate OPTional INput and OPTional OUTput
+arguments.</p>
+
 <p>DPM variables, PPM variables, numbers and constants (values surrounded with
 quotes) can be used as arguments. Inline expressions are not allowed as
 arguments to the function. Assigning values to variables before using them

data/docs/GDLC_manual.md

@@ -849,7 +849,7 @@ its use would be as follows:
 - - -
 ## XML Functions
 
-    xmlfunc identifier( [IN|OUT] dpmVariable, [IN|OUT] "constant", [IN|OUT] 15.5 );
+    xmlfunc identifier( [FLOW_TYPE] dpmVariable, [FLOW_TYPE] "constant", [FLOW_TYPE] 15.5 );
 
 XML Functions are defined and provided by the engine. The compiler does not
 know whether or not a function is available. It is up to the user to verify
@@ -857,7 +857,17 @@ the function exists before using it in your guideline.
 
 To use an XML function, it must first be defined. The compiler does check the
 argument count against the function definition when it is referenced within a
-rule. Errors will be thrown if the argument count doesn't match.
+rule. Errors will be thrown if the _required_ argument count doesn't match.
+
+### Argument Flow Type Indicators
+
+Available flow types:
+
+    IN
+    OUT
+    OPT
+    INOPT
+    OUTOPT
 
 In both definitions and references, the `IN` and `OUT` keywords can be used in
 front of each argument. These keywords are optional. They affect nothing and
@@ -865,6 +875,13 @@ are only used as an indicator for the user as to whether the variable is used
 for INput to the function or OUTput from the function. `IN` and `OUT` can be
 used in either definitions, or references, or both.
 
+`OPT`, `INOPT`, and `OUTOPT` are _optional_ indicators. They indicate that the
+argument is **optional** (ie. not required). _The compiler will not flag
+a function reference (throw an error) that doesn't include optional arguments._
+`INOPT` and `OUTOPT` are used to indicate OPTional INput and OPTional OUTput
+arguments.
+
+
 DPM variables, PPM variables, numbers and constants (values surrounded with
 quotes) can be used as arguments. Inline expressions are not allowed as
 arguments to the function. Assigning values to variables before using them

data/lib/gdlc/version.rb

@@ -1,5 +1,5 @@
 ##############################################################################
-#    Copyright (C) 2015  Jeff McAffee
+#    Copyright (C) 2016  Jeff McAffee
 #
 #    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
@@ -16,7 +16,7 @@
 #
 
 module Gdlc
-  VERSION = "3.0.0.0" unless constants.include?("VERSION")
+  VERSION = "3.1.0.0" unless constants.include?("VERSION")
   APPNAME = "GDLC" unless constants.include?("APPNAME")
   COPYRIGHT = "Copyright (c) 2016 Jeff McAffee. All rights reserved" unless constants.include?("COPYRIGHT")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gdlc
 version: !ruby/object:Gem::Version
-  version: 3.0.0.0
+  version: 3.1.0.0
 platform: ruby
 authors:
 - Jeff McAffee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec