Feature #692

Perform an extensive interface review of all classes

Added by Knödlseder Jürgen almost 12 years ago. Updated about 11 years ago.

Status:ClosedStart date:01/12/2013
Priority:UrgentDue date:
Assigned To:Knödlseder Jürgen% Done:

100%

Category:-Estimated time:204.00 hours
Target version:00-08-00
Duration:

Description

We should review the interfaces of all classes to make sure that all interfaces are homogeneous and also complete. This is an important step towards the first stable release which will enter under interface control.

Here a couple of principles that should be respected during interface review:

  • Each class should have a constructor that allows one-line construction of a meaningful objects.
    This makes programming much easier, and prevents the need for a two step process for object creation (allocation and setting). The object constructor should take the most relevant parameters as arguments. Specific attributes can always be set using additional methods.
  • If a class has an assignment method that assigns n elements of a given type (such as the std::vector.assign() method), the first argument is the number of elements n, followed by the element.

Recurrence

No recurrence.


Subtasks

Action #771: Review app module classesClosedKnödlseder Jürgen

Action #770: Review obs module classesClosedKnödlseder Jürgen

Action #772: Review fits module classesClosedKnödlseder Jürgen

Action #774: Review sky module classesClosedKnödlseder Jürgen

Action #777: Review test module classesClosedKnödlseder Jürgen

Action #778: Review numerics module classesClosedKnödlseder Jürgen

Action #779: Review support module classesClosedKnödlseder Jürgen

Action #775: Review linalg module classesClosedKnödlseder Jürgen

Action #773: Review model module classesClosedKnödlseder Jürgen

Action #693: Review interface for GModelSpectral classesClosedKnödlseder Jürgen

Action #776: Review opt module classesClosedKnödlseder Jürgen

Action #808: Support also non-factorized sky models.ClosedKnödlseder Jürgen

Action #769: Review xml module classesClosedKnödlseder Jürgen

Action #818: Add chatter level to print() methodsClosedKnödlseder Jürgen

Action #1035: Review COM interfaceClosedKnödlseder Jürgen

Action #1034: Review MWL interfaceClosedKnödlseder Jürgen

Action #1033: Review CTA interfaceClosedKnödlseder Jürgen

Action #1032: Review LAT interfaceClosedKnödlseder Jürgen


Related issues

Related to GammaLib - Change request #689: GXmlNode append method should clone node. Closed 01/11/2013
Related to GammaLib - Action #768: Add GContainer interface class Closed 12/15/2012

History

#1 Updated by Knödlseder Jürgen almost 12 years ago

  • Target version set to 00-08-00

#2 Updated by Knödlseder Jürgen almost 12 years ago

  • Status changed from New to In Progress

#3 Updated by Knödlseder Jürgen almost 12 years ago

  • Assigned To set to Knödlseder Jürgen

#4 Updated by Knödlseder Jürgen almost 12 years ago

  • Description updated (diff)

#5 Updated by Knödlseder Jürgen about 11 years ago

  • Status changed from In Progress to Closed

Also available in: Atom PDF