#include <TargetBody.h>

Inheritance diagram for Isis::TargetBody:

Collaboration diagram for Isis::TargetBody:

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...

TargetBodyDisplayProperties *	displayProperties ()
	Gets TargetBodyDisplayProperties. More...

const TargetBodyDisplayProperties *	displayProperties () const
	TargetBody::displayProperties. More...

QString	id () const
	Output format: More...

int	frameType ()
	Returns the frame type. More...

std::vector< Angle >	poleRaCoefs ()
	TargetBody::poleRaCoefs. More...

std::vector< Angle >	poleDecCoefs ()
	Returns coefficients of a quadratic polynomial fitting pole dec. More...

std::vector< Angle >	pmCoefs ()
	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< Angle >	sysNutPrecConstants ()
	Returns constants of planetary system nut/prec periods. More...

std::vector< Angle >	sysNutPrecCoefs ()
	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)

TargetBody &	operator= (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...

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< Distance >	m_radii
	target radii More...

std::vector< Distance >	m_sigmaRadii
	target radii sigmas More...

TargetBodyDisplayProperties *	m_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< Angle >	m_raPole
	Coefficients of a quadratic polynomial fitting pole ra. More...

std::vector< Angle >	m_decPole
	Coefficients of a quadratic polynomial fitting pole dec. More...

std::vector< Angle >	m_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< Angle >	m_sysNutPrec0
	Constants of planetary system nut/prec periods. More...

std::vector< Angle >	m_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.

Definition at line 77 of file TargetBody.h.

Constructor & Destructor Documentation

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

The first constructor for this class.

Parameters

target	A traditional: Isis::Target object.
parent	A pointer to the object instantiating this object.

Definition at line 27 of file TargetBody.cpp.

References Isis::Distance::Kilometers, m_bodyCode, m_decNutPrec, m_decPole, m_displayProperties, m_frametype, m_id, m_pm, m_pmNutPrec, m_radii, m_raNutPrec, m_raPole, m_sigmaRadii, m_sysNutPrec0, m_sysNutPrec1, m_systemCode, m_systemName, Isis::Target::naifBodyCode(), Isis::Target::naifPlanetSystemCode(), Isis::Target::name(), Isis::Target::radii(), and Isis::Target::systemName().

Isis::TargetBody::~TargetBody ( )

The second constructor for this class.

Parameters

bundleTargetBody	A QSharedPointer to a BundleTarget object.
parent	A pointer to the object instantiating this object. The destructor

Definition at line 143 of file TargetBody.cpp.

References m_bodyCode, m_id, and m_systemCode.

Isis::TargetBody::TargetBody ( const TargetBody & other )

private

Author: 2015-06-08 Ken Edmundson

Member Function Documentation

TargetBodyDisplayProperties * Isis::TargetBody::displayProperties ( )

Gets TargetBodyDisplayProperties.

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

Definition at line 197 of file TargetBody.cpp.

References m_displayProperties.

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

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

TargetBody::displayProperties.

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

Definition at line 207 of file TargetBody.cpp.

References m_displayProperties.

int Isis::TargetBody::frameType ( )

Returns the frame type.

Returns

Definition at line 230 of file TargetBody.cpp.

References m_frametype.

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

QString Isis::TargetBody::id ( ) const

Output format:

(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

bundleSettings	The image we're going to be initializing
imageFolder	The 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 587 of file TargetBody.cpp.

References m_id.

Distance Isis::TargetBody::meanRadius ( ) const

Returns the mean radius.

Returns: Distance value of body mean radius.

Definition at line 404 of file TargetBody.cpp.

References m_radii.

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

SpiceInt Isis::TargetBody::naifBodyCode ( ) const

This returns the NAIF body code of the target.

Returns: SpiceInt NAIF body code

Definition at line 312 of file TargetBody.cpp.

References m_bodyCode.

Referenced by operator==().

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 323 of file TargetBody.cpp.

References m_systemCode.

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 334 of file TargetBody.cpp.

References m_systemName.

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

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

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

Parameters

src	TargetBody object to compare against

Returns: bool Returns true if the objects are equal, false if not.

Definition at line 175 of file TargetBody.cpp.

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

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

Returns coefficients of a quadratic polynomial fitting pole pm.

Returns: std::vector<Angle>

Definition at line 257 of file TargetBody.cpp.

References m_pm.

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

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

Returns coefficients of the prime meridian nut/prec terms.

Returns: std::vector<double>

Definition at line 284 of file TargetBody.cpp.

References m_pmNutPrec.

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

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

Returns coefficients of a quadratic polynomial fitting pole dec.

Returns: std::vector<Angle>

Definition at line 248 of file TargetBody.cpp.

References m_decPole.

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

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

TargetBody::poleDecNutPrecCoefs.

Returns: std::vector<double>

Definition at line 275 of file TargetBody.cpp.

References m_decNutPrec.

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

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

TargetBody::poleRaCoefs.

Returns: std::vector<Angle>

Definition at line 239 of file TargetBody.cpp.

References m_raPole.

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

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

Returns coefficients of pole right ascension nut/prec terms.

Returns: std::vector<double>

Definition at line 266 of file TargetBody.cpp.

References m_raNutPrec.

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

Distance Isis::TargetBody::radiusA ( ) const

Returns "a" radius.

Returns: Distance The value of body radius "a"

Definition at line 344 of file TargetBody.cpp.

References m_radii.

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

Distance Isis::TargetBody::radiusB ( ) const

Returns "b" radius.

Returns: Distance value of body radius "b".

Definition at line 364 of file TargetBody.cpp.

References m_radii.

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

Distance Isis::TargetBody::radiusC ( ) const

Returns the "c" radius.

Returns: Distance value of body radius "c".

Definition at line 384 of file TargetBody.cpp.

References m_radii.

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

Distance Isis::TargetBody::sigmaMeanRadius ( ) const

Returns the mean radius sigma.

Returns: Distance value of body mean radius

Definition at line 418 of file TargetBody.cpp.

References m_sigmaRadii.

Distance Isis::TargetBody::sigmaRadiusA ( ) const

Returns "a" radius sigma.

Returns: Distance value of body radius "a" sigma

Definition at line 354 of file TargetBody.cpp.

References m_sigmaRadii.

Distance Isis::TargetBody::sigmaRadiusB ( ) const

Returns "b" radius sigma.

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

Definition at line 374 of file TargetBody.cpp.

References m_sigmaRadii.

Distance Isis::TargetBody::sigmaRadiusC ( ) const

Returns the "c" radius sigma.

Returns: Distance value of body radius "c" sigma

Definition at line 394 of file TargetBody.cpp.

References m_sigmaRadii.

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

Returns Linear terms of planetary system nut/prec periods.

Returns: std::vector<Angle>

Definition at line 301 of file TargetBody.cpp.

References m_sysNutPrec1.

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

Returns constants of planetary system nut/prec periods.

Returns: std::vector<Angle>

Definition at line 293 of file TargetBody.cpp.

References m_sysNutPrec0.

Member Data Documentation

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 178 of file TargetBody.h.

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

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

private

Coefficients of pole decliniation nut/prec terms.

Definition at line 216 of file TargetBody.h.

Referenced by poleDecNutPrecCoefs(), and TargetBody().

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

private

Coefficients of a quadratic polynomial fitting pole dec.

Definition at line 209 of file TargetBody.h.

Referenced by poleDecCoefs(), and TargetBody().

TargetBodyDisplayProperties* Isis::TargetBody::m_displayProperties

private

The GUI information for how this Target will be displayed.

Definition at line 203 of file TargetBody.h.

Referenced by displayProperties(), and TargetBody().

int Isis::TargetBody::m_frametype

private

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

Definition at line 205 of file TargetBody.h.

Referenced by frameType(), and TargetBody().

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 171 of file TargetBody.h.

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

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

private

Coefficients of a quadratic polynomial fitting pole pm.

Definition at line 210 of file TargetBody.h.

Referenced by pmCoefs(), and TargetBody().

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

private

Coefficients of prime meridian nut/prec terms.

Definition at line 217 of file TargetBody.h.

Referenced by pmNutPrecCoefs(), and TargetBody().

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

private

target radii

Definition at line 193 of file TargetBody.h.

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

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

private

Coefficients of pole right ascension nut/prec terms.

Definition at line 215 of file TargetBody.h.

Referenced by poleRaNutPrecCoefs(), and TargetBody().

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

private

Coefficients of a quadratic polynomial fitting pole ra.

Definition at line 208 of file TargetBody.h.

Referenced by poleRaCoefs(), and TargetBody().

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

private

target radii sigmas

Definition at line 198 of file TargetBody.h.

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

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

private

Constants of planetary system nut/prec periods.

Definition at line 220 of file TargetBody.h.

Referenced by sysNutPrecConstants(), and TargetBody().

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

private

Linear terms of planetary system nut/prec periods.

Definition at line 221 of file TargetBody.h.

Referenced by sysNutPrecCoefs(), and TargetBody().

SpiceInt* Isis::TargetBody::m_systemCode

private

The NaifBodyCode system code.

If the target is sky, this is -1.

Definition at line 183 of file TargetBody.h.

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

QString Isis::TargetBody::m_systemName

private

The NaifBodyCode system name.

Definition at line 188 of file TargetBody.h.

Referenced by naifPlanetSystemName(), and TargetBody().

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

src/qisis/objs/TargetBody/TargetBody.h
src/qisis/objs/TargetBody/TargetBody.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation