PAB-4093: Change log for new parameters in Counter block

[kailol-sag]

Important: This PR must be merged together with an automatically created PR for the update to the description of the Counter block in the block reference. In the block reference (on the other PR), there's a link in the description of the Counter block which goes to "Types" in the PAM doc. Make sure that this is a valid link which goes to the (not yet published) PAM 10.15.5 doc.

@nmfa , I did not add your parameter descriptions from the doc task at https://itrac.eur.ad.sag/browse/PAB-4480. There's a link to the Counter block instead.
However, these parameter descriptions contain helpful information which is missing in the block reference. Is it possible that you add this information to the block reference?

Your input says that the counter resets to 1. But the PR at https://github.softwareag.com/IOTA/apama-in-c8y/pull/3731/files says that it resets to zero. Or did I misinterpret anything?

Update from July 9: All done and reviewed. This should be merged together with the updated block reference #2261.

[nicholasadams]

It originally resetvto zero, until I realised that was wrong. There may well be an old comment on the PR to that effect. The code and ApamaDoc were updated tpday.

I thought the two descriptions were pretty equivalent. Which bits would you like me to add to the ApamaDoc?

[kailol-sag]

I looked at the generated block reference on your tenant to get a better overview of your changes, and I stumbled over the following:

The block reference says this for the Loop Count:
"If selected, the Count output port is automatically reset to zero when the maximum value is reached."

But your doc input on the iTrac says this:
"loopCount (default true): This defines whether the Count output port automatically rolls over and resets to 1 once the maximum value is exceeded, ..."

It's "zero" vs "1", which is confusing.

I was referring to the sentences where you said "this can be useful for". Esp. the 2nd one which is not (yet) mentioned in the block reference: "This can be useful for assessing whether a value has remained static for an unexpectedly long time, such as positions within a GPS measurement."

The description at the top of the block reference already says "This is useful, for example, if you want to trigger an action on every nth input." I'm wondering now: is this true for both float parameters or only for the Maximum Count? Maybe this sentence should be moved from the top to the description of the Maximum Count ... ???

Also adding @shrutidogra-23 hoping that she can help as she also reviewed your dev PR.

[shrutidogra-23]

I looked at the generated block reference on your tenant to get a better overview of your changes, and I stumbled over the following:

The block reference says this for the Loop Count: "If selected, the Count output port is automatically reset to zero when the maximum value is reached."

But your doc input on the iTrac says this: "loopCount (default true): This defines whether the Count output port automatically rolls over and resets to 1 once the maximum value is exceeded, ..."

It's "zero" vs "1", which is confusing.

I was referring to the sentences where you said "this can be useful for". Esp. the 2nd one which is not (yet) mentioned in the block reference: "This can be useful for assessing whether a value has remained static for an unexpectedly long time, such as positions within a GPS measurement."

The description at the top of the block reference already says "This is useful, for example, if you want to trigger an action on every nth input." I'm wondering now: is this true for both float parameters or only for the Maximum Count? Maybe this sentence should be moved from the top to the description of the Maximum Count ... ???

Also adding @shrutidogra-23 hoping that she can help as she also reviewed your dev PR.

I think the line we should stick to and which is correct is : Count/Number Same output port is automatically reset to 0 when the maximum value is reached.

I looked at the description on doc task itrac just now and it's incorrect. It says "... resets to 1..." which is not right.

And to answer your question Karin, yes the resetting to 0 happens for both the parameters and is controlled separately by Loop Count and Loop Number Same depending on if they are selected or not.
So both the example scenarios are correct. GPS one is applicable to Maximum Number Same counter and nth input one is applicable to Maximum count

[nmfa]

@kailol-sag THat was an error in the doc. Fcied with https://github.softwareag.com/IOTA/apama-in-c8y/pull/4026.

[skom-c8y]

Requires build 25.192.0

[skom-c8y]

Build 198 is deployed to eu-latest on 25th July, but update to block reference documentation (#2261) can't be pushed till build v199 is deployed

will deploy both at the same time