SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Types | Public Member Functions | List of all members
smile::CBasicInformation Class Referenceabstract

parent class for data container objects used to store various data and exchange it between objects. More...

#include <common.h>

Inheritance diagram for smile::CBasicInformation:
Inheritance graph
[legend]

Public Types

enum  INFOTYPE {
  IT_UNKNOWN, IT_TRAJ_ANALYSIS, IT_TRAJ_SAMPLE, IT_POINCARE,
  IT_PERICENTER, IT_SCHW, IT_VEL_PERTURBER
}
 lists all possible information types More...
 

Public Member Functions

virtual INFOTYPE infoType () const =0
 return the derived class type
 
virtual std::string toString () const =0
 present a textual representation of the data contained in this class (may be empty string)
 

Detailed Description

parent class for data container objects used to store various data and exchange it between objects.

Data stored here is related to some orbit properties (e.g. orbit classification results, or points in the trajectory, or data for Schwarzschild modelling). The instances of runtime functions derived from CBasicOrbitRuntimeFnc return specific information objects which contain data collected about the orbit during integration. Classes defined in fileio.h handle storing and loading data. Classes derived from CBasicSchwData also use the CSchwInformation class to store data for modelling.

Member Enumeration Documentation

lists all possible information types

Enumerator
IT_UNKNOWN 

dark matter

IT_TRAJ_ANALYSIS 

orbit analysis: COrbitInformation

IT_TRAJ_SAMPLE 

CTrajSampleInformation.

IT_POINCARE 

CPoincareInformation [unused].

IT_PERICENTER 

CPericenterInformation.

IT_SCHW 

CSchwInformation.

IT_VEL_PERTURBER 

CVelPerturberInformation.


The documentation for this class was generated from the following file: