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

EECFI::SatNomTransId Class Reference

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

Inheritance diagram for EECFI::SatNomTransId:
EECFI::CfiId EECFI::CfiClass

List of all members.

Public Member Functions

 SatNomTransId ()
 Empty Class constructor.
 ~SatNomTransId () EXCEPT
 Class destructor.
void init (long aocsModel)
 Initialise using AOCS model.
void init (long model, const std::vector< double > &modelParams)
 Initialise satellite nominal attitude model for a given satellite.
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 (const TimeCorrelation &timeId, const std::vector< std::string > &files, long timeInitMode, long timeRef, double time0, double time1)
 Initialise satellite nominal attitude angles for a given satellite reading values from the attitude files.
long getAOCS () const
 Get AOCS parameters.
void setAOCS (long aocsModel)
 Change initialisation AOCS parameters from the object.
ParamModel getParam () const
 Get initialisation parameters of object.
void setParam (const ParamModel &paramModel)
 Change initialisation parameters of the object.
HarmonicModel getHarmonic () const
 Get harmonic parameters of object.
void setHarmonic (const HarmonicModel &harmModel)
 Change harmonic parameters of the object.
AttFileModel getFile () const
 Get file data of object.
void setFile (const AttFileModel &fileModel)
 Change initialisation file data of the object.
void setAzElDefinition (const AzElDefinition &azElDef)
 Set azimuth/elevation definition.
SatId satId () const
 Return satellite id.

Protected Member Functions

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

Detailed Description

Class for storing the Satellite Nominal Attitude configuration parameters.

Constructor & Destructor Documentation

EECFI::SatNomTransId::SatNomTransId (  ) 

Empty Class constructor.

EECFI::SatNomTransId::~SatNomTransId (  ) 

Class destructor.

References eraseObject().

Member Function Documentation

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

Erase object and free memory.

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

Referenced by EECFI::Attitude::setTransformations(), and ~SatNomTransId().

long EECFI::SatNomTransId::getAOCS (  )  const

Get AOCS parameters.

Returns:
AOCS model.

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

AttFileModel EECFI::SatNomTransId::getFile (  )  const

Get file data of object.

Returns:
File model data.

References EECFI::CfiError::addMsg(), EECFI::AttFileModel::attData, EECFI::AttFileModel::dataType, EECFI::AttFileModel::fileModel, EECFI::AttFileModel::inertialFrame, EECFI::AttFileModel::maxGap, EECFI::CfiClass::throwWarn, EECFI::AttFileModel::valTime0, and EECFI::AttFileModel::valTime1.

HarmonicModel EECFI::SatNomTransId::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::SatNomTransId::getId (  )  [protected]

Get the internal id (xp_sat_nom_trans_id C struct).

Returns:
Pointer to xp_sat_nom_trans_id.

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

ParamModel EECFI::SatNomTransId::getParam (  )  const

Get initialisation parameters of object.

Returns:
Parameters of model; the size of the returning vector will be always 15, but meaningful positions depend on the model.

References EECFI::CfiError::addMsg(), EECFI::ParamModel::model, EECFI::ParamModel::modelParam, and EECFI::CfiClass::throwWarn.

void EECFI::SatNomTransId::init ( long  aocsModel  ) 

Initialise using AOCS model.

Parameters:
aocsModel AOCS model (SatNominalAttAocsModeEnum).

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

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

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

void EECFI::SatNomTransId::init ( long  model,
const std::vector< double > &  modelParams 
)

Initialise satellite nominal attitude model for a given satellite.

void EECFI::SatNomTransId::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.

SatId EECFI::SatNomTransId::satId (  )  const

Return satellite id.

Returns:
Satellite id.
void EECFI::SatNomTransId::setAOCS ( long  aocsModel  ) 

Change initialisation AOCS parameters from the object.

Parameters:
aocsModel AOCS model.

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

void EECFI::SatNomTransId::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::SatNomTransId::setFile ( const AttFileModel &  fileModel  ) 

Change initialisation file data of the object.

Parameters:
fileModel File model data.

References EECFI::CfiError::addMsg(), EECFI::AttFileModel::attData, EECFI::AttFileModel::dataType, EECFI::AttFileModel::fileModel, EECFI::AttFileModel::inertialFrame, EECFI::AttFileModel::maxGap, EECFI::CfiClass::throwWarn, EECFI::AttFileModel::valTime0, and EECFI::AttFileModel::valTime1.

void EECFI::SatNomTransId::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::SatNomTransId::setParam ( const ParamModel &  paramModel  ) 

Change initialisation parameters of the object.

Parameters:
paramModel Parameters of model.

References EECFI::CfiError::addMsg(), EECFI::ParamModel::model, EECFI::ParamModel::modelParam, and EECFI::CfiClass::throwWarn.

Generated on Fri May 29 2020 14:17:41 for by doxygen 1.7.1