Menu

#7 Inconsistent documentation re CFG object?

1.0
open
None
2020-12-02
2020-10-16
No

nuSolve documentation page 70 last line says
"config.useDelayType = CFG.VD_GRP_DELAY;"
But "Table 8.7: Properties of metaobject CFG." list "VlbiDelayType", and not "useDelayType". Which one is correct?

Discussion

  • Eskil Varenius

    Eskil Varenius - 2020-10-16

    Experimenting, it seems it should be "useDelayType" and "useRateType"; trying with "VlbiDelayType" or "VlbiRateType" returns "undefined". So I suspect the table 8.7 is wrong?

     
  • Sergei Bolotin

    Sergei Bolotin - 2020-11-20

    Eskil,
    "useDelayType" is a member of "config", it can take values of type "VlbiDelayType" which are VD_NONE, VD_SB_DELAY, VD_GRP_DELAY and VD_PHS_DELAY (as they are listed in the table).
    So, you can write in a script:

    config.useDelayType = CFG.VD_GRP_DELAY
    or
    config.useDelayType = CFG.VD_SB_DELAY

    and so on.

     
  • Eskil Varenius

    Eskil Varenius - 2020-11-30

    I understand. But the problem was another thing, in documentation. Sorry I was unclear.
    Problem is: documentation table Table 8.7 writes "VlbiDelayType". But it should be "useDelayType"
    Right?

     
    • Sergei Bolotin

      Sergei Bolotin - 2020-12-02

      No. VlbiDelayType is a type, like int, char or enum, that can get the values from the table.
      useDelayType is a member of "config" object. This member is of type "VlbiDelayType". So it is ok to write config.useDelayType = CFG.VD_SB_DELAY, or something like that. The table 8.2 lists members of CFG (they are called "properties" as in Java script) and their types.

       
  • Eskil Varenius

    Eskil Varenius - 2020-12-02

    Ah, I see. Thank you for explaining.

     

Log in to post a comment.

MongoDB Logo MongoDB