SOSM_CoreBase Class Reference

#include <SOSM_CoreBase.hpp>

Inheritance diagram for SOSM_CoreBase:

Collaboration diagram for SOSM_CoreBase:

Public Member Functions
	SOSM_CoreBase ()
	SOSM_CoreBase (const SOSM_CoreBase &aSrc)
	~SOSM_CoreBase () override
SOSM_CoreBase &	operator= (const SOSM_CoreBase &)=delete
std::string	GetTypeName () const
	Return the user-specified type name of the object.
void	SetTypeName (const std::string &aTypeName)
	Set the user-specified type name of the object.
double	GetModificationTime () const
	Return when the source file from which the object was recreated was last modified.
void	SetModificationTime (double aModificationTime)
	Set the last modification time of the object.
void	UpdateModificationTime (double aModificationTime)
std::string	GetCachePrefix () const
	Return the name of the cache prefix for this object.
void	SetCachePrefix (const std::string &aCachePrefix)
	Set the cache prefix (subdirectory) to be used for creating cache files of this object.
virtual bool	Initialize ()
virtual void	InputComplete ()
virtual bool	ProcessInput (UtInput &aInput)
Public Member Functions inherited from SOSM_SpectralObject
	SOSM_SpectralObject ()
	SOSM_SpectralObject (float aOrigin, float aIncrement, int aCount)
virtual	~SOSM_SpectralObject ()
float	Origin () const
	Return the origin (wavenumber, cm-1) of the first sample point.
float	Increment () const
int	Count () const
void	DefineSpectralLimits (float aOrigin, float aIncrement, int aCount)
void	DefineSpectralLimits (const SOSM_SpectralObject &aSource)
bool	Equals (const SOSM_SpectralObject &aRhs) const
	Do this object and another object have the same spectral limits?
Status	Union (const SOSM_SpectralObject &aObject)
Status	Union (const SOSM_SpectralObject &aObject1, const SOSM_SpectralObject &aObject2)
float	LowerWavelength () const
float	UpperWavelength () const
void	SetWavelengthLimits (float aLowerWavelength, float aUpperWavelength)

Protected Attributes
double	mModificationTime
	When the file was last modified.
std::string	mTypeName
	The type name of the object.
std::string	mCachePrefix

Additional Inherited Members
Public Types inherited from SOSM_SpectralObject
enum	Status { cOK = 0 , cINCOMPATIBLE_INCREMENTS , cINCOMPATIBLE_ORIGINS }
	Return value from 'UnionOf'. More...
Static Public Member Functions inherited from SOSM_SpectralObject
static std::string	StatusString (Status aStatus)

Detailed Description

The base class for the 'core' objects (sensor, target, atmosphere). It defines the interface for processing input and initializing the core objects.

Constructor & Destructor Documentation

SOSM_CoreBase() [1/2]

SOSM_CoreBase::SOSM_CoreBase

(

)

References mCachePrefix, mModificationTime, mTypeName, and SOSM_SpectralObject::SOSM_SpectralObject().

Referenced by operator=(), SOSM_Atmosphere::SOSM_Atmosphere(), SOSM_Atmosphere::SOSM_Atmosphere(), SOSM_CoreBase(), SOSM_Sensor::SOSM_Sensor(), SOSM_Sensor::SOSM_Sensor(), SOSM_Target::SOSM_Target(), and SOSM_Target::SOSM_Target().

SOSM_CoreBase() [2/2]

SOSM_CoreBase::SOSM_CoreBase

(

const SOSM_CoreBase &

aSrc

)

References mCachePrefix, mModificationTime, mTypeName, SOSM_CoreBase(), and SOSM_SpectralObject::SOSM_SpectralObject().

~SOSM_CoreBase()

SOSM_CoreBase::~SOSM_CoreBase ( )

override

Member Function Documentation

GetCachePrefix()

std::string SOSM_CoreBase::GetCachePrefix

(

)

const

Return the name of the cache prefix for this object.

References mCachePrefix, and mTypeName.

Referenced by SOSM_SimpleTarget::ST_State::ProcessInput(), SOSM_TableAtmosphere::ProcessInput(), and SOSM_TableTarget::Band::ProcessInput().

GetModificationTime()

double SOSM_CoreBase::GetModificationTime ( ) const

inline

Return when the source file from which the object was recreated was last modified.

References mModificationTime.

GetTypeName()

std::string SOSM_CoreBase::GetTypeName ( ) const

inline

Return the user-specified type name of the object.

References mTypeName.

Referenced by SOSM_SimpleTarget::GetSampleTargetState(), WsfSOSM_Sensor::SOSM_Mode::Initialize(), SOSM_TableAtmosphere::InputComplete(), and SOSM_Manager::LoadType().

Initialize()

bool SOSM_CoreBase::Initialize ( )

virtual

Reimplemented in SOSM_Sensor, and SOSM_Target.

Referenced by SOSM_Manager::AllocateAtmosphere().

InputComplete()

void SOSM_CoreBase::InputComplete ( )

virtual

Reimplemented in SOSM_Sensor, SOSM_TableAtmosphere, SOSM_TableTarget, and SOSM_Target.

Referenced by SOSM_Manager::LoadType().

operator=()

SOSM_CoreBase & SOSM_CoreBase::operator= ( const SOSM_CoreBase & )

delete

References SOSM_CoreBase().

ProcessInput()

bool SOSM_CoreBase::ProcessInput ( UtInput & aInput )

virtual

Reimplemented in SOSM_Sensor, SOSM_SimpleAtmosphere, SOSM_TableAtmosphere, and SOSM_Target.

References mCachePrefix.

Referenced by SOSM_Manager::LoadType(), SOSM_SimpleAtmosphere::ProcessInput(), and SOSM_TableAtmosphere::ProcessInput().

SetCachePrefix()

void SOSM_CoreBase::SetCachePrefix ( const std::string & aCachePrefix )

inline

Set the cache prefix (subdirectory) to be used for creating cache files of this object.

References mCachePrefix.

Referenced by SOSM_Manager::LoadAtmosphereType(), SOSM_Manager::LoadSensorType(), and SOSM_Manager::LoadTargetType().

SetModificationTime()

void SOSM_CoreBase::SetModificationTime ( double aModificationTime )

inline

Set the last modification time of the object.

References mModificationTime.

SetTypeName()

void SOSM_CoreBase::SetTypeName ( const std::string & aTypeName )

inline

Set the user-specified type name of the object.

References mTypeName.

Referenced by SOSM_Manager::LoadAtmosphereType(), SOSM_Manager::LoadSensorType(), and SOSM_Manager::LoadTargetType().

UpdateModificationTime()

void SOSM_CoreBase::UpdateModificationTime

(

double

aModificationTime

)

References mModificationTime.

Referenced by SOSM_Manager::LoadAtmosphereType(), SOSM_Manager::LoadSensorType(), SOSM_Manager::LoadTargetType(), and SOSM_TableAtmosphere::ProcessInput().

Member Data Documentation

mCachePrefix

std::string SOSM_CoreBase::mCachePrefix

protected

The 'cache prefix' to be used for cache files created for this object. This is basically the name of the first level subdirectory name within the cache.

Referenced by GetCachePrefix(), ProcessInput(), SetCachePrefix(), SOSM_CoreBase(), and SOSM_CoreBase().

mModificationTime

double SOSM_CoreBase::mModificationTime

protected

When the file was last modified.

Referenced by GetModificationTime(), SetModificationTime(), SOSM_CoreBase(), SOSM_CoreBase(), and UpdateModificationTime().

mTypeName

std::string SOSM_CoreBase::mTypeName

protected

The type name of the object.

Referenced by GetCachePrefix(), GetTypeName(), SetTypeName(), SOSM_CoreBase(), and SOSM_CoreBase().

---

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

• SOSM_CoreBase.hpp
• SOSM_CoreBase.cpp