Ignore:
Timestamp:
09/20/12 12:03:03 (12 years ago)
Author:
sherbold
Message:
  • code documentation and clean-up
File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/quest-plugin-mfc/src/main/java/de/ugoe/cs/quest/plugin/mfc/EventGenerationRule.java

    r655 r837  
     1 
    12package de.ugoe.cs.quest.plugin.mfc; 
    23 
    … …  
    1112/** 
    1213 * <p> 
    13  * TODO comment 
     14 * This class defines rules for the generation of MFC events. 
    1415 * </p> 
    1516 *  
    16  * @version $Revision: $ $Date: 22.08.2012$ 
    17  * @author 2012, last modified by $Author: patrick$ 
     17 * @version 1.0 
     18 * @author Steffen Herbold, Patrick Harms 
    1819 */ 
    1920class EventGenerationRule { 
    … …  
    2122    /** 
    2223     * <p> 
    23      * the namespace used for parsing the rule 
     24     * Namespace used for parsing the rule. 
    2425     * </p> 
    2526     */ 
    … …  
    2829    /** 
    2930     * <p> 
    30      * the name of the rule 
     31     * Name of the rule. 
    3132     * </p> 
    3233     */ 
    … …  
    3536    /** 
    3637     * <p> 
    37      * the list of conditions for the rule to be matched 
     38     * List of conditions for the rule to be matched. 
    3839     * </p> 
    3940     */ 
    … …  
    4243    /** 
    4344     * <p> 
    44      * the list of parameters to be provided to the generated event 
     45     * List of parameters to be provided to the generated event. 
    4546     * </p> 
    4647     */ 
    … …  
    4950    /** 
    5051     * <p> 
    51      * the list of replay message generation rules 
     52     * List of replay message generation rules. 
    5253     * </p> 
    5354     */ 
    … …  
    5657    /** 
    5758     * <p> 
    58      * TODO: comment 
    59      * </p> 
    60      * 
     59     * Constructor. Creates a new EventGenerationRule. 
     60     * </p> 
     61     *  
    6162     * @param ruleElement 
    62      * @param rulesNamespace  
     63     *            the JDOM element that descripes the rule 
     64     * @param rulesNamespace 
     65     *            the XML namespace the rule is defined in 
    6366     */ 
    6467    @SuppressWarnings("unchecked") 
    6568    EventGenerationRule(Element ruleElement, Namespace rulesNamespace) { 
    6669        this.namespace = rulesNamespace; 
    67          
     70 
    6871        this.name = ruleElement.getAttributeValue("name"); 
    69          
     72 
    7073        this.messageConditions = new ArrayList<MessageCondition>(); 
    7174        this.eventParameters = new ArrayList<Term>(); 
    7275        this.replayMessageSpecifications = new ArrayList<ReplayMessageSpec>(); 
    73          
     76 
    7477        for (Element child : (List<Element>) ruleElement.getChildren()) { 
    7578            if ("msg".equals(child.getName()) && namespace.equals(child.getNamespace())) { 
    … …  
    8487                replayMessageSpecifications.add(new ReplayMessageSpec(child)); 
    8588            } 
    86             else if ("genMsgSeq".equals(child.getName()) && namespace.equals(child.getNamespace())) { 
     89            else if ("genMsgSeq".equals(child.getName()) && namespace.equals(child.getNamespace())) 
     90            { 
    8791                replayMessageSpecifications.add(new ReplayMessageSpec(child)); 
    8892            } 
    8993            else { 
    90                 throw new IllegalArgumentException 
    91                     ("the provided rules can not be parsed: unknown element " + child.getName()); 
     94                throw new IllegalArgumentException( 
     95                                                   "the provided rules can not be parsed: unknown element " + 
     96                                                       child.getName()); 
    9297            } 
    9398        } 
    … …  
    95100 
    96101    /** 
     102     * <p> 
     103     * Returns the name of the rule. 
     104     * </p> 
     105     *  
    97106     * @return the name 
    98107     */ 
    … …  
    103112    /** 
    104113     * <p> 
    105      * TODO: comment 
    106      * </p> 
    107      * 
    108      * @return 
     114     * Returns the conditions on the matched messages defined by this rule. 
     115     * </p> 
     116     *  
     117     * @return the message conditions 
    109118     */ 
    110119    List<MessageCondition> getMessageConditions() { 
    … …  
    114123    /** 
    115124     * <p> 
    116      * TODO: comment 
    117      * </p> 
    118      * 
    119      * @return 
     125     * Returns the parameters of the event generated by this rule. 
     126     * </p> 
     127     *  
     128     * @return the event parameters 
    120129     */ 
    121130    List<Term> getEventParameters() { 
    … …  
    125134    /** 
    126135     * <p> 
    127      * TODO: comment 
    128      * </p> 
    129      * 
    130      * @return 
     136     * Returns the replay specification defined by this rule. 
     137     * </p> 
     138     *  
     139     * @return the replay specification 
    131140     */ 
    132141    List<ReplayMessageSpec> getReplayMessageSpecifications() { 
    … …  
    136145    /** 
    137146     * <p> 
    138      * TODO comment 
     147     * Helper class that describes conditions on the message sequence when matching this rule. 
    139148     * </p> 
    140149     *  
    141      * @version $Revision: $ $Date: 22.08.2012$ 
    142      * @author 2012, last modified by $Author: patrick$ 
     150     * @version 1.0 
     151     * @author Steffen Herbold, Patrick Harms 
    143152     */ 
    144153    class MessageCondition { 
    … …  
    146155        /** 
    147156         * <p> 
    148          * true, if the condition defines to match several conditions 
     157         * True, if the condition defines to match several conditions 
    149158         * </p> 
    150159         */ 
    151160        private boolean matchMultiple; 
    152          
    153         /** 
    154          * <p> 
    155          * the type of the message matched by the condition 
     161 
     162        /** 
     163         * <p> 
     164         * Type of the message matched by the condition 
    156165         * </p> 
    157166         */ 
    … …  
    160169        /** 
    161170         * <p> 
    162          * the term conditions associate with the rule condition 
     171         * Term conditions associated with the rule condition 
    163172         * </p> 
    164173         */ 
    … …  
    167176        /** 
    168177         * <p> 
    169          * the list of messages to be stored, if the message matches, for continuing the 
    170          * rule application 
     178         * List of messages to be stored, if the message matches, for continuing the rule 
     179         * application 
    171180         * </p> 
    172181         */ 
    … …  
    175184        /** 
    176185         * <p> 
    177          * TODO: comment 
    178          * </p> 
    179          * 
     186         * Constructor. Creates a new MessageCondition. 
     187         * </p> 
     188         *  
    180189         * @param msgChild 
     190         *            JDOM element that describes the message condition 
    181191         */ 
    182192        @SuppressWarnings("unchecked") 
    … …  
    185195            this.messageType = 
    186196                WindowsMessageType.parseMessageType(msgChild.getAttributeValue("type")); 
    187              
     197 
    188198            this.attributeConditions = new ArrayList<AttributeCondition>(); 
    189199            for (Element childElement : (List<Element>) msgChild.getChildren("equals", namespace)) { 
    190200                attributeConditions.add(new AttributeCondition(childElement)); 
    191201            } 
    192              
     202 
    193203            this.messagesToStore = new ArrayList<Term>(); 
    194204            for (Element childElement : (List<Element>) msgChild.getChildren("store", namespace)) { 
    195205                messagesToStore.add(new Term(childElement)); 
    196206            } 
    197             for (Element childElement : 
    198                  (List<Element>) msgChild.getChildren("storeSeq", namespace)) 
     207            for (Element childElement : (List<Element>) msgChild.getChildren("storeSeq", namespace)) 
    199208            { 
    200209                messagesToStore.add(new Term(childElement)); 
    … …  
    203212 
    204213        /** 
    205          * @return the matchMultiple 
     214         * <p> 
     215         * Returns whether a single message is matched to the condition or a whole sequence can be 
     216         * matched. 
     217         * </p> 
     218         *  
     219         * @return true if multiple message shall be matched, false if only a single message is 
     220         *         matched 
    206221         */ 
    207222        boolean matchMultiple() { 
    … …  
    211226        /** 
    212227         * <p> 
    213          * TODO: comment 
    214          * </p> 
    215          * 
    216          * @return 
     228         * Returns the type of the matched messages. 
     229         * </p> 
     230         *  
     231         * @return the message type 
    217232         */ 
    218233        WindowsMessageType getMessageType() { 
    … …  
    222237        /** 
    223238         * <p> 
    224          * TODO: comment 
    225          * </p> 
    226          * 
    227          * @return 
     239         * Returns the attribute conditions of the message condition. 
     240         * </p> 
     241         *  
     242         * @return the attribute conditions 
    228243         */ 
    229244        List<AttributeCondition> getAttributeConditions() { 
    … …  
    232247 
    233248        /** 
    234          * @return the valuesToStore 
     249         * <p> 
     250         * Returns messages, that have eventually been stored as part of the condition. 
     251         * </p> 
     252         *  
     253         * @return the stored messages 
    235254         */ 
    236255        ArrayList<Term> getMessagesToStore() { 
    … …  
    242261    /** 
    243262     * <p> 
    244      * TODO comment 
     263     * Helper class that defines attribute conditions for matching messages. 
    245264     * </p> 
    246265     *  
    247      * @version $Revision: $ $Date: 22.08.2012$ 
    248      * @author 2012, last modified by $Author: patrick$ 
     266     * @version 1.0 
     267     * @author Steffen Herbold, Patrick Harms 
    249268     */ 
    250269    class AttributeCondition { 
    … …  
    252271        /** 
    253272         * <p> 
    254          * the left hand side of the condition 
     273         * Left hand side of the condition. 
    255274         * </p> 
    256275         */ 
    257276        private Term leftHandSide; 
    258          
    259         /** 
    260          * <p> 
    261          * the left hand side of the condition 
     277 
     278        /** 
     279         * <p> 
     280         * Reft hand side of the condition. 
    262281         * </p> 
    263282         */ 
    … …  
    266285        /** 
    267286         * <p> 
    268          * TODO: comment 
    269          * </p> 
    270          * 
    271          * @param childElement 
     287         * Constructor. Creates a new AttributeCondition. 
     288         * </p> 
     289         *  
     290         * @param conditionElement 
     291         *            JDOM element that describes the condition 
    272292         */ 
    273293        private AttributeCondition(Element conditionElement) { 
    … …  
    275295            this.rightHandSide = new Term((Element) conditionElement.getChildren().get(1)); 
    276296        } 
    277          
    278         /** 
    279          * @return the leftHandSide 
     297 
     298        /** 
     299         * <p> 
     300         * Returns the left hand side of the condition. 
     301         * </p> 
     302         *  
     303         * @return the left hand side 
    280304         */ 
    281305        Term getLeftHandSide() { 
    … …  
    284308 
    285309        /** 
    286          * @return the rightHandSide 
     310         * <p> 
     311         * Returns the right hand side of the condition. 
     312         * </p> 
     313         *  
     314         * @return the right hand side 
    287315         */ 
    288316        Term getRightHandSide() { 
    … …  
    294322    /** 
    295323     * <p> 
    296      * TODO comment 
     324     * Helper class that defines terms to define conditions. 
    297325     * </p> 
    298326     *  
    299      * @version $Revision: $ $Date: 22.08.2012$ 
    300      * @author 2012, last modified by $Author: patrick$ 
     327     * @version 1.0 
     328     * @author Steffen Herbold, Patrick Harms 
    301329     */ 
    302330    class Term { 
    … …  
    304332        /** 
    305333         * <p> 
    306          * the name of the term 
     334         * Name of the term. 
    307335         * </p> 
    308336         */ 
    309337        private String name; 
    310          
    311         /** 
    312          * <p> 
    313          * the value of the term, if it is a constValue, null instead 
     338 
     339        /** 
     340         * <p> 
     341         * Value of the term, if it is a constValue; null otherwise. 
    314342         * </p> 
    315343         */ 
    … …  
    318346        /** 
    319347         * <p> 
    320          * the variable name of the object, i.e. a message, of which a parameter is identified if 
    321          * the term is a winInfoValue or a msgInfoValue; null instead 
     348         * Variable name of the object, i.e. a message, of which a parameter is identified if the 
     349         * term is a winInfoValue or a msgInfoValue; null otherwise. 
    322350         * </p> 
    323351         */ 
    … …  
    326354        /** 
    327355         * <p> 
    328          * the name of the parameter of the object, e.g. a message, of which a parameter is 
    329          * identified if the term is a paramValue, null instead 
     356         * Name of the parameter of the object, i.e., a message, of which a parameter is identified 
     357         * if the term is a paramValue; null otherwise. 
    330358         * </p> 
    331359         */ 
    … …  
    334362        /** 
    335363         * <p> 
    336          * the variable name of the message sequence denoted by the term in case of a seqValue; 
    337          * null instead 
     364         * Variable name of the message sequence denoted by the term in case of a seqValue; null 
     365         * otherwise. 
    338366         * </p> 
    339367         */ 
    … …  
    342370        /** 
    343371         * <p> 
    344          * the name of the parameter of the sequence of which a parameter is 
    345          * identified if the term is a seqValue, null instead 
     372         * Name of the parameter of the sequence of which a parameter is identified if the term is a 
     373         * seqValue; null otherwise. 
    346374         * </p> 
    347375         */ 
    … …  
    350378        /** 
    351379         * <p> 
    352          * the name of the parameter of the window of the object, e.g. a message, of which a 
    353          * parameter is identified if the term is a winInfoValue, null instead 
     380         * Name of the parameter of the window of the object, e.g. a message, of which a parameter 
     381         * is identified if the term is a winInfoValue; null otherwise. 
    354382         * </p> 
    355383         */ 
    … …  
    358386        /** 
    359387         * <p> 
    360          * the name of the info of the message of which a parameter is identified if the 
    361          * term is a msgInfoValue, null instead 
     388         * Name of the info of the message of which a parameter is identified if the term is a 
     389         * msgInfoValue; null otherwise. 
    362390         * </p> 
    363391         */ 
    … …  
    366394        /** 
    367395         * <p> 
    368          * the name of the parameter of the message into which a value shall be stored if the 
    369          * term is a resolveHwnd, null instead 
     396         * Name of the parameter of the message into which a value shall be stored if the term is a 
     397         * resolveHwnd, null otherwise 
    370398         * </p> 
    371399         */ 
    … …  
    374402        /** 
    375403         * <p> 
    376          * the list of handles to be resolved in case the term is a store or storeSeq, null instead 
     404         * List of handles to be resolved in case the term is a store or storeSeq; null otherwise. 
    377405         * </p> 
    378406         */ 
    … …  
    381409        /** 
    382410         * <p> 
    383          * TODO: comment 
    384          * </p> 
    385          * 
    386          * @param object 
     411         * Constructor. Creates a new Term. 
     412         * </p> 
     413         *  
     414         * @param termElement 
     415         *            JDOM element that describes the term 
    387416         */ 
    388417        @SuppressWarnings("unchecked") 
    389418        private Term(Element termElement) { 
    390419            this.name = termElement.getName(); 
    391              
     420 
    392421            if ("constValue".equals(name)) { 
    393422                this.value = termElement.getAttributeValue("value"); 
    … …  
    434463 
    435464        /** 
     465         * <p> 
     466         * Returns the name of the term. 
     467         * </p> 
     468         *  
    436469         * @return the name 
    437470         */ 
    … …  
    441474 
    442475        /** 
     476         * <p> 
     477         * Returns the value of the term. 
     478         * </p> 
     479         *  
    443480         * @return the value 
    444481         */ 
    … …  
    448485 
    449486        /** 
    450          * @return the object 
     487         * <p> 
     488         * Returns the object Id of the message, which is resolved as part of this term. 
     489         * </p> 
     490         *  
     491         * @return the object Id 
    451492         */ 
    452493        String getMessageId() { 
    … …  
    455496 
    456497        /** 
    457          * @return the objectParameter 
     498         * <p> 
     499         * Returns the name of the message parameter that is resolved as part of this term. 
     500         * </p> 
     501         *  
     502         * @return the message parameter name 
    458503         */ 
    459504        String getMessageParameterName() { 
    … …  
    462507 
    463508        /** 
    464          * @return the sequenceId 
     509         * <p> 
     510         * Returns the object Id of the message sequence, which is resolved as part of this term. 
     511         * </p> 
     512         *  
     513         * @return the object Id 
    465514         */ 
    466515        String getSequenceId() { 
    … …  
    469518 
    470519        /** 
     520         * <p> 
     521         * Returns the name of the message parameter that is resolved as part of this term. 
     522         * </p> 
     523         *  
    471524         * @return the sequenceParameter 
    472525         */ 
    … …  
    476529 
    477530        /** 
    478          * @return the windowParameter 
     531         * <p> 
     532         * Returns the window parameter name that is resolved as part of this term. 
     533         * </p> 
     534         *  
     535         * @return the name of the window parameter 
    479536         */ 
    480537        String getWindowParameterName() { 
    … …  
    483540 
    484541        /** 
    485          * @return the messageParameter 
     542         * <p> 
     543         * Returns the name of the message info value that is resolved as part of this term. 
     544         * </p> 
     545         *  
     546         * @return the name of the message info value 
    486547         */ 
    487548        String getMessageInfoName() { 
    … …  
    490551 
    491552        /** 
    492          * @return the storeParameter 
     553         * <p> 
     554         * Returns the object Id under which a message will be stored. 
     555         * </p> 
     556         *  
     557         * @return the object Id 
    493558         */ 
    494559        String getStoreParameterName() { 
    … …  
    497562 
    498563        /** 
    499          * @return the resolveHandles 
     564         * <p> 
     565         * Returns all terms that are responsible to resolve HWNDs. 
     566         * </p> 
     567         *  
     568         * @return the terms 
    500569         */ 
    501570        List<Term> getResolveHandles() { 
    … …  
    504573 
    505574    } 
    506      
    507     /** 
    508      * <p> 
    509      * TODO comment 
     575 
     576    /** 
     577     * <p> 
     578     * Helper class that defines the replay specification part of rules. 
    510579     * </p> 
    511580     *  
    512      * @version $Revision: $ $Date: 22.08.2012$ 
    513      * @author 2012, last modified by $Author: patrick$ 
     581     * @version 1.0 
     582     * @author Steffen Herbold, Patrick Harms 
    514583     */ 
    515584    class ReplayMessageSpec { 
    … …  
    517586        /** 
    518587         * <p> 
    519          * determines, if this specification defines one, or a sequence of messages 
     588         * Determines if this specification defines one, or a sequence of messages. 
    520589         * </p> 
    521590         */ 
    522591        private boolean generateSingleMessage; 
    523          
    524         /** 
    525          * <p> 
    526          * the id of a concrete message of message sequence to be replayed as is 
     592 
     593        /** 
     594         * <p> 
     595         * Object Id of a concrete message of message sequence to be replayed as is. 
    527596         * </p> 
    528597         */ 
    529598        private String replayObjectId; 
    530599 
     600        /** 
     601         * <p> 
     602         * Term describing the type of the generated message. 
     603         * </p> 
     604         */ 
    531605        private Term type; 
    532606 
     607        /** 
     608         * <p> 
     609         * Term describing the target of the generated message. 
     610         * </p> 
     611         */ 
    533612        private Term target; 
    534613 
     614        /** 
     615         * <p> 
     616         * Term describing the LO word of the LParam of the generated message. 
     617         * </p> 
     618         */ 
    535619        private Term lparamLoWord; 
    536620 
     621        /** 
     622         * <p> 
     623         * Term describing the HI word of the LParam of the generated message. 
     624         * </p> 
     625         */ 
    537626        private Term lparamHiWord; 
    538627 
     628        /** 
     629         * <p> 
     630         * Term describing the LParam of the generated message. 
     631         * </p> 
     632         */ 
    539633        private Term lparam; 
    540634 
     635        /** 
     636         * <p> 
     637         * Term describing the LO word of the WParam of the generated message. 
     638         * </p> 
     639         */ 
    541640        private Term wparamLoWord; 
    542641 
     642        /** 
     643         * <p> 
     644         * Term describing the HI word of the WParam of the generated message. 
     645         * </p> 
     646         */ 
    543647        private Term wparamHiWord; 
    544648 
     649        /** 
     650         * <p> 
     651         * Term describing the WParam of the generated message. 
     652         * </p> 
     653         */ 
    545654        private Term wparam; 
    546655 
     656        /** 
     657         * <p> 
     658         * Value in milliseconds that the replay waits until the the next message is replayed. 
     659         * </p> 
     660         */ 
    547661        private int delay; 
    548          
    549         /** 
    550          * <p> 
    551          * TODO: comment 
    552          * </p> 
    553          * 
    554          * @param child 
     662 
     663        /** 
     664         * <p> 
     665         * Constructor. Creates a new ReplayMessageSpec. 
     666         * </p> 
     667         *  
     668         * @param replayMessageSpecElement 
     669         *            JDOM element that describes the replay message specification 
    555670         */ 
    556671        @SuppressWarnings("unchecked") 
    … …  
    569684                } 
    570685            } 
    571              
     686 
    572687            this.delay = Integer.parseInt(replayMessageSpecElement.getAttributeValue("delay")); 
    573              
     688 
    574689            if (children.size() > 1) { 
    575690                for (Element child : children) { 
    576691                    Element termElement = (Element) child.getChildren().get(0); 
    577                      
     692 
    578693                    if (child.getName().equals("type")) { 
    579694                        this.type = new Term(termElement); 
    … …  
    581696                    else if (child.getName().equals("target")) { 
    582697                        this.target = new Term(termElement); 
    583                          
     698 
    584699                        if (!generateSingleMessage) { 
    585700                            // in this case, the target is always a sequence value term, i.e. 
    … …  
    595710                                new Term((Element) loWordElement.getChildren().get(0)); 
    596711                        } 
    597                          
     712 
    598713                        Element hiWordElement = child.getChild("HIWORD", namespace); 
    599714                        if (hiWordElement != null) { 
    600715                            this.lparamHiWord = 
    601                                  new Term((Element) hiWordElement.getChildren().get(0)); 
     716                                new Term((Element) hiWordElement.getChildren().get(0)); 
    602717                        } 
    603                          
     718 
    604719                        if ((lparamLoWord == null) && (lparamHiWord == null)) { 
    605720                            this.lparam = new Term(termElement); 
    … …  
    612727                                new Term((Element) loWordElement.getChildren().get(0)); 
    613728                        } 
    614                          
     729 
    615730                        Element hiWordElement = child.getChild("HIWORD", namespace); 
    616731                        if (hiWordElement != null) { 
    617732                            this.wparamHiWord = 
    618                                  new Term((Element) hiWordElement.getChildren().get(0)); 
     733                                new Term((Element) hiWordElement.getChildren().get(0)); 
    619734                        } 
    620                          
     735 
    621736                        if ((wparamLoWord == null) && (wparamHiWord == null)) { 
    622737                            this.wparam = new Term(termElement); 
    … …  
    629744        /** 
    630745         * <p> 
    631          * TODO: comment 
    632          * </p> 
    633          * 
    634          * @return 
     746         * Determines if this specification defines one, or a sequence of messages. 
     747         * </p> 
     748         *  
     749         * @return true if only a single message is generated; false if a sequence is generated 
    635750         */ 
    636751        boolean generateSingleMessage() { 
    … …  
    640755        /** 
    641756         * <p> 
    642          * TODO: comment 
    643          * </p> 
    644          * 
    645          * @return 
     757         * Returns the object Id from which the message is generated. 
     758         * </p> 
     759         *  
     760         * @return the object Id 
    646761         */ 
    647762        String getReplayObjectId() { 
    … …  
    650765 
    651766        /** 
    652          * @return the type 
     767         * <p> 
     768         * Returns the term that describes the type of the generated message. 
     769         * </p> 
     770         *  
     771         * @return the type term 
    653772         */ 
    654773        Term getType() { 
    … …  
    657776 
    658777        /** 
    659          * @return the target 
     778         * <p> 
     779         * Returns the term that describes the target of the generated message. 
     780         * </p> 
     781         *  
     782         * @return the target term 
    660783         */ 
    661784        Term getTarget() { 
    … …  
    664787 
    665788        /** 
    666          * @return the lparamLoWord 
     789         * <p> 
     790         * Returns the term that describes the LO word of the LParam of the generated message. 
     791         * </p> 
     792         *  
     793         * @return the LParam LO word term 
    667794         */ 
    668795        Term getLparamLoWord() { 
    … …  
    671798 
    672799        /** 
    673          * @return the lparamHiWord 
     800         * <p> 
     801         * Returns the term that describes the HI word of the LParam of the generated message. 
     802         * </p> 
     803         *  
     804         * @return the LParam HI word term 
    674805         */ 
    675806        Term getLparamHiWord() { 
    … …  
    678809 
    679810        /** 
    680          * @return the lparam 
     811         * <p> 
     812         * Returns the term that describes the LParam of the generated message. 
     813         * </p> 
     814         *  
     815         * @return the LParam term 
    681816         */ 
    682817        Term getLparam() { 
    … …  
    685820 
    686821        /** 
    687          * @return the wparamLoWord 
     822         * <p> 
     823         * Returns the term that describes the LO word of the WParam of the generated message. 
     824         * </p> 
     825         *  
     826         * @return the WParam LO word term 
    688827         */ 
    689828        Term getWparamLoWord() { 
    … …  
    692831 
    693832        /** 
    694          * @return the wparamHiWord 
     833         * <p> 
     834         * Returns the term that describes the HI word of the WParam of the generated message. 
     835         * </p> 
     836         *  
     837         * @return the WParam HI word term 
    695838         */ 
    696839        Term getWparamHiWord() { 
    … …  
    699842 
    700843        /** 
    701          * @return the wparam 
     844         * <p> 
     845         * Returns the term that describes the WParam of the generated message. 
     846         * </p> 
     847         *  
     848         * @return the WParam term 
    702849         */ 
    703850        Term getWparam() { 
    … …  
    706853 
    707854        /** 
     855         * <p> 
     856         * Returns the delay during the replay after this message is sent. 
     857         * </p> 
     858         *  
    708859         * @return the delay 
    709860         */ 
Note: See TracChangeset for help on using the changeset viewer.