SMILE  v2.5
Schwarzschild Modelling Interactive expLoratory Environment
Public Member Functions | Private Attributes | List of all members
smile::CSchwInformation Class Reference

Information object that keeps density data for all variants of Schwarzschild data objects. More...

#include <schwarzschild.h>

Inheritance diagram for smile::CSchwInformation:
Inheritance graph
[legend]
Collaboration diagram for smile::CSchwInformation:
Collaboration graph
[legend]

Public Member Functions

template<typename NumT >
 CSchwInformation (CBasicSchwData::SCHWDATATYPE _dataType, const std::vector< NumT > &_schwData)
 create the data object from a one-dimensional array
 
virtual INFOTYPE infoType () const
 all Schwarzschild information objects have the same information type
 
CBasicSchwData::SCHWDATATYPE schwDataType () const
 return the type of Schwarzschild data object for which this information is applicable
 
virtual std::string toString () const
 no textual representation available
 
const std::vector< sdNumType > & getSchwData () const
 return the entire data serialized into a one-dimensional array
 
sdNumType getSchwData (size_t i) const
 overloaded function for convenience access to data elements
 

Private Attributes

const CBasicSchwData::SCHWDATATYPE dataType
 the type of Schwarzschild data stored in this object
 
std::vector< sdNumTypeschwData
 one-dimensional data array
 

Additional Inherited Members

- Public Types inherited from smile::CBasicInformation
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...
 

Detailed Description

Information object that keeps density data for all variants of Schwarzschild data objects.

Model-specific density or kinematic or any other data is kept in a single array "schwData", whose meaning depends on the variant of model. The data type is returned by another dedicated function.


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