Isis 3 Programmer Reference
Isis::TargetBody Class Reference

Container class for TargetBody. More...

#include <TargetBody.h>

Inheritance diagram for Isis::TargetBody:
Inheritance graph
Collaboration diagram for Isis::TargetBody:
Collaboration graph

Public Member Functions

 TargetBody (Target *target, QObject *parent=0)
 The first constructor for this class. More...
 
 ~TargetBody ()
 The second constructor for this class. More...
 
bool operator== (const TargetBody &src) const
 Compares two Target Body objects to see if they are equal. More...
 
TargetBodyDisplayPropertiesdisplayProperties ()
 Gets TargetBodyDisplayProperties. More...
 
const TargetBodyDisplayPropertiesdisplayProperties () const
 TargetBody::displayProperties. More...
 
QString id () const
 Output format: More...
 
QString targetName ()
 Returns the value stored at TargetName in the original pvl label. More...
 
int frameType ()
 Returns the frame type. More...
 
std::vector< AnglepoleRaCoefs ()
 TargetBody::poleRaCoefs. More...
 
std::vector< AnglepoleDecCoefs ()
 Returns coefficients of a quadratic polynomial fitting pole dec. More...
 
std::vector< AnglepmCoefs ()
 Returns coefficients of a quadratic polynomial fitting pole pm. More...
 
std::vector< double > poleRaNutPrecCoefs ()
 Returns coefficients of pole right ascension nut/prec terms. More...
 
std::vector< double > poleDecNutPrecCoefs ()
 TargetBody::poleDecNutPrecCoefs. More...
 
std::vector< double > pmNutPrecCoefs ()
 Returns coefficients of the prime meridian nut/prec terms. More...
 
std::vector< AnglesysNutPrecConstants ()
 Returns constants of planetary system nut/prec periods. More...
 
std::vector< AnglesysNutPrecCoefs ()
 Returns Linear terms of planetary system nut/prec periods. More...
 
SpiceInt naifBodyCode () const
 This returns the NAIF body code of the target. More...
 
SpiceInt naifPlanetSystemCode () const
 This returns the NAIF body code of the target's planet system. More...
 
QString naifPlanetSystemName () const
 This returns the body name of the target's planet system. More...
 
Distance radiusA () const
 Returns "a" radius. More...
 
Distance radiusB () const
 Returns "b" radius. More...
 
Distance radiusC () const
 Returns the "c" radius. More...
 
Distance meanRadius () const
 Returns the mean radius. More...
 
Distance sigmaRadiusA () const
 Returns "a" radius sigma. More...
 
Distance sigmaRadiusB () const
 Returns "b" radius sigma. More...
 
Distance sigmaRadiusC () const
 Returns the "c" radius sigma. More...
 
Distance sigmaMeanRadius () const
 Returns the mean radius sigma. More...
 

Private Member Functions

 TargetBody (const TargetBody &other)
 
TargetBodyoperator= (const TargetBody &rhs)
 

Private Attributes

TargetQsp m_isisTarget
 
QUuid * m_id
 A unique ID for this TargetBody object (useful for others to reference this object when saving to disk). More...
 
QString m_targetName
 The TargetName as it appears in the original cube. More...
 
SpiceInt * m_bodyCode
 TODO - RETHINK MEMBER VARIABLES AND METHODS The NaifBodyCode value, if it exists in the cube labels. More...
 
SpiceInt * m_systemCode
 The NaifBodyCode system code. More...
 
QString m_systemName
 The NaifBodyCode system name. More...
 
std::vector< Distancem_radii
 target radii More...
 
std::vector< Distancem_sigmaRadii
 target radii sigmas More...
 
TargetBodyDisplayPropertiesm_displayProperties
 The GUI information for how this Target will be displayed. More...
 
int m_frametype
 Fill this in when Debbie or Ken tell me what it is returning. More...
 
std::vector< Anglem_raPole
 Coefficients of a quadratic polynomial fitting pole ra. More...
 
std::vector< Anglem_decPole
 Coefficients of a quadratic polynomial fitting pole dec. More...
 
std::vector< Anglem_pm
 Coefficients of a quadratic polynomial fitting pole pm. More...
 
std::vector< double > m_raNutPrec
 Coefficients of pole right ascension nut/prec terms. More...
 
std::vector< double > m_decNutPrec
 Coefficients of pole decliniation nut/prec terms. More...
 
std::vector< double > m_pmNutPrec
 Coefficients of prime meridian nut/prec terms. More...
 
std::vector< Anglem_sysNutPrec0
 Constants of planetary system nut/prec periods. More...
 
std::vector< Anglem_sysNutPrec1
 Linear terms of planetary system nut/prec periods. More...
 

Detailed Description

Container class for TargetBody.

This class represents a target body in a project-based GUI interface. It encapsulates ideas about a target such as it's display name, how it should be viewed, where it is on disk, etc.

Author
2015-06-08 Ken Edmundson
History:

2015-06-08 Ken Edmundson - Original version.

2015-10-14 Jeffrey Covington - Declared TargetBodyQsp as a Qt metatype for use with QVariant.

2016-06-13 Tyler Wilson - Added new documentation and corrected formatting to be consisten with ISIS3 coding standards. Fixes #3997 and #4018. 2018-07-12 Summer Stapleton - Added m_targetName and targetName() in order to collect the TargetName from the original cube label for comparisons related to image imports in ipce. References #5460.

Definition at line 80 of file TargetBody.h.

Constructor & Destructor Documentation

◆ TargetBody() [1/2]

Isis::TargetBody::TargetBody ( Target target,
QObject parent = 0 
)

◆ ~TargetBody()

Isis::TargetBody::~TargetBody ( )

The second constructor for this class.

Parameters
bundleTargetBodyA QSharedPointer to a BundleTarget object.
parentA pointer to the object instantiating this object. The destructor

Definition at line 141 of file TargetBody.cpp.

References m_bodyCode, m_id, and m_systemCode.

◆ TargetBody() [2/2]

Isis::TargetBody::TargetBody ( const TargetBody other)
private
Author
2015-06-08 Ken Edmundson

Member Function Documentation

◆ displayProperties() [1/2]

TargetBodyDisplayProperties * Isis::TargetBody::displayProperties ( )

Gets TargetBodyDisplayProperties.

Returns
TargetBodyDisplayProperties * A pointer to the display properties for the TargetBody.

Definition at line 195 of file TargetBody.cpp.

References m_displayProperties.

Referenced by Isis::TargetInfoWidget::errorMsg(), and Isis::TargetInfoWidget::TargetInfoWidget().

◆ displayProperties() [2/2]

const TargetBodyDisplayProperties * Isis::TargetBody::displayProperties ( ) const

TargetBody::displayProperties.

Returns
TargetBodyDisplayProperties * A pointer to the display properties for the TargetBody.

Definition at line 205 of file TargetBody.cpp.

References m_displayProperties.

◆ frameType()

int Isis::TargetBody::frameType ( )

◆ id()

QString Isis::TargetBody::id ( ) const

Output format:

<image id="..." filename="..."> ... </image>

(fileName attribute is just the base name) Create an XML Handler (reader) that can populate the BundleSettings class data. See BundleSettings::save() for the expected format.

Parameters
bundleSettingsThe image we're going to be initializing
imageFolderThe folder that contains the Cube Handle an XML start element. This expects <image> and <displayProperties> elements.
Returns
If we should continue reading the XML (usually true). Get a unique, identifying string associated with this TargetBody object.
A unique ID for this TargetBody object.

Definition at line 580 of file TargetBody.cpp.

References m_id.

◆ meanRadius()

Distance Isis::TargetBody::meanRadius ( ) const

Returns the mean radius.

Returns
Distance value of body mean radius.

Definition at line 397 of file TargetBody.cpp.

References m_radii.

Referenced by Isis::TargetInfoWidget::TargetInfoWidget().

◆ naifBodyCode()

SpiceInt Isis::TargetBody::naifBodyCode ( ) const

This returns the NAIF body code of the target.

Returns
SpiceInt NAIF body code

Definition at line 305 of file TargetBody.cpp.

References m_bodyCode.

Referenced by operator==().

◆ naifPlanetSystemCode()

SpiceInt Isis::TargetBody::naifPlanetSystemCode ( ) const

This returns the NAIF body code of the target's planet system.

Returns
SpiceInt NAIF body code of target's planet system.

Definition at line 316 of file TargetBody.cpp.

References m_systemCode.

◆ naifPlanetSystemName()

QString Isis::TargetBody::naifPlanetSystemName ( ) const

This returns the body name of the target's planet system.

Returns
QString The body name of target's planet system.

Definition at line 327 of file TargetBody.cpp.

References m_systemName.

Referenced by Isis::TargetInfoWidget::formatPmString(), Isis::TargetInfoWidget::formatPoleDecString(), Isis::TargetInfoWidget::formatPoleRaString(), and Isis::TargetInfoWidget::TargetInfoWidget().

◆ operator==()

bool Isis::TargetBody::operator== ( const TargetBody src) const

Compares two Target Body objects to see if they are equal.

Parameters
srcTargetBody object to compare against
Returns
bool Returns true if the objects are equal, false if not.

Definition at line 173 of file TargetBody.cpp.

References m_bodyCode, m_radii, naifBodyCode(), radiusA(), radiusB(), and radiusC().

◆ pmCoefs()

std::vector< Angle > Isis::TargetBody::pmCoefs ( )

Returns coefficients of a quadratic polynomial fitting pole pm.

Returns
std::vector<Angle>

Definition at line 250 of file TargetBody.cpp.

References m_pm.

Referenced by Isis::TargetInfoWidget::formatPmString().

◆ pmNutPrecCoefs()

std::vector< double > Isis::TargetBody::pmNutPrecCoefs ( )

Returns coefficients of the prime meridian nut/prec terms.

Returns
std::vector<double>

Definition at line 277 of file TargetBody.cpp.

References m_pmNutPrec.

Referenced by Isis::TargetInfoWidget::formatPmString().

◆ poleDecCoefs()

std::vector< Angle > Isis::TargetBody::poleDecCoefs ( )

Returns coefficients of a quadratic polynomial fitting pole dec.

Returns
std::vector<Angle>

Definition at line 241 of file TargetBody.cpp.

References m_decPole.

Referenced by Isis::TargetInfoWidget::formatPoleDecString().

◆ poleDecNutPrecCoefs()

std::vector< double > Isis::TargetBody::poleDecNutPrecCoefs ( )

TargetBody::poleDecNutPrecCoefs.

Returns
std::vector<double>

Definition at line 268 of file TargetBody.cpp.

References m_decNutPrec.

Referenced by Isis::TargetInfoWidget::formatPoleDecString().

◆ poleRaCoefs()

std::vector< Angle > Isis::TargetBody::poleRaCoefs ( )

TargetBody::poleRaCoefs.

Returns
std::vector<Angle>

Definition at line 232 of file TargetBody.cpp.

References m_raPole.

Referenced by Isis::TargetInfoWidget::formatPoleRaString().

◆ poleRaNutPrecCoefs()

std::vector< double > Isis::TargetBody::poleRaNutPrecCoefs ( )

Returns coefficients of pole right ascension nut/prec terms.

Returns
std::vector<double>

Definition at line 259 of file TargetBody.cpp.

References m_raNutPrec.

Referenced by Isis::TargetInfoWidget::formatPoleRaString().

◆ radiusA()

Distance Isis::TargetBody::radiusA ( ) const

Returns "a" radius.

Returns
Distance The value of body radius "a"

Definition at line 337 of file TargetBody.cpp.

References m_radii.

Referenced by operator==(), and Isis::TargetInfoWidget::TargetInfoWidget().

◆ radiusB()

Distance Isis::TargetBody::radiusB ( ) const

Returns "b" radius.

Returns
Distance value of body radius "b".

Definition at line 357 of file TargetBody.cpp.

References m_radii.

Referenced by operator==(), and Isis::TargetInfoWidget::TargetInfoWidget().

◆ radiusC()

Distance Isis::TargetBody::radiusC ( ) const

Returns the "c" radius.

Returns
Distance value of body radius "c".

Definition at line 377 of file TargetBody.cpp.

References m_radii.

Referenced by operator==(), and Isis::TargetInfoWidget::TargetInfoWidget().

◆ sigmaMeanRadius()

Distance Isis::TargetBody::sigmaMeanRadius ( ) const

Returns the mean radius sigma.

Returns
Distance value of body mean radius

Definition at line 411 of file TargetBody.cpp.

References m_sigmaRadii.

◆ sigmaRadiusA()

Distance Isis::TargetBody::sigmaRadiusA ( ) const

Returns "a" radius sigma.

Returns
Distance value of body radius "a" sigma

Definition at line 347 of file TargetBody.cpp.

References m_sigmaRadii.

◆ sigmaRadiusB()

Distance Isis::TargetBody::sigmaRadiusB ( ) const

Returns "b" radius sigma.

Returns
Distance The value of body radius "b" sigma.

Definition at line 367 of file TargetBody.cpp.

References m_sigmaRadii.

◆ sigmaRadiusC()

Distance Isis::TargetBody::sigmaRadiusC ( ) const

Returns the "c" radius sigma.

Returns
Distance value of body radius "c" sigma

Definition at line 387 of file TargetBody.cpp.

References m_sigmaRadii.

◆ sysNutPrecCoefs()

std::vector< Angle > Isis::TargetBody::sysNutPrecCoefs ( )

Returns Linear terms of planetary system nut/prec periods.

Returns
std::vector<Angle>

Definition at line 294 of file TargetBody.cpp.

References m_sysNutPrec1.

◆ sysNutPrecConstants()

std::vector< Angle > Isis::TargetBody::sysNutPrecConstants ( )

Returns constants of planetary system nut/prec periods.

Returns
std::vector<Angle>

Definition at line 286 of file TargetBody.cpp.

References m_sysNutPrec0.

◆ targetName()

QString Isis::TargetBody::targetName ( )

Returns the value stored at TargetName in the original pvl label.

Returns
QString Returns m_targetName

Definition at line 214 of file TargetBody.cpp.

References m_targetName.

Member Data Documentation

◆ m_bodyCode

SpiceInt* Isis::TargetBody::m_bodyCode
private

TODO - RETHINK MEMBER VARIABLES AND METHODS The NaifBodyCode value, if it exists in the cube labels.

Otherwise, if the target is sky, it's the SPK code and if not sky then it's calculated by the NaifBodyCode() method.

Definition at line 185 of file TargetBody.h.

Referenced by naifBodyCode(), operator==(), TargetBody(), and ~TargetBody().

◆ m_decNutPrec

std::vector<double> Isis::TargetBody::m_decNutPrec
private

Coefficients of pole decliniation nut/prec terms.

Definition at line 223 of file TargetBody.h.

Referenced by poleDecNutPrecCoefs(), and TargetBody().

◆ m_decPole

std::vector<Angle> Isis::TargetBody::m_decPole
private

Coefficients of a quadratic polynomial fitting pole dec.

Definition at line 216 of file TargetBody.h.

Referenced by poleDecCoefs(), and TargetBody().

◆ m_displayProperties

TargetBodyDisplayProperties* Isis::TargetBody::m_displayProperties
private

The GUI information for how this Target will be displayed.

Definition at line 210 of file TargetBody.h.

Referenced by displayProperties(), and TargetBody().

◆ m_frametype

int Isis::TargetBody::m_frametype
private

Fill this in when Debbie or Ken tell me what it is returning.

Definition at line 212 of file TargetBody.h.

Referenced by frameType(), and TargetBody().

◆ m_id

QUuid* Isis::TargetBody::m_id
private

A unique ID for this TargetBody object (useful for others to reference this object when saving to disk).

Definition at line 173 of file TargetBody.h.

Referenced by id(), TargetBody(), and ~TargetBody().

◆ m_pm

std::vector<Angle> Isis::TargetBody::m_pm
private

Coefficients of a quadratic polynomial fitting pole pm.

Definition at line 217 of file TargetBody.h.

Referenced by pmCoefs(), and TargetBody().

◆ m_pmNutPrec

std::vector<double> Isis::TargetBody::m_pmNutPrec
private

Coefficients of prime meridian nut/prec terms.

Definition at line 224 of file TargetBody.h.

Referenced by pmNutPrecCoefs(), and TargetBody().

◆ m_radii

std::vector<Distance> Isis::TargetBody::m_radii
private

target radii

Definition at line 200 of file TargetBody.h.

Referenced by meanRadius(), operator==(), radiusA(), radiusB(), radiusC(), and TargetBody().

◆ m_raNutPrec

std::vector<double> Isis::TargetBody::m_raNutPrec
private

Coefficients of pole right ascension nut/prec terms.

Definition at line 222 of file TargetBody.h.

Referenced by poleRaNutPrecCoefs(), and TargetBody().

◆ m_raPole

std::vector<Angle> Isis::TargetBody::m_raPole
private

Coefficients of a quadratic polynomial fitting pole ra.

Definition at line 215 of file TargetBody.h.

Referenced by poleRaCoefs(), and TargetBody().

◆ m_sigmaRadii

std::vector<Distance> Isis::TargetBody::m_sigmaRadii
private

target radii sigmas

Definition at line 205 of file TargetBody.h.

Referenced by sigmaMeanRadius(), sigmaRadiusA(), sigmaRadiusB(), sigmaRadiusC(), and TargetBody().

◆ m_sysNutPrec0

std::vector<Angle> Isis::TargetBody::m_sysNutPrec0
private

Constants of planetary system nut/prec periods.

Definition at line 227 of file TargetBody.h.

Referenced by sysNutPrecConstants(), and TargetBody().

◆ m_sysNutPrec1

std::vector<Angle> Isis::TargetBody::m_sysNutPrec1
private

Linear terms of planetary system nut/prec periods.

Definition at line 228 of file TargetBody.h.

Referenced by sysNutPrecCoefs(), and TargetBody().

◆ m_systemCode

SpiceInt* Isis::TargetBody::m_systemCode
private

The NaifBodyCode system code.

If the target is sky, this is -1.

Definition at line 190 of file TargetBody.h.

Referenced by naifPlanetSystemCode(), TargetBody(), and ~TargetBody().

◆ m_systemName

QString Isis::TargetBody::m_systemName
private

The NaifBodyCode system name.

Definition at line 195 of file TargetBody.h.

Referenced by naifPlanetSystemName(), and TargetBody().

◆ m_targetName

QString Isis::TargetBody::m_targetName
private

The TargetName as it appears in the original cube.

Definition at line 178 of file TargetBody.h.

Referenced by TargetBody(), and targetName().


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