DICore1 Struct Reference
[Core]

#include <Interfaces.h>

Inherits DIObjectBase.

---

Detailed Description

Interface for the system Core.

This is the central part of Digital Spaces. The Core is responsible for parsing the .space file, selecting which components to load to fullfill the .space requirements, passing configuration data to the components, calling the components PerformPrivateStartupStep, PerformPublicStartupStep, PerformHeartbeat and Shutdown functions. It also schedules and prioritizes the calls to each of the components.

Public Member Functions
void	SetSpaceFile (const char *pFullPath)
	Sets the .space file to be loaded next time the Core is cycled (next time a component returns false from PerformHeartbeat).
void	SetTimeoutEvent (const char *pszEventName, float fTimeout, DIEventSubscriber1 *pEventSubscriber)
	Create a callback event that will be called after a period of time.
void	RemoveTimeoutEvent (const char *pszEventName)
	Remove a callback event that was previously requested.
float	GetTime ()
	Returns the internal time as calculated by the Core.
unsigned long	GetTimeInMS ()
	Returns the real time taken since the Core started the PerformHeartbeat state.
Path Related Functions.
These functions are used to get the assorted paths the DSS system uses. This was previously required because each component had to do its own file accessing. It should be less needed in more recent builds, due to the addition of the ResourceManager and it's path search mechanism, but the functions remain. The paths provided from these functions can be used with the ResourceManager to cause it to do an absolute file open, without doing the search path process.
const char *	GetConfigurationPath ()
	Returns the path where DSS stores it's configuration files.
const char *	GetPluginPath ()
	Returns the path where DSS loads add-on DLL files from.
const char *	GetModulePath ()
	Returns the path where DSS loads component DLL files from.
const char *	GetSpaceFile ()
	Returns the path of the currently executing .space file.
const char *	GetSpaceBasePath ()
	Returns the path to the folder the currently executing .space file is stored in.
OS PATH Environment Variable Functions
Provide these as a helper for the plugins. Component creators should be aware that the Core automatically adds a (ModulePath)\(NameOfModule)\ directory to the search path when loading a component. Previously, components had to use these functions to do this, but it occured often enough and was helpful enough to make standard.
void	AddToPathVariable (const char *pDirectory)
	Appends the specified directory to the PATH enviroment variable.
void	ResetPathVariable ()
	Undoes the effect of the last AddToPathVariable call.

---

Member Function Documentation

void DICore1::SetSpaceFile

(

const char *

pFullPath

)

Sets the .space file to be loaded next time the Core is cycled (next time a component returns false from PerformHeartbeat).

---

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

• CoreInterfaces/Interfaces.h