DtTopLevelComponentSystem Class Reference

A specialized version of DtComponentSystem that is used as the root of the all the systems on a DtVrfObject. More...

Inheritance diagram for DtTopLevelComponentSystem:

Public Member Functions
	DtTopLevelComponentSystem (DtVrfObject *owner, DtSimManager *simManager)
virtual	~DtTopLevelComponentSystem ()
virtual bool	init ()
virtual DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () const
Public Member Functions inherited from DtComponentSystem
	DtComponentSystem (DtVrfObject *owner, DtSimManager *simManager, const DtComponentSystemDescriptor *desc, DtComponentSystem *parentSystem)
virtual	~DtComponentSystem ()
virtual bool	initializeFromDescriptor (int &priority)
	Creates the components, systems, and resources specified in the descriptor for the system.
virtual bool	postAddComponentsInit ()
	Calls DtSimComponent::postAddComponentsInit() on all contained components.
virtual void	tick ()
	Calls DtSimCompoennt::tick() on all contained components.
virtual DtString	name () const
virtual DtString	fullName () const
virtual DtString	printName () const
virtual DtComponentSystem *	lookupSystem (const DtString &printName)
	Finds a system within this system that matches the given print name.
virtual DtComponentSystem *	lookupSystemFromRwName (const DtString &rwName)
	Finds a system within this system that matches the given name.
virtual void	getSystemNames (std::list< std::string > &nameList) const
	Adds the system's print name and the names of all subsystems in this system to the list in nameList.
virtual DtVrfProcessStateRepositoryManager *	processStateRepositoryManager ()
	Provides a list of all of the systems, by print name, in this system.
virtual void	restoreResources ()
	Restores resource values to the values specified in the parameters for this system and all child systems.
virtual DtSimComponentNetwork *	componentNetwork ()
virtual const DtSimComponentNetwork *	componentNetwork () const
virtual void	resolveSystemOutput (const DtString &outputName, DtComponentPortList &componentOutputs)
	Within systems, connections are made from components to "system" or vice versa.
virtual void	resolveSystemInput (const DtString &inputName, DtComponentPortList &componentInputs)
	Within systems, connections are made from components to "system" or vice versa.
virtual void	enable ()
	Enables/disables components/systems in the system.
virtual void	disable ()
	Enables/disables components/systems in the system.
virtual bool	isEnabled ()
	Check if the system is enabled, component's tick function will be called, otherwise it will not.
virtual void	setIsEnabled (bool yesNo)
	Check if the system is enabled, component's tick function will be called, otherwise it will not.
virtual bool	addAttributeProviderFunction (DtString &attributeName, genericAttributeProviderFunctionType attributeFunction, void *controller)
	Functions for defining system attribute functions, and getting attributes.
virtual bool	addAttributeSetFunction (DtString &attributeName, genericAttributeSetterFunctionType attributeFunction, void *controller)
	Similar to above, but adds a function to myWritableAttributes.
virtual DtReaderWriter *	getAttribute (const DtString &attributeName, bool &error) const
	Retrieves the attribute value (by running the function mapped to this attribute).The status of the get is returned in the error parameter.
virtual bool	setAttribute (const DtString &attributeName, DtReaderWriter *value)
	Sets the attribute value (by running the function mapped to this attribute).
virtual std::list< std::string >	getAllAttributeNames () const
	Gets the names of all of the attributes that have been registered by provider (i.e., Get) functions for this system.

Protected Attributes
DtSimResourceManager &	myResouceManager
Protected Attributes inherited from DtComponentSystem
const DtComponentSystemDescriptor *	mySystemDescriptor
DtSimManager *	mySimManager
DtVrfObject *	myVrfObject
DtSimComponentNetwork *	myComponentNetwork
DtComponentSystemPSR *	myProcessStateRepository
DtComponentSystem *	myParentSystem
std::map< DtString, std::pair < genericAttributeProviderFunctionType, void * > >	myReadableAttributes
	Map of attribute-names to provider-functions.
std::map< DtString, std::pair < genericAttributeSetterFunctionType, void * > >	myWritableAttributes
std::list< std::pair< DtString, DtVrfProcessStateRepositoryManager * > >	myAddedCompatibilityPsrs
	This list is kept so the compatibility PSRs can be removed upon destruction.

Private Member Functions
	DtTopLevelComponentSystem ()
	Not Implemented.
	DtTopLevelComponentSystem (const DtTopLevelComponentSystem &orig)
	Not Implemented.
DtTopLevelComponentSystem &	operator= (const DtTopLevelComponentSystem &orig)
	Not Implemented.

Additional Inherited Members
Public Types inherited from DtComponentSystem
typedef std::list< std::pair < DtSimComponent *, DtString > >	DtComponentPortList
Protected Member Functions inherited from DtComponentSystem
virtual bool	createPsr ()
	Creates the PSR and sets it to myProcessStateRepository.
void	removeCompatibilityPsrs ()
	Non-virtual because it is called by the destructor.

Detailed Description

A specialized version of DtComponentSystem that is used as the root of the all the systems on a DtVrfObject.

This system contains all the other systems, as well as all the top level DtSimComponent instances for an object. One specialization is that it uses the DtSimResouceManager from the main state repository instead of one in its own PSR like most systems do.

Constructor & Destructor Documentation

DtTopLevelComponentSystem::DtTopLevelComponentSystem ( )

private

Not Implemented.

DtTopLevelComponentSystem::DtTopLevelComponentSystem ( const DtTopLevelComponentSystem &  orig )

private

Not Implemented.

DtTopLevelComponentSystem::DtTopLevelComponentSystem	(	DtVrfObject *	owner,
		DtSimManager *	simManager
	)

virtual DtTopLevelComponentSystem::~DtTopLevelComponentSystem ( )

virtual

Member Function Documentation

DtTopLevelComponentSystem& DtTopLevelComponentSystem::operator= ( const DtTopLevelComponentSystem &  orig )

private

Not Implemented.

virtual bool DtTopLevelComponentSystem::init ( )

virtual

Reimplemented from DtComponentSystem.

virtual DtSimResourceManager& DtTopLevelComponentSystem::resourceManager ( )

virtual

Returns

The resource manager for this system. This includes resources for this system only.

Reimplemented from DtComponentSystem.

virtual const DtSimResourceManager& DtTopLevelComponentSystem::resourceManager ( ) const

virtual

Returns

The resource manager for this system. This includes resources for this system only.

Reimplemented from DtComponentSystem.

Member Data Documentation

DtSimResourceManager& DtTopLevelComponentSystem::myResouceManager

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/topLevelComponentSystem.h