[Repast-developer] [ repast-Bugs-1178502 ] Doc fix

[SourceForge.net <no...@so...>]

Bugs item #1178502, was opened at 2005-04-07 07:51
Message generated for change (Settings changed) made by jerryvos
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=101703&aid=1178502&group_id=1703

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: None
Group: None
>Status: Closed
>Resolution: Fixed
Priority: 5
Submitted By: Nobody/Anonymous (nobody)
Assigned to: Nobody/Anonymous (nobody)
Summary: Doc fix

Initial Comment:
> > i noticed for the scheduleActionAt(*) methods, it
doens't say
> > what the return value is or means.
> > I suppose one can assume its the BasicAction passed
to it,
> > sort of in the spirit of the original objectiveC
"standard".
> > but it would be nice to know.
> > Also, can these calls fail (and return, eg, null)?
>
> Its the action that is actually scheduled. This may
or may not be the
> BasicAction passed to it. Its main use is if you want
to remove the action
> from the schedule later, and you need a reference to
the scheduled action.
> The call should not fail.
>
>
> > scheduleAcationAt(time,action) says
> >   Schedules the specified BasicAction to occur at
the specified clock tick
> >   in the specified order.
> > but there is not specified order.  So wht is the
default?
>
> Bad docs here. The default order is random w/r to any
other action scheduled
> for that tick, except those scheduled to execute LAST
at that tick.
>
>
> > For methods like
scheduleBasicActionAt(time,action,order)
> > one option is CONCURRENT.
> > Is there someplace in the doc that describes
exactly what that means?
>
> I thought these were doc'd in the javadoc under the
order fields, but they
> are not, or maybe in the how to on scheduling.
CONCURRENT is essentially
> random w/r to any other action scheduled for that
tick. The idea being that
> the execution of one action is independent of another
and they can execute
> concurrently.
>

- change the scheduleActionAt docs to say that it is
returning
  an action that may NOT be the one passed to
it...otherwise
  people might assume otherwise, and then save the ptr
  to the action they created/passed in rather than the
one returned.

- explain that CONCURRENT means random
  Better: add a synonym RANDOM and use that in the doc!




----------------------------------------------------------------------

>Comment By: Jerry Vos (jerryvos)
Date: 2005-07-13 14:18

Message:
Logged In: YES 
user_id=1093815

Added the RANDOM synonym Nick mentioned and updated
references to point to that.  

Also the docs have been updated with the return action info
that Nick mentioned.

Finally, javadoc tags have been added to the
ScheduleBase.[Orders] with some more info on what they mean.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=101703&aid=1178502&group_id=1703