DEIMOS
Earth Observation Mission CFI Software
Pointing Software User Manual		 ESA
Public Member Functions | Protected Member Functions

EECFI::SatTransId Class Reference

Class for storing the Satellite Attitude configuration parameters. More...

Inheritance diagram for EECFI::SatTransId:
EECFI::CfiId EECFI::CfiClass

List of all members.

Public Member Functions

 SatTransId ()
 Empty Class constructor.
virtual ~SatTransId () EXCEPT
 Class destructor.
void init (const double angle[3])
 Initialise using angles.
void init (const double matrix[3][3])
 Initialise using matrix.
void init (long angleType, const std::vector< long > &harmTypePitch, const std::vector< long > &harmTypeRoll, const std::vector< long > &harmTypeYaw, const std::vector< double > &harmCoeffPitch, const std::vector< double > &harmCoeffRoll, const std::vector< double > &harmCoeffYaw)
 Initialise satellite orbital to satellite nominal attitude mispointing angles for a given satellite with harmonics.
void init (long inertialFrame, const std::vector< AttRec > &quaternions, const double matrix[3][3])
 Initialise using quaternions plus matrix.
void init (long inertialFrame, const std::vector< AttRec > &quaternions, const double angles[3])
 Initialise using quaternions plus angles.
void init (const TimeCorrelation &timeId, const std::vector< std::string > &files, std::string &auxiliaryFile, long timeInitMode, long timeRef, double time0, double time1)
 Initialise satellite attitude angles for a given satellite reading values from the attitude files.
MatrixModel getMatrix () const
 Get matrix model.
void setMatrix (const MatrixModel &matrixModel)
 Change matrix model.
AngleModel getAngles () const
 Get angles model.
void setAngles (const AngleModel &angleModel)
 Change angles model.
HarmonicModel getHarmonic () const
 Get harmonic parameters of object.
void setHarmonic (const HarmonicModel &harmModel)
 Change harmonic parameters of the object.
SatAttFileModel getFile () const
 Get file data of object.
void setFile (const SatAttFileModel &fileModel)
 Change initialisation file data of the object.
QuatPlusMatrixModel getQuatPlusMatrix () const
 Get quaternions plus matrix model.
void setQuatPlusMatrix (const QuatPlusMatrixModel &quatPlusMatrixModel)
 Change quaternions plus matrix model.
QuatPlusAnglesModel getQuatPlusAngles () const
 Get quaternions plus angles model.
void setQuatPlusAngles (const QuatPlusAnglesModel &quatPlusAnglesModel)
 Change quaternions plus angles model.
void setAzElDefinition (const AzElDefinition &azElDef)
 Set azimuth/elevation definition.
SatId satId () const
 Return satellite id.
void operator= (const SatTransId &satTransIdIn)
 Copy operator.

Protected Member Functions

void eraseObject ()
 Erase object and free memory.
GenericId * getId () const
 Get the internal id (xp_sat_trans_id C struct).

Detailed Description

Class for storing the Satellite Attitude configuration parameters.

Constructor & Destructor Documentation

EECFI::SatTransId::SatTransId (  ) 

Empty Class constructor.

EECFI::SatTransId::~SatTransId (  )  [virtual]

Class destructor.

References eraseObject().

Member Function Documentation

void EECFI::SatTransId::eraseObject (  )  [protected]

Erase object and free memory.

References EECFI::CfiId::status(), EECFI::CfiId::subtractInstance(), and EECFI::CfiClass::throwWarn.

Referenced by operator=(), and ~SatTransId().

AngleModel EECFI::SatTransId::getAngles (  )  const

Get angles model.

Returns:
Angle model data.

References EECFI::CfiError::addMsg(), EECFI::AngleModel::angles, and EECFI::CfiClass::throwWarn.

SatAttFileModel EECFI::SatTransId::getFile (  )  const

Get file data of object.

Returns:
File model data.

References EECFI::StarTrackerAux::aberrCorrection, EECFI::CfiError::addMsg(), EECFI::SatAttFileModel::attData, EECFI::SatAttFileModel::auxData, EECFI::SatAttFileModel::dataType, EECFI::SatAttFileModel::fileModel, EECFI::SatAttFileModel::inertialFrame, EECFI::SatAttFileModel::maxGap, EECFI::StarTrackerAux::starTrId, EECFI::StarTrackerAux::strAttRot, EECFI::CfiClass::throwWarn, EECFI::SatAttFileModel::tmData, EECFI::SatAttFileModel::valTime0, and EECFI::SatAttFileModel::valTime1.

HarmonicModel EECFI::SatTransId::getHarmonic (  )  const

Get harmonic parameters of object.

Returns:
Harmonic model data.

References EECFI::CfiError::addMsg(), EECFI::HarmonicModel::angleType, EECFI::HarmonicData::harmonicCoeffPitch, EECFI::HarmonicData::harmonicCoeffRoll, EECFI::HarmonicData::harmonicCoeffYaw, EECFI::HarmonicModel::harmonicData, EECFI::HarmonicData::harmonicTypePitch, EECFI::HarmonicData::harmonicTypeRoll, EECFI::HarmonicData::harmonicTypeYaw, and EECFI::CfiClass::throwWarn.

GenericId * EECFI::SatTransId::getId (  )  const [protected]

Get the internal id (xp_sat_trans_id C struct).

Returns:
Pointer to xp_sat_trans_id.

Referenced by EECFI::AttitudeDef::attitudeTransform(), EECFI::Attitude::changeFrame(), EECFI::Attitude::compute(), EECFI::AttitudeDef::genAttitudeData(), and operator=().

MatrixModel EECFI::SatTransId::getMatrix (  )  const

Get matrix model.

Returns:
Matrix model data.

References EECFI::CfiError::addMsg(), EECFI::MatrixModel::attMatrix, and EECFI::CfiClass::throwWarn.

QuatPlusAnglesModel EECFI::SatTransId::getQuatPlusAngles (  )  const

Get quaternions plus angles model.

Returns:
Quaternion plus angles model data.

References EECFI::CfiError::addMsg(), EECFI::QuatPlusAnglesModel::angles, EECFI::QuatPlusAnglesModel::inertialFrame, EECFI::QuatPlusAnglesModel::quat, and EECFI::CfiClass::throwWarn.

QuatPlusMatrixModel EECFI::SatTransId::getQuatPlusMatrix (  )  const

Get quaternions plus matrix model.

Returns:
Quaternion plus matrix model data.

References EECFI::CfiError::addMsg(), EECFI::QuatPlusMatrixModel::inertialFrame, EECFI::QuatPlusMatrixModel::quat, EECFI::QuatPlusMatrixModel::rotMatrix, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::init ( const double  matrix[3][3]  ) 

Initialise using matrix.

Parameters:
matrix Rotation matrix.

References EECFI::CfiId::addInstance(), and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::init ( long  angleType,
const std::vector< long > &  harmTypePitch,
const std::vector< long > &  harmTypeRoll,
const std::vector< long > &  harmTypeYaw,
const std::vector< double > &  harmCoeffPitch,
const std::vector< double > &  harmCoeffRoll,
const std::vector< double > &  harmCoeffYaw 
)

Initialise satellite orbital to satellite nominal attitude mispointing angles for a given satellite with harmonics.

void EECFI::SatTransId::init ( long  inertialFrame,
const std::vector< AttRec > &  quaternions,
const double  matrix[3][3] 
)

Initialise using quaternions plus matrix.

void EECFI::SatTransId::init ( const double  angle[3]  ) 

Initialise using angles.

Parameters:
angle Rotation angles.

  • [0]: Pitch mispointing angle (Satellite Nominal Attitude Frame) [deg]. Allowed range: If no better value, assume 0.0.
  • [1]: Roll mispointing angle (Satellite Nominal Attitude Frame) [deg]. Allowed range: If no better value, assume 0.0.
  • [2]: Yaw mispointing angle (Satellite Nominal Attitude Frame) [deg]. Allowed range: If no better value, assume 0.0.

.

References EECFI::CfiId::addInstance(), and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::init ( const TimeCorrelation &  timeId,
const std::vector< std::string > &  files,
std::string &  auxiliaryFile,
long  timeInitMode,
long  timeRef,
double  time0,
double  time1 
)

Initialise satellite attitude angles for a given satellite reading values from the attitude files.

void EECFI::SatTransId::init ( long  inertialFrame,
const std::vector< AttRec > &  quaternions,
const double  angles[3] 
)

Initialise using quaternions plus angles.

void EECFI::SatTransId::operator= ( const SatTransId &  satTransIdIn  ) 

Copy operator.

Parameters:
satTransIdIn SatTransId we want to copy.

References EECFI::CfiId::addInstance(), EECFI::GenericId::ee_id, eraseObject(), and getId().

SatId EECFI::SatTransId::satId (  )  const

Return satellite id.

Returns:
Satellite id.
void EECFI::SatTransId::setAngles ( const AngleModel &  angleModel  ) 

Change angles model.

Parameters:
angleModel Angle model data.

References EECFI::CfiError::addMsg(), EECFI::AngleModel::angles, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::setAzElDefinition ( const AzElDefinition &  azElDef  ) 

Set azimuth/elevation definition.

Parameters:
azElDef Definition of azimuth and elevation.

References EECFI::AzElDefinition::az0Axis, EECFI::AzElDefinition::az90Axis, EECFI::AzElDefinition::el90Axis, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::setFile ( const SatAttFileModel &  fileModel  ) 

Change initialisation file data of the object.

Parameters:
fileModel File model data.

References EECFI::StarTrackerAux::aberrCorrection, EECFI::CfiError::addMsg(), EECFI::SatAttFileModel::attData, EECFI::SatAttFileModel::auxData, EECFI::SatAttFileModel::dataType, EECFI::SatAttFileModel::fileModel, EECFI::SatAttFileModel::inertialFrame, EECFI::SatAttFileModel::maxGap, EECFI::StarTrackerAux::starTrId, EECFI::StarTrackerAux::strAttRot, EECFI::CfiClass::throwWarn, EECFI::SatAttFileModel::tmData, EECFI::SatAttFileModel::valTime0, and EECFI::SatAttFileModel::valTime1.

void EECFI::SatTransId::setHarmonic ( const HarmonicModel &  harmonicModel  ) 

Change harmonic parameters of the object.

Parameters:
harmonicModel Harmonic model data.

References EECFI::CfiError::addMsg(), EECFI::HarmonicModel::angleType, EECFI::HarmonicData::harmonicCoeffPitch, EECFI::HarmonicData::harmonicCoeffRoll, EECFI::HarmonicData::harmonicCoeffYaw, EECFI::HarmonicModel::harmonicData, EECFI::HarmonicData::harmonicTypePitch, EECFI::HarmonicData::harmonicTypeRoll, EECFI::HarmonicData::harmonicTypeYaw, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::setMatrix ( const MatrixModel &  matrixModel  ) 

Change matrix model.

Parameters:
matrixModel Matrix model data.

References EECFI::CfiError::addMsg(), EECFI::MatrixModel::attMatrix, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::setQuatPlusAngles ( const QuatPlusAnglesModel &  quatPlusAng  ) 

Change quaternions plus angles model.

Parameters:
quatPlusAng Quaternion plus angles model data.

References EECFI::CfiError::addMsg(), EECFI::QuatPlusAnglesModel::angles, EECFI::QuatPlusAnglesModel::inertialFrame, EECFI::QuatPlusAnglesModel::quat, and EECFI::CfiClass::throwWarn.

void EECFI::SatTransId::setQuatPlusMatrix ( const QuatPlusMatrixModel &  quatPlusMat  ) 

Change quaternions plus matrix model.

Parameters:
quatPlusMat Quaternion plus matrix model data.

References EECFI::CfiError::addMsg(), EECFI::QuatPlusMatrixModel::inertialFrame, EECFI::QuatPlusMatrixModel::quat, EECFI::QuatPlusMatrixModel::rotMatrix, and EECFI::CfiClass::throwWarn.

Generated on Mon Dec 20 2021 22:35:01 for by doxygen 1.7.1