Changeset 27 for java


Ignore:
Timestamp:
07/01/09 16:39:09 (15 years ago)
Author:
sz
Message:

the most recent framscript XML

File:
1 edited

Legend:

Unmodified
Added
Removed
  • java/FramclipsePlugin/src/main/resources/framscript.xml

    r13 r27  
    151151                <element name="numparts" type="integer"/>
    152152                <element name="orient" type="Orient">
    153                         <description><![CDATA[by convention the creature orientation is equal to its first part orientation]]></description>
     153                        <description><![CDATA[By convention, the orientation of the creature is equal to the orientation of its first Part]]></description>
    154154                </element>
    155155                <element name="othermask" type="integer" min="0" max="2147483647" default="0"/>
     
    175175                <element name="signals" type="CreatureSignals"/>
    176176                <element name="size_x" type="float">
    177                         <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
     177                        <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default Part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
    178178See also: Creature.moveAbs]]></description>
    179179                </element>
     
    242242
    243243origin (pos_x,pos_y,pos_z) = (-1,-1,-1)
    244 size (size_x,size_y,size_z) = (2,1,1)
     244size (size_x,size_y,size_z) = (3,2,2)
    245245
    246246The following example places the bottom of a creature at a given location (x,y,z):
     
    269269                </element>
    270270                <element name="rotateLocal" function="true" type="void">
    271                         <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise the further simulation could be disturbed.]]></description>
     271                        <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise further simulation can be disturbed.]]></description>
    272272                        <arguments>
    273273                                <argument name="x" type="float"/>
     
    582582                </element>
    583583                <element name="readUntilEOF" function="true" type="string"><arguments/></element>
     584                <element name="system" function="true" type="integer">
     585                        <description><![CDATA[Invokes a system command, returns its return code (0 usually means it was completed successfully)
     586
     587Example:
     588File.system("wget",["-O","/tmp/filename","http://example.com/file"]);]]></description>
     589                        <arguments>
     590                                <argument name="executable" type="string"/>
     591                                <argument name="string arguments" type="Vector"/>
     592                        </arguments>
     593                </element>
    584594                <element name="writeComment" function="true" type="void">
    585595                        <arguments>
     
    651661                <element name="name" type="string"/>
    652662                <element name="size" type="integer">
    653                         <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.popsiz field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
     663                        <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.instances field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
    654664                </element>
    655665                <element name="totalpop" type="integer">
    656                         <description><![CDATA[Takes into account the Genotype.popsiz field (which may give the total number of instances depending on the experiment definition)]]></description>
     666                        <description><![CDATA[Takes into account the Genotype.instances field (which may give the total number of instances depending on the experiment definition)]]></description>
    657667                </element>
    658668                <element name="addGeno" function="true" type="Genotype">
     
    716726                </element>
    717727                <element name="addPerformanceFromCreature" function="true" type="void">
    718                         <description><![CDATA[Updates the current Genotype's performance values merging them with the current Creture's performance. It assumes the Genotype.popsiz has a reasonable value and performs the proper weighting. Use your own function instead if these conditions are not met in your experiment.]]></description>
     728                        <description><![CDATA[Updates the current Genotype's performance values merging them with the current Creture's performance. It assumes the Genotype.instances has a reasonable value and performs the proper weighting. Use your own function instead if these conditions are not met in your experiment.]]></description>
    719729<arguments/></element>
    720730                <element name="clear" function="true" type="void">
     
    745755                </element>
    746756                <element name="deleteOne" function="true" type="void">
    747                         <description><![CDATA[delete one individual from the gene pool = decrease popsiz and delete the genotype if the popsiz goes to 0]]></description>
     757                        <description><![CDATA[delete one individual from the gene pool = decrease 'instances' and delete the genotype if the 'instances' goes to 0]]></description>
    748758                        <arguments>
    749759                                <argument name="genotype index" type="integer"/>
     
    11401150                </element>
    11411151                <element name="neuadd_Fuzzy" type="integer" min="0" max="1">
    1142                         <description><![CDATA[Refer to publications to learn about this neuron
     1152                        <description><![CDATA[Refer to publications to learn more about this neuron.
    11431153
    11441154Characteristics:
     
    11551165                </element>
    11561166                <element name="neuadd_VEye" type="integer" min="0" max="1">
    1157                         <description><![CDATA[Characteristics:
     1167                        <description><![CDATA[Refer to publications to learn more about this neuron.
     1168
     1169Characteristics:
    11581170   uses single input
    11591171   provides output value
     
    11731185                </element>
    11741186                <element name="neuadd_VMotor" type="integer" min="0" max="1">
    1175                         <description><![CDATA[Must be connected to the VEye and properly set up.
     1187                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
    11761188
    11771189Characteristics:
     
    14111423                <element name="fit" type="float"/>
    14121424                <element name="fit2" type="float">
    1413                         <description><![CDATA[Fitnes shifted by (avg-n*stddev)]]></description>
     1425                        <description><![CDATA[Fitness shifted by (avg-n*stddev)]]></description>
    14141426                </element>
    14151427                <element name="geno" type="Geno">
     
    14211433                        <description><![CDATA[Additional information or comments]]></description>
    14221434                </element>
    1423                 <element name="instances" type="integer"/>
     1435                <element name="instances" type="integer">
     1436                        <description><![CDATA[Copies of this genotype]]></description>
     1437                </element>
    14241438                <element name="isValid" type="integer" min="0" max="1"/>
    14251439                <element name="lifespan" type="float">
     
    14271441                </element>
    14281442                <element name="name" type="string"/>
    1429                 <element name="nncon" type="float">
    1430                         <description><![CDATA[(deprecated) old name for numconnections]]></description>
    1431                 </element>
    1432                 <element name="nnsiz" type="float">
    1433                         <description><![CDATA[(deprecated) old name for numneurons]]></description>
    1434                 </element>
     1443                <element name="nncon" type="float"/>
     1444                <element name="nnsiz" type="float"/>
    14351445                <element name="num" type="integer"/>
    14361446                <element name="numconnections" type="float"/>
     
    14381448                <element name="numneurons" type="float"/>
    14391449                <element name="numparts" type="float"/>
    1440                 <element name="popsiz" type="integer">
    1441                         <description><![CDATA[(deprecated) old name for instances]]></description>
    1442                 </element>
     1450                <element name="popsiz" type="integer"/>
    14431451                <element name="simi" type="float"/>
    1444                 <element name="strjoints" type="float">
    1445                         <description><![CDATA[(deprecated) old name for numjoints]]></description>
    1446                 </element>
    1447                 <element name="strsiz" type="float">
    1448                         <description><![CDATA[(deprecated) old name for numparts]]></description>
    1449                 </element>
     1452                <element name="strjoints" type="float"/>
     1453                <element name="strsiz" type="float"/>
    14501454                <element name="uid" type="string">
    14511455                        <description><![CDATA[Unique identifier]]></description>
     
    14861490                <element name="name" type="string"/>
    14871491                <element name="size" type="integer">
    1488                         <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.popsiz field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
     1492                        <description><![CDATA[In standard.expdef, this is equivalent to the number of unique genotypes. Standard experiment definition uses the Genotype.instances field to indicate that some genotypes exist in multiple instances despite having only one item in the group. Other experiment definitions may create multiple copies of the same genotype.]]></description>
    14891493                </element>
    14901494                <element name="totalpop" type="integer">
    1491                         <description><![CDATA[Takes into account the Genotype.popsiz field (which may give the total number of instances depending on the experiment definition)]]></description>
     1495                        <description><![CDATA[Takes into account the Genotype.instances field (which may give the total number of instances depending on the experiment definition)]]></description>
    14921496                </element>
    14931497                <element name="addGeno" function="true" type="Genotype">
     
    24882492There are 2 kinds of data you can receive:
    248924931. aggregating functions (receive and receiveFilter) calculate the overall power of the received signal (based on the distance and the source power).
    2490 2.receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
     24942. receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
    24912495
    24922496Creating: Use "add" in Creature.signals, Neuro.signals, or World.signals.]]></description>
     
    28832887                </element>
    28842888                <element name="neuadd_Fuzzy" type="integer" min="0" max="1">
    2885                         <description><![CDATA[Refer to publications to learn about this neuron
     2889                        <description><![CDATA[Refer to publications to learn more about this neuron.
    28862890
    28872891Characteristics:
     
    28982902                </element>
    28992903                <element name="neuadd_VEye" type="integer" min="0" max="1">
    2900                         <description><![CDATA[Characteristics:
     2904                        <description><![CDATA[Refer to publications to learn more about this neuron.
     2905
     2906Characteristics:
    29012907   uses single input
    29022908   provides output value
     
    29162922                </element>
    29172923                <element name="neuadd_VMotor" type="integer" min="0" max="1">
    2918                         <description><![CDATA[Must be connected to the VEye and properly set up.
     2924                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
    29192925
    29202926Characteristics:
     
    31273133                </element>
    31283134                <element name="ncl_Fuzzy" type="integer" min="0" max="1">
    3129                         <description><![CDATA[Refer to publications to learn about this neuron
     3135                        <description><![CDATA[Refer to publications to learn more about this neuron.
    31303136
    31313137Characteristics:
     
    31423148                </element>
    31433149                <element name="ncl_VEye" type="integer" min="0" max="1">
    3144                         <description><![CDATA[Characteristics:
     3150                        <description><![CDATA[Refer to publications to learn more about this neuron.
     3151
     3152Characteristics:
    31453153   uses single input
    31463154   provides output value
     
    31603168                </element>
    31613169                <element name="ncl_VMotor" type="integer" min="0" max="1">
    3162                         <description><![CDATA[Must be connected to the VEye and properly set up.
     3170                        <description><![CDATA[Must be connected to the VEye and properly set up. Refer to publications to learn more about this neuron.
    31633171
    31643172Characteristics:
     
    44524460                <element name="fit" type="float"/>
    44534461                <element name="fit2" type="float">
    4454                         <description><![CDATA[Fitnes shifted by (avg-n*stddev)]]></description>
     4462                        <description><![CDATA[Fitness shifted by (avg-n*stddev)]]></description>
    44554463                </element>
    44564464                <element name="geno" type="Geno">
     
    44624470                        <description><![CDATA[Additional information or comments]]></description>
    44634471                </element>
    4464                 <element name="instances" type="integer"/>
     4472                <element name="instances" type="integer">
     4473                        <description><![CDATA[Copies of this genotype]]></description>
     4474                </element>
    44654475                <element name="isValid" type="integer" min="0" max="1"/>
    44664476                <element name="lifespan" type="float">
     
    44684478                </element>
    44694479                <element name="name" type="string"/>
    4470                 <element name="nncon" type="float">
    4471                         <description><![CDATA[(deprecated) old name for numconnections]]></description>
    4472                 </element>
    4473                 <element name="nnsiz" type="float">
    4474                         <description><![CDATA[(deprecated) old name for numneurons]]></description>
    4475                 </element>
     4480                <element name="nncon" type="float"/>
     4481                <element name="nnsiz" type="float"/>
    44764482                <element name="num" type="integer"/>
    44774483                <element name="numconnections" type="float"/>
     
    44794485                <element name="numneurons" type="float"/>
    44804486                <element name="numparts" type="float"/>
    4481                 <element name="popsiz" type="integer">
    4482                         <description><![CDATA[(deprecated) old name for instances]]></description>
    4483                 </element>
     4487                <element name="popsiz" type="integer"/>
    44844488                <element name="simi" type="float"/>
    4485                 <element name="strjoints" type="float">
    4486                         <description><![CDATA[(deprecated) old name for numjoints]]></description>
    4487                 </element>
    4488                 <element name="strsiz" type="float">
    4489                         <description><![CDATA[(deprecated) old name for numparts]]></description>
    4490                 </element>
     4489                <element name="strjoints" type="float"/>
     4490                <element name="strsiz" type="float"/>
    44914491                <element name="uid" type="string">
    44924492                        <description><![CDATA[Unique identifier]]></description>
     
    45664566                <element name="numparts" type="integer"/>
    45674567                <element name="orient" type="Orient">
    4568                         <description><![CDATA[by convention the creature orientation is equal to its first part orientation]]></description>
     4568                        <description><![CDATA[By convention, the orientation of the creature is equal to the orientation of its first Part]]></description>
    45694569                </element>
    45704570                <element name="othermask" type="integer" min="0" max="2147483647" default="0"/>
     
    45904590                <element name="signals" type="CreatureSignals"/>
    45914591                <element name="size_x" type="float">
    4592                         <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
     4592                        <description><![CDATA[(size_x,size_y,size_z) are dimensions of the axis-aligned bounding box of the creature, including the imaginary part sizes (Part.s, usually 1.0). A creature consisting of a single default Part has the size of (2.0,2.0,2.0) - twice the Part.s value (like a sphere diameter is twice its radius).
    45934593See also: Creature.moveAbs]]></description>
    45944594                </element>
     
    46574657
    46584658origin (pos_x,pos_y,pos_z) = (-1,-1,-1)
    4659 size (size_x,size_y,size_z) = (2,1,1)
     4659size (size_x,size_y,size_z) = (3,2,2)
    46604660
    46614661The following example places the bottom of a creature at a given location (x,y,z):
     
    46844684                </element>
    46854685                <element name="rotateLocal" function="true" type="void">
    4686                         <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise the further simulation could be disturbed.]]></description>
     4686                        <description><![CDATA[Rotate the creature around (local) X, Y and Z axes. Should only be used immediately after creating a new creature (before the first simulation step is performed for this creature), otherwise further simulation can be disturbed.]]></description>
    46874687                        <arguments>
    46884688                                <argument name="x" type="float"/>
     
    51435143There are 2 kinds of data you can receive:
    514451441. aggregating functions (receive and receiveFilter) calculate the overall power of the received signal (based on the distance and the source power).
    5145 2.receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
     51452. receiveSet and receiveSingle fetch the individual Signal object(s) so it is possible to transmit something else than just a single number (by using Signal.value) and do more sophisticated processing.
    51465146
    51475147Creating: Use "add" in Creature.signals, Neuro.signals, or World.signals.]]></description>
Note: See TracChangeset for help on using the changeset viewer.