WsfL16::PPLI_Part Class Reference

#include <PPLI_Part.hpp>

Inheritance diagram for WsfL16::PPLI_Part:

Collaboration diagram for WsfL16::PPLI_Part:

Public Member Functions
	PPLI_Part (WsfScenario &aScenario)
	PPLI_Part (const PPLI_Part &aSrc)
ComputerPart *	Clone () const override
bool	Initialize (double aSimTime, ComputerProcessor &aComputer) override
bool	ProcessInput (UtInput &aInput) override
void	HandleReceive (double aSimTime, const Messages::InitialBase &aMessage) override
	Handle an incoming message.
void	HandleSend (double aSimTime) override
	This method is called when the a slot is open.
Public Member Functions inherited from WsfL16::ComputerPart
	ComputerPart (WsfScenario &aScenario, const std::string &aClassName="WsfProcessor")
	ComputerPart (const ComputerPart &aSrc)
	~ComputerPart () override
void	SendJMessage (double aSimTime, Messages::InitialBase *aMessage)
virtual bool	IsNetworkEnabled ()
void	SetDebug (bool aDebugOn)
bool	Debug ()
void	SetPlatform (WsfPlatform *aPlatformPtr)
WsfCommandChain *	GetCommandChain () const
ComputerProcessor *	GetComputer ()
WsfPlatform *	GetPlatform ()
WsfSimulation *	GetSimulation ()
const SlotParameters &	GetSlotParameters () const
int	DebugMore ()
void	SetSendInterval (double aValue)
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)

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Types inherited from WsfL16::ComputerPart
typedef std::map< int, ScriptData >	ScriptMap
Protected Member Functions inherited from WsfL16::ComputerPart
double	ProcessSendInterval (UtInput &aInput) const
double	GetSendInterval ()
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).
Protected Attributes inherited from WsfL16::ComputerPart
IntervalUpdater	mSendInterval
int	mDebugMore
UtCallbackHolder	mCallbacks
SlotParameters	mSlotParameters
WsfScriptContext *	mContextPtr
ScriptMap	mSendScripts

Constructor & Destructor Documentation

PPLI_Part() [1/2]

WsfL16::PPLI_Part::PPLI_Part

(

WsfScenario &

aScenario

)

References WsfL16::ComputerPart::ComputerPart(), and WsfL16::ComputerPart::mSendInterval.

Referenced by Clone(), and PPLI_Part().

PPLI_Part() [2/2]

WsfL16::PPLI_Part::PPLI_Part

(

const PPLI_Part &

aSrc

)

References WsfL16::ComputerPart::ComputerPart(), and PPLI_Part().

Member Function Documentation

Clone()

ComputerPart * WsfL16::PPLI_Part::Clone ( ) const

overridevirtual

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

Implements WsfL16::ComputerPart.

References WsfL16::ComputerPart::ComputerPart(), and PPLI_Part().

HandleReceive()

void WsfL16::PPLI_Part::HandleReceive ( double aSimTime, const Messages::InitialBase & aMessage )

overridevirtual

Handle an incoming message.

Implements WsfL16::ComputerPart.

HandleSend()

void WsfL16::PPLI_Part::HandleSend ( double aSimTime )

overridevirtual

This method is called when the a slot is open.

Reimplemented from WsfL16::ComputerPart.

Initialize()

bool WsfL16::PPLI_Part::Initialize ( double aSimTime, ComputerProcessor & aComputer )

overridevirtual

Reimplemented from WsfL16::ComputerPart.

References WsfPlatform::GetMover(), WsfL16::ComputerPart::GetPlatform(), WsfPlatform::GetSpatialDomain(), WsfL16::ComputerPart::Initialize(), ok, WSF_SPATIAL_DOMAIN_LAND, WSF_SPATIAL_DOMAIN_SUBSURFACE, and WSF_SPATIAL_DOMAIN_SURFACE.

ProcessInput()

bool WsfL16::PPLI_Part::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 WsfL16::ComputerPart.

References WsfL16::ComputerPart::ProcessInput().

---

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

• PPLI_Part.hpp
• PPLI_Part.cpp