libsbml icon indicating copy to clipboard operation
libsbml copied to clipboard

C# Interface/Qual/GetSign Documentation

Open hallba opened this issue 4 years ago • 0 comments

The documentation for getSign function (a method of Inputs, part of qual) states that it should return a string representing the type of interaction;

http://sbml.org/Software/libSBML/5.18.0/docs/csharp-api/classlibsbmlcs_1_1_input.html#a23f95d8cc2b3165cfb706b0062d43cb9

The documentation of the Input object states it returns an int (http://sbml.org/Software/libSBML/5.18.0/docs/csharp-api/classlibsbmlcs_1_1_input.html), which matches the code behaviour. The interpretation of this int is not documented but from the code the integer returned will match the index of string below in the file.

"positive"  , "negative"  , "dual"  , "unknown"  , "NOT SET"

Alternatively 4 will be returned if the value is NULL or not in this list.

It would be very helpful if the documentation was updated to describe this behaviour.

hallba avatar May 28 '21 20:05 hallba