#include <WsfThermalSystem.hpp>

Inheritance diagram for WsfThermalSystem:

[legend]

Collaboration diagram for WsfThermalSystem:

[legend]

Public Member Functions
	WsfThermalSystem (const WsfScenario &aScenario)
	WsfThermalSystem (const WsfThermalSystem &aSrc)
WsfThermalSystem &	operator= (const WsfThermalSystem &)=delete
	~WsfThermalSystem () override
WsfObject *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
bool	Initialize (double aSimTime) override
WsfComponent *	CloneComponent () const override
const int *	GetComponentRoles () const override
void *	QueryInterface (int aRole) override
double	GetUpdateInterval () const override
void	SetUpdateInterval (double aUpdateInterval) override
virtual double	TransferHeat (double aSimTime, double aHeatTransfer)
	Given heat transfer to the system, return the new temperature.
bool	IsValid () const
	Return whether the system is "valid", i.e., is being utilized.
bool	IsSimple () const
	Return whether we are configuring this system with "simple" inputs.
double	GetTemperature () const
void	SetTemperature (double aTemperature)
double	GetHeatSink () const
void	PrintInfo (double aLowTemp, double aHighTemp) const
double	GetRequiredHeatForTemperature (double aTemperature) const
double	GetEnergy (double aLowTemp, double aHighTemp) const
void	SetPowerDissipated (double aPowerDissipated)
void	SetLowTemperature (double aLowTemperature)
double	GetLowTemperature () const
void	SetHighTemperature (double aHighTemperature)
double	GetHighTemperature () const
Public Member Functions inherited from WsfPlatformPart
	WsfPlatformPart (const WsfScenario &aScenario, int aPartType)
WsfPlatformPart &	operator= (const WsfPlatformPart &aRhs)=delete
	~WsfPlatformPart () override
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
unsigned int	GetDebugMask ()
bool	IsExternallyControlled () const
virtual void	SetExternallyControlled (double aSimTime, bool aIsExternallyControlled)
int	GetPartType () const
const char *	GetScriptClassName () const override
WsfSimulation *	GetSimulation () const
const WsfScenario &	GetScenario () const
WsfStringId	GetComponentName () const override
void	ComponentParentChanged (WsfPlatform *aPlatformPtr) override
bool	Initialize2 (double aSimTime) override
virtual void	Update (double aSimTime)
WsfPlatform *	GetPlatform () const
virtual void	SetPlatform (WsfPlatform *aPlatformPtr)
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
virtual void	PlatformDeleted (WsfPlatform *aPlatformPtr)
double	GetLastStatusChangeTime () const
void	SetLastStatusChangeTime (double aSimTime)
	Allows a system to set the time at which the device was initialized.
bool	CanBeMadeOperational () const
	Returns an indication that this system can be made operational.
bool	CanBeMadeNonOperational () const
	Returns an indication that this system can be made non-operational.
bool	CanBeTurnedOn () const
	Returns an indication that this system can be turned on.
bool	CanBeTurnedOff () const
	Returns an indication that this system can be turned off.
bool	IsTurnedOn () const
bool	InitiallyTurnedOn () const
	Is the system to be turned 'on' when added to the simulation?
void	SetInitiallyTurnedOn (bool aInitiallyTurnedOn)
	Sets if the system is turned on when added to the simulation.
virtual void	TurnOff (double aSimTime)
virtual void	TurnOn (double aSimTime)
virtual void	SetOperational (double aSimTime)
virtual void	SetNonOperational (double aSimTime)
virtual void	PartBroken (double aSimTime)
virtual void	Restore (double aSimTime)
bool	IsOperational () const
bool	SetOperational (double aSimTime, bool aMakeOperational)
double	GetDamageFactor () const
bool	SetDamageFactor (double aSimTime, double aDamageFactor)
bool	IsCritical () const
void	SetCritical (bool aValue)
virtual void	OnPlatformBrokenEvent (double aSimTime)
	Owning platform has issued a broken event.
bool	IsBroken () const
WsfInternalLinks &	GetInternalLinks ()
	Return the internal links for this part.
virtual bool	HasInternalLinks () const
	Does this platform part have a communication link to other platform parts?
virtual bool	ProcessMessage (double aSimTime, const WsfMessage &aMessage)
virtual bool	ReceiveMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessage (double aSimTime, const WsfMessage &aMessage)
virtual void	SendMessageTo (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
void	SendMessageToProcessor (double aSimTime, const WsfMessage &aMessage, WsfStringId aRecipientId)
virtual void	SendQueuedMessages (double aSimTime)
const WsfCategoryList &	GetCategories () const
	Get the categories to which this part belongs.
void	AddCategory (WsfStringId aCategoryId)
	Adds the provided category to the platform part's category list.
bool	IsCategoryMember (WsfStringId aCategoryId) const
const WsfGroupList &	GetGroups () const
	Get the groups to which this platform part belongs.
void	JoinGroup (WsfGroup *aGroupPtr)
	Join the given group.
void	LeaveGroup (WsfGroup *aGroupPtr)
	Leave the given group.
bool	IsGroupMember (WsfStringId aGroupId)
unsigned int	GetUpdateEventEpoch () const
void	IncrementUpdateEventEpoch ()
bool	UpdateEventActive () const
	Is an 'Update' event active?
void	SetUpdateEventActive (bool aUpdateEventActive)
	Indicate if the 'Update' event is active.
Public Member Functions inherited from WsfObject
	WsfObject ()
	This is the constructor for the WsfObject class.
	~WsfObject () override
	This is the destructor for the WsfObject class.
const char *	GetScriptClassName () const override
const std::string &	GetType () const
WsfStringId	GetTypeId () const
	Get the string ID of the 'type' of the object.
void	SetType (WsfStringId aType)
const std::string &	GetBaseType () const
WsfStringId	GetBaseTypeId () const
const TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (const WsfObject &aRhs)
	Assignment operator.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)
Public Member Functions inherited from WsfComponentT< WsfPlatform >
	WsfComponentT ()
	WsfComponentT (const WsfComponentT &) noexcept
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual bool	PreInitialize (double aSimTime)
virtual void	PreInput ()
Public Member Functions inherited from WsfUniqueId
	WsfUniqueId ()
	Construtor initializes the unique identifier to 0.
	WsfUniqueId (const WsfUniqueId &)
	Copy constructor initializes the unique identifier to 0.
WsfUniqueId &	operator= (const WsfUniqueId &)
unsigned int	GetUniqueId () const
	Get the unique identifier assigned to this object.
template<typename T>
void	Serialize (T &aBuff)
	For XIO (de)serialization.
Public Member Functions inherited from WsfAuxDataEnabled
	WsfAuxDataEnabled ()=default
	WsfAuxDataEnabled (const WsfAuxDataEnabled &aSrc)=default
WsfAuxDataEnabled &	operator= (const WsfAuxDataEnabled &aRhs)
	WsfAuxDataEnabled (WsfAuxDataEnabled &&)=default
WsfAuxDataEnabled &	operator= (WsfAuxDataEnabled &&)=default
virtual	~WsfAuxDataEnabled () noexcept
void	SetAuxData (const WsfAttributeContainer &aAuxData)
void	DeleteAuxData ()
	Delete the aux data container from the object.
void	MergeAuxData (const WsfAuxDataEnabled &aSrc)
	Merge the object's aux data with aux data from an existing object.
void	UpdateAuxData (const WsfAuxDataEnabled &aSrc)
	Update the object's aux data with aux data from an existing object.
bool	HasAuxData () const
	Returns true if this object has aux data.
bool	ProcessInput (UtInput &aInput)
template<typename T>
void	Serialize (T &aBuff)
	(De)serialization for XIO
WsfAttributeContainer &	GetAuxData ()
const WsfAttributeContainer &	GetAuxData () const noexcept
const WsfAttributeContainer &	GetAuxDataConst () const noexcept

Additional Inherited Members
Public Types inherited from WsfPlatformPart
enum	{ cLEVEL_ONE_DEBUG = 0x00000001 , cLEVEL_TWO_DEBUG = 0x00000002 }
using	InternalMessageQueue = std::queue<WsfMessage*>
using	RecipientMessageQueue = std::queue<std::pair<WsfPlatformPart, WsfMessage>>
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Public Types inherited from WsfComponentT< WsfPlatform >
typedef WsfPlatform	ParentType
	This is needed to support the WsfComponentList template.
Static Public Attributes inherited from WsfAuxDataEnabled
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataAccessed
static UtCallbackListN< void(const WsfAuxDataEnabled *)>	AuxDataDestroyed
	WsfPlatformPart (const WsfPlatformPart &aSrc)
	Copy constructor (for Clone()).
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Member Functions inherited from WsfUniqueId
void	AssignUniqueId (WsfSimulation *aSimulationPtr)

Detailed Description

The thermal system is comprised of various thermal components. Heat is transferred to these components, and a basic caliorimetric calculation is performed to determine the change in temperature of the system. This is a very simple representation, in that it is one dimensional and time-independent, So we are not worried about time-dependent heat transfer, only the transfer itself (we assume the transfer "works" on the timescales in which we are interested).

Constructor & Destructor Documentation

◆ WsfThermalSystem() [1/2]

WsfThermalSystem::WsfThermalSystem ( const WsfScenario & aScenario )

References WsfPlatformPart::WsfPlatformPart(), and WsfThermalSystem().

Referenced by Clone(), CloneComponent(), operator=(), WsfThermalSystem(), and WsfThermalSystem().

◆ WsfThermalSystem() [2/2]

WsfThermalSystem::WsfThermalSystem ( const WsfThermalSystem & aSrc )

References WsfPlatformPart::WsfPlatformPart(), and WsfThermalSystem().

◆ ~WsfThermalSystem()

WsfThermalSystem::~WsfThermalSystem ( )

override

Member Function Documentation

◆ Clone()

WsfObject * WsfThermalSystem::Clone ( ) const

inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References WsfObject::WsfObject(), and WsfThermalSystem().

◆ CloneComponent()

WsfComponent * WsfThermalSystem::CloneComponent ( ) const

inlineoverridevirtual

Clones a component. May return null if component does not support clone.

Implements WsfComponent.

References WsfThermalSystem().

◆ GetComponentRoles()

const int * WsfThermalSystem::GetComponentRoles ( ) const

overridevirtual

Returns a zero-terminated array of component roles. Note that the array should be in decreasing order of specificity and should generally the inheritance hierarchy. The first entry should be the components 'primary' role. For example a sensor would do the following:

static const int roles[] = { cWSF_COMPONENT_SENSOR, cWSF_COMPONENT_ARTICULATED_PART,
                             cWSF_COMPONENT_PLATFORM_PART, 0 };
return roles;

Reimplemented from WsfPlatformPart.

References cWSF_COMPONENT_NULL, cWSF_COMPONENT_PLATFORM_PART, and cWSF_COMPONENT_THERMAL_SYSTEM.

◆ GetEnergy()

double WsfThermalSystem::GetEnergy	(	double	aLowTemp,
		double	aHighTemp ) const

Compute the total energy required to bring the system from one temperature to the other.

Returns: The heat capacity in joules of the system. public

References WsfThermalSystemComponent::GetEnergy().

◆ GetHeatSink()

double WsfThermalSystem::GetHeatSink ( ) const

inline

◆ GetHighTemperature()

double WsfThermalSystem::GetHighTemperature ( ) const

inline

◆ GetLowTemperature()

double WsfThermalSystem::GetLowTemperature ( ) const

inline

◆ GetRequiredHeatForTemperature()

double WsfThermalSystem::GetRequiredHeatForTemperature ( double aTemperature ) const

◆ GetTemperature()

double WsfThermalSystem::GetTemperature ( ) const

inline

Referenced by TransferHeat().

◆ GetUpdateInterval()

double WsfThermalSystem::GetUpdateInterval ( ) const

inlineoverridevirtual

Get interval at which Update() is called. This value is set by calling WsfSimulation::GetInstance().SetProcessorUpdateInterval();

Implements WsfPlatformPart.

◆ Initialize()

bool WsfThermalSystem::Initialize ( double aSimTime )

overridevirtual

Perform phase 1 initialization of the part. This is invoked by WsfPlatform::Initialize() during phase 1 initialization of the platform. During phase 1 initialization, platform components must not assume the existence of ANY data that is the responsibility of another platform component. In particular, the platform location and initial tracks cannot be assumed to be valid.

Parameters

aSimTime The current simulation time.

Returns: 'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfPlatformPart.

References WsfPlatformPart::Initialize(), and ok.

◆ IsSimple()

bool WsfThermalSystem::IsSimple ( ) const

inline

Return whether we are configuring this system with "simple" inputs.

◆ IsValid()

bool WsfThermalSystem::IsValid ( ) const

inline

Return whether the system is "valid", i.e., is being utilized.

◆ operator=()

WsfThermalSystem & WsfThermalSystem::operator= ( const WsfThermalSystem & )

delete

References WsfThermalSystem().

◆ PrintInfo()

void WsfThermalSystem::PrintInfo	(	double	aLowTemp,
		double	aHighTemp ) const

References WsfThermalSystemComponent::PrintInfo().

◆ ProcessInput()

bool WsfThermalSystem::ProcessInput ( UtInput & aInput )

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfPlatformPart.

References WsfObjectTypeList< T >::Add(), WsfScenario::FromInput(), WsfThermalSystemComponent::GetSpecificHeatCapacity(), WsfScenario::GetThermalSystemComponentTypes(), WsfObject::GetType(), WsfThermalSystemComponent::ProcessInput(), and WsfObject::SetType().

◆ QueryInterface()

void * WsfThermalSystem::QueryInterface ( int aRole )

inlineoverridevirtual

Requests a component's role interface. A component can support one or more roles.

Parameters

aRole The role whose interface is to be returned.

Returns: A pointer to the object if it supports the indicated role, or 'null' if it does not. Usage: WsfProcessor* procPtrOrNull = (WsfProcessor*)componentPtr->QueryComponentInterface(cWSF_COMPONENT_PROCESSOR);

Reimplemented from WsfPlatformPart.

References cWSF_COMPONENT_PLATFORM_PART, cWSF_COMPONENT_THERMAL_SYSTEM, and WsfPlatformPart::WsfPlatformPart().

◆ SetHighTemperature()

void WsfThermalSystem::SetHighTemperature ( double aHighTemperature )

inline

◆ SetLowTemperature()

void WsfThermalSystem::SetLowTemperature ( double aLowTemperature )

inline

◆ SetPowerDissipated()

void WsfThermalSystem::SetPowerDissipated ( double aPowerDissipated )

inline

◆ SetTemperature()

void WsfThermalSystem::SetTemperature ( double aTemperature )

◆ SetUpdateInterval()

void WsfThermalSystem::SetUpdateInterval ( double aUpdateInterval )

inlineoverridevirtual

Set the time interval between the periodic calls to Update(). A value of less than or equal to zero indicates periodic updates are not to be performed.

Parameters

aUpdateInterval The new update interval.

Note: Users should call WsfSimulation::GetInstance().SetProcessorUpdateInterval() to set the interval.

Implements WsfPlatformPart.

◆ TransferHeat()

double WsfThermalSystem::TransferHeat	(	double	aSimTime,
		double	aHeatTransfer )

virtual

Given heat transfer to the system, return the new temperature.

References GetTemperature(), and TransferHeat().

Referenced by TransferHeat().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfThermalSystem() [1/2]

◆ WsfThermalSystem() [2/2]

◆ ~WsfThermalSystem()

Member Function Documentation

◆ Clone()

◆ CloneComponent()

◆ GetComponentRoles()

◆ GetEnergy()

◆ GetHeatSink()

◆ GetHighTemperature()

◆ GetLowTemperature()

◆ GetRequiredHeatForTemperature()

◆ GetTemperature()

◆ GetUpdateInterval()

◆ Initialize()

◆ IsSimple()

◆ IsValid()

◆ operator=()

◆ PrintInfo()

◆ ProcessInput()

◆ QueryInterface()

◆ SetHighTemperature()

◆ SetLowTemperature()

◆ SetPowerDissipated()

◆ SetTemperature()

◆ SetUpdateInterval()

◆ TransferHeat()