GAMS Auditing and Licensing Object (PAL) Documentation

Generated for GAMS 37.1.0

Functions, Procedures, and Properties

 

License

Integer palLicenseLevel
 Access the license level
 
Integer palLicenseLevelSet
 Access the license level
 

Audit

void palSetAuditLine
 Sets audit string
 
void palSetSystemName
 Sets system name and sets up a generic audit string
 
Boolean palAuditRun
 Indicator for an audit run
 
ShortString palGetAuditLine
 Gets audit string
 
ShortString palGetCpr
 Gets copyright string
 
Integer palGetVer
 Major and Minor number combined as an int like 239
 
ShortString palGetRel
 Gets Major.Minor like 23.9
 
ShortString palGetGold
 Gets Maintenance number like 2 for 23.9.2
 
ShortString palGetCod
 Gets Platform code like WIN
 
ShortString palGetHdr
 Gets Platform text like x86/MS Windows
 
Integer palGetJul
 Get license check date as Julian number
 
ShortString palGetLicDat
 Gets build date like "Sep 19, 2012"
 
ShortString palGetBldCod
 Gets build code like VS8
 
ShortString palGetRelDat
 Gets license check date like "ALFA Released 13Sep12" or "Released Sep 19, 2012"
 
ShortString palGetRevision
 Gets global SVN revision number like r123456
 
Boolean palIsBeta
 Indicator for an beta system
 
Boolean palIsAlfa
 Indicator for an alpha system
 
Integer palGetToday
 Get todays date as Julian number
 
Integer palGetJulianDays
 Get julian date from the string yymmdd
 
void palAuditFields
 Chops audit line apart
 
ShortString palGetShortAuditLine
 Gets a short audit line
 

Directories

Boolean palDataDirs
 Returns data dirs in buf
 
Boolean palConfigDirs
 Returns config dirs in buf
 

License

Boolean palLicenseReadU
 Reads license file in various line formats
 
void palLicenseRegisterGAMS
 Registers a line of the license file
 
ShortString palLicenseGetLLine
 Retrieve a line of the license file
 
void palLicenseRegisterGAMSDone
 Completion of license registration
 
void palLicenseRegisterSystem
 Registers the system to be licensed
 
Boolean palLicenseValidation
 Validates license and returns true on failure
 
Boolean palLicenseSolverCheck
 Checks if system with codes is licensed and returns true on failure uses registered size
 
Boolean palLicenseSolverCheckSizes
 Checks if system with codes is licensed and returns true on failure uses sizes from arguments
 
Boolean palLicenseSolverCheckSizes64
 Checks if system with codes is licensed and returns true on failure uses sizes from arguments
 
Boolean palLicenseCheck
 Checks if system is licensed and returns true on failure
 
Boolean palLicenseCheck64
 Checks if system is licensed and returns true on failure
 
Boolean palLicenseGetMessage
 Retrieves message from license check
 
Boolean palPrintDemoMessage
 Retrieves message about demo usage. Return indicates if message should be printed (true means print)
 
Boolean palLicenseIsGAMSCheckout
 Indicator if model fits in free GAMS limits (demo or community based on the actual license), returns true if that is the case, and false if the model is too big and a check for a license code is in order
 
Boolean palLicenseIsAcademic
 Indicator if license is academic
 
Boolean palLicenseCheckSubSys
 Indicator if subsystem is licensed (true if not licenses)
 
Boolean palLicenseCheckSubX
 Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)
 
ShortString palLicenseGetPlatform
 Get platform code of license
 

Enumerated Constants

 
palModelSizeLimits palLDemo  = 2000
  palNLDemo  = 1000
  palLCommunity  = 5000
  palNLCommunity  = 2500
 

Definitions

palLicenseLevel 

Access the license level

Type
Property of type Integer
Action
read

palLicenseLevelSet 

Access the license level

Type
Property of type Integer
Action
write

palAuditFields 

Chops audit line apart

Type
Procedure
Parameters
  const  ShortString    auditline
     audit line
  out  ShortString    v1
     product part of audit line
  out  ShortString    v2
     distribution info of audit line
  out  ShortString    v3
     rest of audit line

palAuditRun 

Indicator for an audit run

Type
Function returns Boolean

palConfigDirs 

Returns config dirs in buf

Type
Function returns Boolean
Parameters
   PAnsiChar    buf
     buffer to return a number of directories
   Integer    bufsize
     size of buf
  out  Integer    numdirs
     number of directories returned
   PLongIntArray    offset
     vector of offsets into buf to access the individual directories
   Integer    offsetsize
     size of offset vector
  const  ShortString    sysdir
     GAMS system directory

palDataDirs 

Returns data dirs in buf

Type
Function returns Boolean
Parameters
   PAnsiChar    buf
     buffer to return a number of directories
   Integer    bufsize
     size of buf
  out  Integer    numdirs
     number of directories returned
   PLongIntArray    offset
     vector of offsets into buf to access the individual directories
   Integer    offsetsize
     size of offset vector
  const  ShortString    sysdir
     GAMS system directory

palGetAuditLine 

Gets audit string

Type
Function returns ShortString

palGetBldCod 

Gets build code like VS8

Type
Function returns ShortString

palGetCod 

Gets Platform code like WIN

Type
Function returns ShortString

palGetCpr 

Gets copyright string

Type
Function returns ShortString

palGetGold 

Gets Maintenance number like 2 for 23.9.2

Type
Function returns ShortString

palGetHdr 

Gets Platform text like x86/MS Windows

Type
Function returns ShortString

palGetJul 

Get license check date as Julian number

Type
Function returns Integer

palGetJulianDays 

Get julian date from the string yymmdd

Type
Function returns Integer
Parameters
  const  ShortString    s

palGetLicDat 

Gets build date like "Sep 19, 2012"

Type
Function returns ShortString

palGetRel 

Gets Major.Minor like 23.9

Type
Function returns ShortString

palGetRelDat 

Gets license check date like "ALFA Released 13Sep12" or "Released Sep 19, 2012"

Type
Function returns ShortString

palGetRevision 

Gets global SVN revision number like r123456

Type
Function returns ShortString

palGetShortAuditLine 

Gets a short audit line

Type
Function returns ShortString

palGetToday 

Get todays date as Julian number

Type
Function returns Integer

palGetVer 

Major and Minor number combined as an int like 239

Type
Function returns Integer

palIsAlfa 

Indicator for an alpha system

Type
Function returns Boolean

palIsBeta 

Indicator for an beta system

Type
Function returns Boolean

palLicenseCheck 

Checks if system is licensed and returns true on failure

Type
Function returns Boolean
Parameters
   Integer    M
     number of equations
   Integer    N
     number of variables
   Integer    NZ
     number of non-zeros
   Integer    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseCheck64 

Checks if system is licensed and returns true on failure

Type
Function returns Boolean
Parameters
   Integer    M
     number of equations
   Integer    N
     number of variables
   Int64    NZ
     number of non-zeros
   Int64    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseCheckSubSys 

Indicator if subsystem is licensed (true if not licenses)

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system

palLicenseCheckSubX 

Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)

Type
Function returns Boolean
Parameters
  const  ShortString    sname
     name of solver/subsystem
  const  ShortString    codes
     license codes for system
  var  Integer    daysLeft
     remaining days of eval license (negative if expired)

palLicenseGetLLine 

Retrieve a line of the license file

Type
Function returns ShortString
Parameters
   Integer    linenr
     license file line number

palLicenseGetMessage 

Retrieves message from license check

Type
Function returns Boolean
Parameters
  out  ShortString    msg
     message

palLicenseGetPlatform 

Get platform code of license

Type
Function returns ShortString

palLicenseIsAcademic 

Indicator if license is academic

Type
Function returns Boolean

palLicenseIsGAMSCheckout 

Indicator if model fits in free GAMS limits (demo or community based on the actual license), returns true if that is the case, and false if the model is too big and a check for a license code is in order

Type
Function returns Boolean

palLicenseReadU 

Reads license file in various line formats

Type
Function returns Boolean
Parameters
  const  ShortString    filename
     name of the license file to read
  out  ShortString    msg
     message
  var  Integer    rc
     return code

palLicenseRegisterGAMS 

Registers a line of the license file

Type
Procedure
Parameters
   Integer    linenr
     license file line number
  const  ShortString    liceline
     license file line

palLicenseRegisterGAMSDone 

Completion of license registration

Type
Procedure

palLicenseRegisterSystem 

Registers the system to be licensed

Type
Procedure
Parameters
   Integer    numcodes
     number of license codes for system
  const  ShortString    codes
     license codes for system
   Integer    magicnum
     magic number

palLicenseSolverCheck 

Checks if system with codes is licensed and returns true on failure uses registered size

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system

palLicenseSolverCheckSizes 

Checks if system with codes is licensed and returns true on failure uses sizes from arguments

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system
   Integer    M
     number of equations
   Integer    N
     number of variables
   Integer    NZ
     number of non-zeros
   Integer    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseSolverCheckSizes64 

Checks if system with codes is licensed and returns true on failure uses sizes from arguments

Type
Function returns Boolean
Parameters
  const  ShortString    codes
     license codes for system
   Integer    M
     number of equations
   Integer    N
     number of variables
   Int64    NZ
     number of non-zeros
   Int64    NLNZ
     number of non-linear non-zeros
   Integer    NDisc
     number of discrete variables

palLicenseValidation 

Validates license and returns true on failure

Type
Function returns Boolean

palPrintDemoMessage 

Retrieves message about demo usage. Return indicates if message should be printed (true means print)

Type
Function returns Boolean
Parameters
  out  ShortString    msg
     message

palSetAuditLine 

Sets audit string

Type
Procedure
Parameters
  const  ShortString    auditline
     audit line

palSetSystemName 

Sets system name and sets up a generic audit string

Type
Procedure
Parameters
  const  ShortString    sname
     name of solver/subsystem