CommonConfig Class Reference
[VGISConfiguration]

CommonConfig contains VGIS program configuration information common to all VGIS programs. More...

List of all members.

Public Attributes

Configurable Data Members
These members can be set as part of a VGIS program's run-time configuration (see VGISConfiguration)

char * configFile
 name of the VGIS configuration file
char * rootDir
 this is the directory in which VGIS is installed.
char * dataDirs [MAX_LAYERS]
int numDataDirs
char * logFile
 This file contains VGIS log output in ASCII format.
char * blogFile
 This is binary log file for recording statistics, etc.
char * userDir
 This directory contains configuration files for the current user.
char * computerName
 name of the host computer on which VGIS is executing.
char * userName
 this is the user name of the user logged into the computer running VGIS.
char * variantName
 this is the name of the configuration variant used for initializing VGIS.
char * systemDir
 This directory contains configuration files specific to the host computer running VGIS.
char * systemVariantDir
 This directory contains configuration files specific to the host computer running VGIS.
char * messageOutput
 [Windows] This determines where output messages are sent.

Detailed Description

CommonConfig contains VGIS program configuration information common to all VGIS programs.

See VGISConfiguration for general instructions related to to initializating a VGIS programs configuration structures. Path Interpretation discusses path interpretation (e.g. Default Parent Dir).

The VGIS run-time directory structure is highly configurable via VGISConfiguration. Below is a typical example that assumes you are using _all_ default values. In the path names below, VGISConfig data member names are used. The actual strings values that should be used can be determined by reading the documentation on that data member.

CommonConfig Directories
Data for the 3D world comes from these directories:

Computer system specific configuration directories are:

Computer system specific configuration files are:

User specific configuration data comes from these directories:

User specific configuration files are:

Member Data Documentation

char* CommonConfig::blogFile
 

This is binary log file for recording statistics, etc.

Initialize Options:

  • Default: vgis_stats
  • Config File: YES
  • Command Line: (-blogfile | -blf ) <FileName>

Default Parent Dir: CommonConfig::rootDir

char* CommonConfig::computerName
 

name of the host computer on which VGIS is executing.

This is used in constructing paths to various directories containing files specific to the specific computer on which VGIS is executing.

Initialize Options:

  • Default: determined from operating system
  • Config File: NO

char* CommonConfig::configFile
 

name of the VGIS configuration file

Initialize Options:

char* CommonConfig::dataDirs[MAX_LAYERS]
 

char* CommonConfig::logFile
 

This file contains VGIS log output in ASCII format.

Initialize Options:

  • Default: vgis_log.txt
  • Config File: YES
  • Command Line: (-logFile | -lf ) <FileName>

Default Parent Dir (*): CommonConfig::rootDir

char* CommonConfig::messageOutput
 

[Windows] This determines where output messages are sent.

If set to 'stderr' then VGIS error, warning and notify messages are sent to stderr. Otherwise a separate window is created.

Initialize Options:

  • Default: NULL
  • Config File: YES
  • Command Line: (-messageOutput | -mo ) stderr

int CommonConfig::numDataDirs
 

char* CommonConfig::rootDir
 

this is the directory in which VGIS is installed.

Typically all VGIS configuration files and data are found inside this directory.

Initialize Options:

  • Default: current directory
  • Environment Variable: VGISROOT
  • Config File: NO
  • Command Line: (-rd | -rootDir) <DirName>

char* CommonConfig::systemDir
 

This directory contains configuration files specific to the host computer running VGIS.

Initialize Options:

char* CommonConfig::systemVariantDir
 

This directory contains configuration files specific to the host computer running VGIS.

Often one computer will have multiple sets of configuration files to support different virtual reality displays on that computer. Such files are found in this subdirectory.

Initialize Options:

char* CommonConfig::userDir
 

This directory contains configuration files for the current user.

Initialize Options:

  • Default: CommonConfig::rootDir/config/users/CommonConfiguserName
  • Environment Variable: VGIS_USER_DIR
  • Config File: YES
  • Command Line: (-userDir | -ud) <DirName>

Default Parent Dir: CommonConfig::rootDir/config/users/

char* CommonConfig::userName
 

this is the user name of the user logged into the computer running VGIS.

This is used in constructing paths to various directories containing files specific to a given user. Examples would be files that customize the interface using a given user's preferences. (More precisely, CommonConfig::userName is used to generate CommonConfig::userDir which is the base directory for a user.)

Initialize Options:

  • Default: determined from operating system ( or "VGIS-default-user" if the operating system can't determine the current user).
  • Config File: NO

char* CommonConfig::variantName
 

this is the name of the configuration variant used for initializing VGIS.

Often one computer will have multiple sets of configuration files to support different virtual reality displays on that computer. CommonConfig::variantName is used to construct the CommonConfig::systemVariantDir directory name where configuration files specific to a given computer and configuration variant are found.

Initialize Options:

  • Default: NULL
  • Config File: YES
  • Command Line: (-vn | -variantName) <string>

The documentation for this class was generated from the following file:
Generated by doxygen written by Dimitri van Heesch, © 1997-2001