A DtComponentSystem is a collection of DtSimComponents that are associated with each other. More...

Inheritance diagram for DtComponentSystem:

Public Types
typedef std::list< std::pair < DtSimComponent *, DtString > >	DtComponentPortList
Public Member Functions
	DtComponentSystem (DtVrfObject owner, DtSimManager simManager, const DtComponentSystemDescriptor desc, DtComponentSystem parentSystem)
virtual	~DtComponentSystem ()
virtual bool	init ()
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 DtVrfProcessStateRepositoryManager *	processStateRepositoryManager ()
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 DtSimResourceManager &	resourceManager ()
virtual const DtSimResourceManager &	resourceManager () 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.
Protected Member Functions
virtual bool	createPsr ()
	Creates the PSR and sets it to myProcessStateRepository.
Protected Attributes
const DtComponentSystemDescriptor *	mySystemDescriptor
DtSimManager *	mySimManager
DtVrfObject *	myVrfObject
DtSimComponentNetwork *	myComponentNetwork
DtComponentSystemPSR *	myProcessStateRepository
DtComponentSystem *	myParentSystem
Private Member Functions

	DtComponentSystem ()
	Not Implemented.
	DtComponentSystem (const DtComponentSystem &orig)
	Not Implemented.
DtComponentSystem &	operator= (const DtComponentSystem &orig)
	Not Implemented.

Detailed Description

A DtComponentSystem is a collection of DtSimComponents that are associated with each other.

Calling tick() on the system results in tick() being called on all the components of the system. A system may also contain other systems.

Member Typedef Documentation

typedef std::list< std::pair<DtSimComponent*, DtString> > DtComponentSystem::DtComponentPortList

Constructor & Destructor Documentation

DtComponentSystem::DtComponentSystem ( ) [private]

Not Implemented.

DtComponentSystem::DtComponentSystem ( const DtComponentSystem & orig ) [private]

Not Implemented.

DtComponentSystem::DtComponentSystem	(	DtVrfObject *	owner,
		DtSimManager *	simManager,
		const DtComponentSystemDescriptor *	desc,
		DtComponentSystem *	parentSystem
	)

virtual DtComponentSystem::~DtComponentSystem ( ) [virtual]

Member Function Documentation

DtComponentSystem& DtComponentSystem::operator= ( const DtComponentSystem & orig ) [private]

Not Implemented.

virtual bool DtComponentSystem::init ( ) [virtual]

Reimplemented in DtTopLevelComponentSystem.

virtual bool DtComponentSystem::initializeFromDescriptor ( int & priority ) [virtual]

Creates the components, systems, and resources specified in the descriptor for the system.

The first component is created with the specified priority, and priority is incremented for each component created. The next available priority value is return in priority.

virtual bool DtComponentSystem::postAddComponentsInit ( ) [virtual]

Calls DtSimComponent::postAddComponentsInit() on all contained components.

virtual void DtComponentSystem::tick ( ) [virtual]

Calls DtSimCompoennt::tick() on all contained components.

virtual DtString DtComponentSystem::name ( ) const [virtual]

Returns:: The name that is supplied as the RW name of the system in the system definition.

virtual DtString DtComponentSystem::fullName ( ) const [virtual]

Returns:: A string that uniquely identifies this system on the entity. This name will be composed of the parent system's full name and this system's name, as returned by name().

virtual DtSimComponentNetwork* DtComponentSystem::componentNetwork ( ) [virtual]

Returns:: The component network that is used by this system.

virtual const DtSimComponentNetwork* DtComponentSystem::componentNetwork ( ) const [virtual]

Returns:: The component network that is used by this system.

virtual DtVrfProcessStateRepositoryManager* DtComponentSystem::processStateRepositoryManager ( ) [virtual]

Returns:: The process state repository manager that manages all PSRs for this system.

virtual DtSimResourceManager& DtComponentSystem::resourceManager ( ) [virtual]

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

Reimplemented in DtTopLevelComponentSystem.

virtual const DtSimResourceManager& DtComponentSystem::resourceManager ( ) const [virtual]

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

Reimplemented in DtTopLevelComponentSystem.

virtual void DtComponentSystem::restoreResources ( ) [virtual]

Restores resource values to the values specified in the parameters for this system and all child systems.

virtual void DtComponentSystem::resolveSystemOutput	(	const DtString &	outputName,
		DtComponentPortList &	componentOutputs
	)		`[virtual]`

Within systems, connections are made from components to "system" or vice versa.

This designates that as a public input/output to the system. External connections can be made to these named connections, which in turn result in a connection down to the actual component within the system. These methods take the system connection name and resolve it to the internal components and ports on those components. Each method fills the second parameter with a list of component pointers and port names on that component that should be connected to.

virtual void DtComponentSystem::resolveSystemInput	(	const DtString &	inputName,
		DtComponentPortList &	componentInputs
	)		`[virtual]`

Within systems, connections are made from components to "system" or vice versa.

This designates that as a public input/output to the system. External connections can be made to these named connections, which in turn result in a connection down to the actual component within the system. These methods take the system connection name and resolve it to the internal components and ports on those components. Each method fills the second parameter with a list of component pointers and port names on that component that should be connected to.

virtual void DtComponentSystem::enable ( ) [virtual]

Enables/disables components/systems in the system.

virtual void DtComponentSystem::disable ( ) [virtual]

Enables/disables components/systems in the system.

virtual bool DtComponentSystem::isEnabled ( ) [virtual]

Check if the system is enabled, component's tick function will be called, otherwise it will not.

Default is true (enabled).

virtual void DtComponentSystem::setIsEnabled ( bool yesNo ) [virtual]

Check if the system is enabled, component's tick function will be called, otherwise it will not.

Default is true (enabled).

virtual bool DtComponentSystem::createPsr ( ) [protected, virtual]

Creates the PSR and sets it to myProcessStateRepository.