dist_tools

Index

.     _     A     B     C     D     E     F     G     H     I     K     L     M     N     O     P     Q     R     S     T     U     V     W    

.

./ directory

Main directory for dist_tools source code.

_

_extra property in class mg_dlm

_extra keyword in routine mg_log in file mg_log.pro

keywords to MGffLogger::setProperty to configure the logger

_extra keyword in routine mg_make_dll in file mg_make_dll.pro

keywords to MAKE_DLL

_extra keyword in routine mg_resolve_routine in file mg_resolve_routine.pro

keywords to RESOLVE_ROUTINE

_extra property in class mgfflogger

any keyword accepted by MGffLogger::setProperty

_extra keyword in routine mgfflogger::init in file mgfflogger__define.pro

any keyword accepted by MGffLogger::setProperty

_extra keyword in routine mg_dlm::build in file mg_dlm__define.pro

keywords to the MG_MAKE_DLL routine

_extra keyword in routine mg_dlm::init in file mg_dlm__define.pro

_mg_include_filename parameter in routine mg_include in file mg_include.pro

filename to include

A

app_description property in class mgffprefs

full name of the application

app_description keyword in routine mgffprefs::init in file mgffprefs__define.pro

full name of the application

app_directory property in class mgffprefs

location of the directory for the application using these preferences

app_directory keyword in routine mgffprefs::getProperty in file mgffprefs__define.pro

location of the directory for the application using these preferences

app_manifest keyword in routine mg_make_rt in file mg_make_rt.pro

specify a manifest of application files

app_name parameter in routine mg_make_cl_wrapper in file mg_make_cl_wrapper.pro

name of routine to call

app_name keyword in routine mg_options::init in file mg_options__define.pro

application name

app_name property in class mg_options

app_name property in class mgffprefs

short name of the application

app_name keyword in routine mgffprefs::init in file mgffprefs__define.pro

short name of the application

appdir field in class mgffprefs

directory to place preference files

APPNAME field in class mg_options

appname parameter in routine mg_make_rt in file mg_make_rt.pro

name of the application

arg1 parameter in routine mg_log in file mg_log.pro

optional argument to be substituted into msg format string

arg2 parameter in routine mg_log in file mg_log.pro

optional argument to be substituted into msg format string

arg3 parameter in routine mg_log in file mg_log.pro

optional argument to be substituted into msg format string

args parameter in routine mg_options::parseArgs in file mg_options__define.pro

string array of arguments

author_description keyword in routine mgffprefs::init in file mgffprefs__define.pro

full name of the author

author_description property in class mgffprefs

full name of the author

author_name keyword in routine mgffprefs::init in file mgffprefs__define.pro

short name of the author

author_name property in class mgffprefs

short name of the author

B

basename property in class mg_dlm

basename (including possible path) for .c and .dlm files

basename keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

basename (including possible path) for .c and .dlm files

basename field in class mg_dlm

basename (including possible path) for .c and .dlm files

bindings/ directory

This directory contains routines and classes to autogenerate a DLM of wrapperroutines.

boolean keyword in routine mg_options::addOption in file mg_options__define.pro

set to indicate the option is a boolean switch

boolean property in class mg_opt

boolean field in class mg_opt

true if option is a boolean type option

build_date keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

date in DLM header

build_date property in class mg_dlm

date in DLM header

build_date field in class mg_dlm

date in DLM header

C

cfile parameter in routine mg_make_dll in file mg_make_dll.pro

C filename to create DLL from

children field in class mgfflogger

IDL_Container of children loggers

class keyword in routine mg_use in file mg_use.pro

class(es) to compile

clobber property in class mgfflogger

set, along with filename, to clobber pre-existing file

clobber keyword in routine mgfflogger::setProperty in file mgfflogger__define.pro

set, along with filename, to clobber pre-existing file

critical keyword in routine mg_log in file mg_log.pro

set to specify the message as critical

D

dataminer keyword in routine mg_make_rt in file mg_make_rt.pro

set to include support for Dataminer

debug keyword in routine mg_log in file mg_log.pro

set to specify the message as debug

default property in class mg_opt

default keyword in routine mg_options::addOption in file mg_options__define.pro

default value

default field in class mg_opt

default value if value is not present

default keyword in routine mgffprefs::get in file mgffprefs__define.pro

default value to use if no preference value is found for the given preference name

description keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

description in DLM header

description property in class mg_dlm

description in DLM header

description field in class mg_dlm

description in DLM header

dicomex keyword in routine mg_make_rt in file mg_make_rt.pro

set to include support for IDLffDicomEx objects

dist_tools.dlm .dlm file in ./ directory

Tools for the distributing IDL packages

E

embedded keyword in routine mg_make_rt in file mg_make_rt.pro

set to launch savefile in embedded license mode

error keyword in routine mg_log in file mg_log.pro

set to specify the message as an error

error_message keyword in routine mg_options::parseArgs in file mg_options__define.pro

set to a named variable to receive any error message generated from parsing the parameters

extension keyword in routine mg_platform_extension in file mg_platform_extension.pro

append appropriate shared object extension to return value

F

filename keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

filename to send append output to; set to empty string to send output to stderr

filename property in class mgfflogger

filename to send append output to; set to empty string to send output to stderr

filename keyword in routine mgfflogger::setProperty in file mgfflogger__define.pro

filename to send append output to; set to empty string to send output to stderr

filename parameter in routine mg_dlm::addRoutinesFromHeaderFile in file mg_dlm__define.pro

header filename

filename field in class mgfflogger

filename to send output to

format property in class mgfflogger

format string for messages, default value for format is: '%(time)s %(levelname)s: %(routine)s: %(message)s' where the possible names to include are: "time", "levelname", "routine", "stacktrace", "name", and "message".

format field in class mgfflogger

format code to send output to

format keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

format string for messages, default value for format is: '%(time)s %(levelname)s: %(routine)s: %(message)s' where the possible names to include are: "time", "levelname", "routine", "stacktrace", "name", and "message".

format keyword in routine mgfflogger::setProperty in file mgfflogger__define.pro

format string for messages, default value for format is: '%(time)s %(levelname)s: %(routine)s: %(message)s' where the possible names to include are: "time", "levelname", "routine", "stacktrace", "name", and "message".

format_example.dlm .dlm file in bindings/ directory

Example of using dist_tools bindings

found keyword in routine mgffprefs::get in file mgffprefs__define.pro

set to a named variable to return whether the preference was found

G

GET_IDL_TYP_UNDEF routine in format_example.dlm

H

header_directory keyword in routine mg_dlm::addInclude in file mg_dlm__define.pro

filepath to include file, if not in a standard location

help field in class mg_opt

text to print for the option if help is asked for

help property in class mg_opt

help keyword in routine mg_options::addOption in file mg_options__define.pro

help text for the option

help_header property in class mg_opt

hires_maps keyword in routine mg_make_rt in file mg_make_rt.pro

set to include support for high resolution maps

I

IDL_OUTPUTFORMATFUNC routine in format_example.dlm

IDL_OUTPUTFORMATLENFUNC routine in format_example.dlm

IDL_SYSRTNNUMENABLED routine in format_example.dlm

IDL_TTYRESET routine in format_example.dlm

IDL_TYPENAMEFUNC routine in format_example.dlm

IDL_TYPESIZEFUNC routine in format_example.dlm

idldir keyword in routine mg_make_rt in file mg_make_rt.pro

specify IDL distribution which the files should be copied from

includeDirs field in class mg_dlm

LIST of include directories

informational keyword in routine mg_log in file mg_log.pro

set to specify the message as informational

is_function keyword in routine mg_hasroutine in file mg_hasroutine.pro

set to a named variable to determine if the routine is a function

is_system keyword in routine mg_hasroutine in file mg_hasroutine.pro

set to a named variable to determine if the routine is a system routine

K

key_column_width property in class mg_opt

L

last_error keyword in routine mg_log in file mg_log.pro

set to place a stack trace for the last error in the log; placed after the logging of any normal message in this call

level field in class mgfflogger

current level of logging: 0=none, 1=critical, 2=error, 3=warning, 4=informational, or 5=debug; only messages with a level lower or equal to this this value will be logged

level property in class mgfflogger

current level of logging: 0 (none), 1 (critial), 2 (error), 3 (warning), 4 (info), or 5 (debug); can be set to an array of levels which will be cascaded up to the parents of the logger with the logger taking the last level and passing the previous ones up to its parent; only messages with levels lower or equal to than the logger level will be logged

level keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

current level of logging: 0 (none), 1 (critial), 2 (error), 3 (warning), 4 (info), or 5 (debug); can be set to an array of levels which will be cascaded up to the parents of the logger with the logger taking the last level and passing the previous ones up to its parent; only messages with levels lower or equal to than the logger level will be logged

level keyword in routine mgfflogger::setProperty in file mgfflogger__define.pro

current level of logging: 0 (none), 1 (critial), 2 (error), 3 (warning), 4 (info), or 5 (debug); can be set to an array of levels which will be cascaded up to the parents of the logger with the logger taking the last level and passing the previous ones up to its parent; only messages with levels lower or equal to than the logger level will be logged

level keyword in routine mgfflogger::print in file mgfflogger__define.pro

level of message

levelNames field in class mgfflogger

names for the different levels

lib_directory keyword in routine mg_dlm::addInclude in file mg_dlm__define.pro

directory of lib files

lib_files keyword in routine mg_dlm::addInclude in file mg_dlm__define.pro

library files

libDirs field in class mg_dlm

LIST of lib directories

libFiles field in class mg_dlm

LIST of lib files

location keyword in routine mg_make_cl_wrapper in file mg_make_cl_wrapper.pro

directory to place the wrapper script

logfile keyword in routine mg_make_rt in file mg_make_rt.pro

full path to log file produced while generating the runtime distribution

logger keyword in routine mg_log in file mg_log.pro

MGffLogger object

long_name property in class mg_opt

longForm parameter in routine mg_options::addOption in file mg_options__define.pro

long name of the option, used with two dashes i.e.

longName field in class mg_opt

long name of the option

longOptions field in class mg_options

hash table of options keyed on long name of option

M

manifest keyword in routine mg_make_rt in file mg_make_rt.pro

specify a manifest file

metavar keyword in routine mg_options::addOption in file mg_options__define.pro

text to display in the help for non-boolean option values

metavar property in class mg_opt

metavar field in class mg_opt

text to display in the help for non-boolean option values

mg_build_dist_tools routine in mg_build_dist_tools.pro

Build the dist_tools DLM.

mg_build_dist_tools.pro .pro file in ./ directory

mg_char routine in mg_char.pro

Convenience routine to convert a 1-element string to a character value.

mg_char.pro .pro file in bindings/ directory

mg_cmp_version routine in mg_cmp_version.pro

Compares two version numbers for the more updated number.

mg_cmp_version.pro .pro file in ./ directory

mg_dlm class

mg_dlm::addInclude routine in mg_dlm__define.pro

Add an include file to the DLM.

mg_dlm::addPoundDefineAccessor routine in mg_dlm__define.pro

Adds wrapper routine to access the given #define value.

mg_dlm::addRoutine routine in mg_dlm__define.pro

Adds a wrapper routine to the DLM.

mg_dlm::addRoutineFromPrototype routine in mg_dlm__define.pro

Adds a wrapper routine defined by a prototype given by a string to the DLM.

mg_dlm::addRoutinesFromHeaderFile routine in mg_dlm__define.pro

Adds wrapper routines from a header file.

mg_dlm::build routine in mg_dlm__define.pro

Compiles and links the DLM.

mg_dlm::cleanup routine in mg_dlm__define.pro

Free resources.

mg_dlm::getProperty routine in mg_dlm__define.pro

Get properties.

mg_dlm::init routine in mg_dlm__define.pro

Create the DLM object.

mg_dlm::load routine in mg_dlm__define.pro

Load the DLM.

mg_dlm::register routine in mg_dlm__define.pro

Register the DLM.

mg_dlm::setProperty routine in mg_dlm__define.pro

Set properties.

mg_dlm::write routine in mg_dlm__define.pro

Writes the .c and .dlm files to the BASENAME location.

mg_dlm__define routine in mg_dlm__define.pro

Define instance variables.

mg_dlm__define.pro .pro file in bindings/ directory

Class representing a DLM made from a list of wrapper routines.

mg_hasroutine routine in mg_hasroutine.pro

Determine if a given routine name is available to call.

mg_hasroutine.pro .pro file in ./ directory

Determines if a given routine is available to call.

MG_HOMEDIR routine in dist_tools.dlm

MG_HOSTNAME routine in dist_tools.dlm

mg_idlversion routine in mg_idlversion.pro

Returns the IDL version number as a string or a boolean indicating whether a required version is met.

mg_idlversion.pro .pro file in ./ directory

mg_include routine in mg_include.pro

Includes the contents of the given batch file at the calling level.

mg_include.pro .pro file in ./ directory

mg_log routine in mg_log.pro

Messages are logged via this routine.

mg_log.pro .pro file in ./ directory

MG_LOG is a procedural interface to the logging framework.

mg_log_common.pro .pro file in ./ directory

MG_LOGINNAME routine in dist_tools.dlm

mg_make_cl_wrapper routine in mg_make_cl_wrapper.pro

Create a UNIX wrapper script to call an IDL routine.

mg_make_cl_wrapper.pro .pro file in ./ directory

mg_make_dll routine in mg_make_dll.pro

Wrapper for MAKE_DLL that handles input and output directories more intelligently.

mg_make_dll.pro .pro file in ./ directory

mg_make_rt routine in mg_make_rt.pro

Wrapper for MAKE_RT.

mg_make_rt.pro .pro file in ./ directory

MG_MAKE_RT can build a cross-platform runtime distribution.

mg_opt class

mg_options class

mg_options::addOption routine in mg_options__define.pro

Add the definition of an option to the parser.

mg_options::addParams routine in mg_options__define.pro

Add a range of positional parameters.

mg_options::cleanup routine in mg_options__define.pro

Free resources.

mg_options::get routine in mg_options__define.pro

Get value of option.

mg_options::init routine in mg_options__define.pro

Create option parsing object.

mg_options::parseArgs routine in mg_options__define.pro

Parse arguments.

mg_options__define routine in mg_options__define.pro

Define instance variables.

mg_options__define.pro .pro file in ./ directory

An object to facilitate parsing of command line options.

MG_PID routine in dist_tools.dlm

mg_platform_extension routine in mg_platform_extension.pro

Returns the platform extension used by the PLATFORM_EXTENSION keyword to MAKE_DLL.

mg_platform_extension.pro .pro file in ./ directory

mg_proto2wrapper routine in mg_proto2wrapper.pro

Convenience routine to convert a C prototype line to C wrapper code.

mg_proto2wrapper.pro .pro file in bindings/ directory

mg_resolve_routine routine in mg_resolve_routine.pro

Routine to resolve a given routine without crashing.

mg_resolve_routine.pro .pro file in ./ directory

mg_src_root routine in mg_src_root.pro

Returns the absolute directory name (with a trailing slash) of the location of the source code for the routine that called this function.

mg_src_root.pro .pro file in ./ directory

mg_use routine in mg_use.pro

Creates a list of files required to run the specified routines.

mg_use.pro .pro file in ./ directory

mg_use_wrapper routine in mg_use_wrapper.pro

Wrapper for MG_USE to be called from the command line.

mg_use_wrapper.pro .pro file in ./ directory

mgfflogger class

mgfflogger::cleanup routine in mgfflogger__define.pro

Free resources.

mgfflogger::getByName routine in mgfflogger__define.pro

Traverses a hierarchy of named objects using a path of names delimited with /'s.

mgfflogger::getProperty routine in mgfflogger__define.pro

Set properties.

mgfflogger::init routine in mgfflogger__define.pro

Create logger object.

mgfflogger::insertLastError routine in mgfflogger__define.pro

Insert the stack trace for the last error message into the log.

mgfflogger::print routine in mgfflogger__define.pro

Log message to given level.

mgfflogger::setProperty routine in mgfflogger__define.pro

Get properties.

mgfflogger__define routine in mgfflogger__define.pro

Define instance variables.

mgfflogger__define.pro .pro file in ./ directory

Logger object to control logging.

mgffprefs class

mgffprefs::cleanup routine in mgffprefs__define.pro

Free resources.

mgffprefs::clear routine in mgffprefs__define.pro

Clear the value of a preference.

mgffprefs::get routine in mgffprefs__define.pro

Retrieve the value of a preference.

mgffprefs::getProperty routine in mgffprefs__define.pro

Get properties.

mgffprefs::init routine in mgffprefs__define.pro

Initialize a prefs object.

mgffprefs::set routine in mgffprefs__define.pro

Save the value of a preference.

mgffprefs__define routine in mgffprefs__define.pro

Define instance variables.

mgffprefs__define.pro .pro file in ./ directory

Class responsible for storing and retrieving preferences.

msg parameter in routine mg_log in file mg_log.pro

message to log, if present; is interpreted as a format string when additional parameters are present

msg parameter in routine mgfflogger::print in file mgfflogger__define.pro

message to print

N

n_params keyword in routine mg_options::get in file mg_options__define.pro

number of parameters returned, only used if PARAMS is set

name keyword in routine mg_log in file mg_log.pro

path to logger to send message to

name field in class mg_dlm

name in DLM header

name keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

name in DLM header

name keyword in routine mg_dlm::getProperty in file mg_dlm__define.pro

name in DLM header

name parameter in routine mg_dlm::addInclude in file mg_dlm__define.pro

name of the include file, including the .h

name parameter in routine mg_dlm::addPoundDefineAccessor in file mg_dlm__define.pro

name of #define

name property in class mgfflogger

name of the logger

name field in class mgfflogger

name of the loffer

name parameter in routine mgfflogger::getByName in file mgfflogger__define.pro

path of names to the desired object; names are delimited with /'s

name keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

name of the logger

name keyword in routine mgfflogger::init in file mgfflogger__define.pro

name of the logger

name property in class mg_dlm

name in DLM header

names keyword in routine mgffprefs::get in file mgffprefs__define.pro

set to return a list of the preference names instead of a value; names may not agree exactly with the names given in the set method because they have been modified to make valid filename

nFunctions field in class mg_dlm

the number of functions added to the DLM

NPARAMSACCEPTED field in class mg_options

nparamsRange parameter in routine mg_options::addParams in file mg_options__define.pro

valid range for number of positional parameters, use -1 for the max value to allow an unlimited number of parameters

nProcedures field in class mg_dlm

the number of procedures added to the DLM

O

optname parameter in routine mg_options::get in file mg_options__define.pro

long name of option

outdir parameter in routine mg_make_rt in file mg_make_rt.pro

directory to place output in; this directory must exist and must use the OVERWRITE keyword if this directory is not empty

outdir parameter in routine mg_use in file mg_use.pro

directory to copy files to, if present

output property in class mgfflogger

output sent to the logger already

output keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

output sent to the logger already

overwrite keyword in routine mg_make_rt in file mg_make_rt.pro

set to overwrite existing files instead of generating an error

P

param0 parameter in routine IDL_TYPESIZEFUNC in file format_example.dlm

param0 parameter in routine IDL_OUTPUTFORMATLENFUNC in file format_example.dlm

param0 parameter in routine IDL_OUTPUTFORMATFUNC in file format_example.dlm

param0 parameter in routine IDL_SYSRTNNUMENABLED in file format_example.dlm

param0 parameter in routine IDL_TYPENAMEFUNC in file format_example.dlm

param1 parameter in routine IDL_SYSRTNNUMENABLED in file format_example.dlm

PARAMS field in class mg_options

params keyword in routine mg_options::get in file mg_options__define.pro

set to return parameters

parent keyword in routine mgfflogger::init in file mgfflogger__define.pro

parent logger

parent field in class mgfflogger

parent MGffLoffer object

prefname parameter in routine mgffprefs::get in file mgffprefs__define.pro

case-insensitive name of preference to retrieve

prefname parameter in routine mgffprefs::set in file mgffprefs__define.pro

case-insensitive name of preference to retrieve

prefname parameter in routine mgffprefs::clear in file mgffprefs__define.pro

case-insensitive name of preference to retrieve

prefvalue parameter in routine mgffprefs::set in file mgffprefs__define.pro

value of the preference

present field in class mg_opt

true if value has been set

present keyword in routine mg_options::get in file mg_options__define.pro

set to a named variable to determine if the option was present

proto parameter in routine mg_dlm::addRoutineFromPrototype in file mg_dlm__define.pro

prototype of the routine to add to the DLM

prototype parameter in routine mg_proto2wrapper in file mg_proto2wrapper.pro

C prototype as found in a header file

Q

quit keyword in routine mg_log in file mg_log.pro

set to quit logging; will log an normal message in this call before quitting

R

require keyword in routine mg_idlversion in file mg_idlversion.pro

IDL version required; if set, MG_IDLVERSION returns a boolean of whether the version requirement is met

resolved keyword in routine mg_resolve_routine in file mg_resolve_routine.pro

set to a named variable to find out if the routine was resolved

routine parameter in routine mg_resolve_routine in file mg_resolve_routine.pro

name of routine to resolve

routine parameter in routine mg_hasroutine in file mg_hasroutine.pro

routine name to look up

routine parameter in routine mg_dlm::addRoutine in file mg_dlm__define.pro

routine object to add to the DLM

routines parameter in routine mg_use in file mg_use.pro

routine or routines that are required

routines field in class mg_dlm

LIST of routine objects

S

s parameter in routine mg_char in file mg_char.pro

1-element string to convert to a character value

savefile keyword in routine mg_make_rt in file mg_make_rt.pro

full path to save file to be launched; if nothing specified, then a file selection dialog will be displayed

script_name parameter in routine mg_make_cl_wrapper in file mg_make_cl_wrapper.pro

basename of wrapper script

short_name property in class mg_opt

shortForm parameter in routine mg_options::addOption in file mg_options__define.pro

single character name of an option, used with a single dash i.e.

shortName field in class mg_opt

single character abbreviation for the option

shortOptions field in class mg_options

hash table of options keyed on short name of option, if present

source property in class mg_dlm

source in DLM header

source field in class mg_dlm

source in DLM header

source keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

source in DLM header

system keyword in routine mg_dlm::addInclude in file mg_dlm__define.pro

set to indicate that the include is a system include file, i.e., that there should be <>'s around the name instead of ""'s

systemIncludes field in class mg_dlm

LIST of system include names

T

time_format property in class mgfflogger

Fortran style format code to specify the format of the time in the FORMAT property; the default value formats the time/date like "2003-07-08 16:49:45.891"

time_format field in class mgfflogger

Fortran format codes for calendar output

time_format keyword in routine mgfflogger::getProperty in file mgfflogger__define.pro

Fortran style format code to specify the format of the time in the FORMAT property; the default value formats the time/date like "2003-07-08 16:49:45.891"

time_format keyword in routine mgfflogger::setProperty in file mgfflogger__define.pro

Fortran style format code to specify the format of the time in the FORMAT property; the default value formats the time/date like "2003-07-08 16:49:45.891"

type keyword in routine mg_dlm::addPoundDefineAccessor in file mg_dlm__define.pro

SIZE type code for #define value

U

userIncludes field in class mg_dlm

LIST of user include names

V

value field in class mg_opt

value of the option

version keyword in routine mg_dlm::setProperty in file mg_dlm__define.pro

version in DLM header

version property in class mg_options

version property in class mg_dlm

version in DLM header

version field in class mg_dlm

version in DLM header

VERSION field in class mg_options

version keyword in routine mg_options::init in file mg_options__define.pro

version of the application

version1 parameter in routine mg_cmp_version in file mg_cmp_version.pro

first version number

version2 parameter in routine mg_cmp_version in file mg_cmp_version.pro

second version number

vm keyword in routine mg_make_rt in file mg_make_rt.pro

set to automatically run in virtual machine mode instead of attempting runtime

W

warning keyword in routine mg_log in file mg_log.pro

set to specify the message as a warning