Feature new speakerfile

[paul-krug]

Changes the meaning of the 'name' element from the Param and Parameter structs of Glottis.h and Vocaltract.h from 'full meaning of the parameter' to 'Abbreviated parameter'.
Introduces 'description' element from the Param and Parameter structs of Glottis.h and Vocaltract.h that have the meaning 'full meaning of the parameter'.
Removes the 'abbr' element from the Param and Parameter structs of Glottis.h and Vocaltract.h.
Introduces new short names for all static, control and derived parameters in all three glottis models.
Introduces new speakerfile 'JD3.speaker' that has consistent tags across sub-glottal and supra-glottal parameters.
Glottal parameters are now read in by 'name' tag and not by 'index' tag anymore, which is now consistent with the supra-glottal parameters.
Bugs in the corresponding XMLnode helpers were fixed.

I ask for a careful review, as this commit represents a more signifcant modification of the VTL code than usual.

[Simon-Stone]

Please add and run appropriate unit tests to check the new behavior.

[Simon-Stone]

Exceptions are not returned but thrown. Please revise. Also state the type of exceptions explicitly (std::invalid_argument, std::out_of_range) so that caller can catch it appropriately. We also should differentiate between the std::invalid_argument exception thrown by std::stoi in case of conversion error and the std::invalid_argument. In fact, the optimal solution would be to create a custom exception like so (untested code):

struct XmlException : public std::exception
{
    const char* what() const throw() override
    {
    	return "An XML exception occurred!";
    }
}

struct XmlAttributeNotFound : public XmlException
{
    const char* what() const throw() override
    {
    	return "Could not find attribute!";
    }
}

struct XmlBadAttribute : public XmlException
{
    const char* what() const throw() override
    {
    	return "Attribute could not be converted to expected type";
    }
}

That way we could throw XmlAttributeNotFound instead of std::invalid_argument and catch the std::invalid_argument from std::stoi and rethrow as XmlBadAttribute.

[paul-krug]

std::stoi throw different messages than the other errors. You can already differentiate between them.

[Simon-Stone]

Identifying an exception by its message is bad practice because it is implementation-dependent. Different compilers may throw different messages. The only safe (and also much more explicit) way is to use custom exceptions here.

[Simon-Stone]

Same comments as in getAttributeInt()

[Simon-Stone]

Same comments as in getAttributeInt()

[paul-krug]

The unit test already exists, as the API could not even initialize if the new speakerfile was not working correctly.

[Simon-Stone]

The unit test already exists, as the API could not even initialize if the new speakerfile was not working correctly.

Right, agreed.

[paul-krug]

Added the custom exceptions.
Tested and working. 'Cord_length' parameters must still be renamed

[Simon-Stone]

Move the XML exceptions to a separate file XmlExceptions.h. The general guideline is to have one class per translation unit, although in this case I think it makes sense to have all the XmlException-derived classes in the same file.

I would generally recommend moving the implementation to a separate CPP file. If you choose not to (since it is very brief), make sure you mark the methods as inline, otherwise we may get compilation errors if the header is included in multiple files.

[paul-krug]

Done

[paul-krug]

Should be ready now