Gams Auditing and Licensing Object (PAL) API Documentation

Generated for GAMS 32.1.0

Functions, Procedures and Properties

Audit

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

License

palLicenseLevel(Set)
Access the license level
palLicenseReadU
Reads license file in various line formats
palLicenseRegisterGAMS
Registers a line of the license file
palLicenseGetLLine
Retrieve a line of the license file
palLicenseRegisterGAMSDone
Completion of license registration
palLicenseRegisterSystem
Registers the system to be licensed
palLicenseValidation
Validates license and returns true on failure
palLicenseSolverCheck
Checks if system with codes is licensed and returns true on failure uses registered size
palLicenseSolverCheckSizes
Checks if system with codes is licensed and returns true on failure uses sizes from arguments
palLicenseCheck
Checks if system is licensed and returns true on failure
palLicenseGetMessage
Retrieves message from license check
palPrintDemoMessage
Retrieves message about demo usage. Return indicates if message should be printed (true means print)
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
palLicenseIsAcademic
Indicator if license is academic
palLicenseCheckSubSys
Indicator if subsystem is licensed (true if not licenses)
palLicenseCheckSubX
Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)
palLicenseGetPlatform
Get platform code of license

Arguments

auditline
audit line
codes
license codes for system
daysLeft
remaining days of eval license (negative if expired)
filename
name of the license file to read
liceline
license file line
linenr
license file line number
M
number of equations
magicnum
magic number
msg
message
N
number of variables
NDisc
number of discrete variables
NLNZ
number of non-linear non-zeros
numcodes
number of license codes for system
NZ
number of non-zeros
rc
return code
sname
name of solver/subsystem
v1
product part of audit line
v2
distribution info of audit line
v3
rest of audit line

Calling Sequences

palAuditFields

  • Chops audit line apart
  • Procedure
  • Arguments:
    • const auditline: ShortString
      audit line
      out v1 : ShortString
      product part of audit line
      out v2 : ShortString
      distribution info of audit line
      out v3 : ShortString
      rest of audit line

palAuditRun

  • Indicator for an audit run
  • Function returns Boolean

palGetAuditLine

  • Gets audit string
  • Function returns ShortString

palGetBldCod

  • Gets build code like VS8
  • Function returns ShortString

palGetCod

  • Gets Platform code like WIN
  • Function returns ShortString

palGetCpr

  • Gets copyright string
  • Function returns ShortString

palGetGold

  • Gets Maintenance number like 2 for 23.9.2
  • Function returns ShortString

palGetHdr

  • Gets Platform text like x86/MS Windows
  • Function returns ShortString

palGetJul

  • Get license check date as Julian number
  • Function returns Integer

palGetJulianDays

  • Get julian date from the string yymmdd
  • Function returns Integer
  • Arguments:
    • const s : ShortString

palGetLicDat

  • Gets build date like "Sep 19, 2012"
  • Function returns ShortString

palGetRel

  • Gets Major.Minor like 23.9
  • Function returns ShortString

palGetRelDat

  • Gets license check date like "ALFA Released 13Sep12" or "Released Sep 19, 2012"
  • Function returns ShortString

palGetRevision

  • Gets global SVN revision number like r123456
  • Function returns ShortString

palGetShortAuditLine

  • Gets a short audit line
  • Function returns ShortString

palGetToday

  • Get todays date as Julian number
  • Function returns Integer

palGetVer

  • Major and Minor number combined as an int like 239
  • Function returns Integer

palIsAlfa

  • Indicator for an alpha system
  • Function returns Boolean

palIsBeta

  • Indicator for an beta system
  • Function returns Boolean

palLicenseCheck

  • Checks if system is licensed and returns true on failure
  • Function returns Boolean
  • Arguments:
    • M : Integer
      number of equations
      N : Integer
      number of variables
      NZ : Integer
      number of non-zeros
      NLNZ : Integer
      number of non-linear non-zeros
      NDisc : Integer
      number of discrete variables

palLicenseCheckSubSys

  • Indicator if subsystem is licensed (true if not licenses)
  • Function returns Boolean
  • Arguments:
    • const codes : ShortString
      license codes for system

palLicenseCheckSubX

  • Indicator if subsystem is licensed (true if not licenses, daysLeft will be >/< 0 for eval license)
  • Function returns Boolean
  • Arguments:
    • const sname : ShortString
      name of solver/subsystem
      const codes : ShortString
      license codes for system
      var daysLeft : Integer
      remaining days of eval license (negative if expired)

palLicenseGetLLine

  • Retrieve a line of the license file
  • Function returns ShortString
  • Arguments:
    • linenr : Integer
      license file line number

palLicenseGetMessage

  • Retrieves message from license check
  • Function returns Boolean
  • Arguments:
    • out msg : ShortString
      message

palLicenseGetPlatform

  • Get platform code of license
  • Function returns ShortString

palLicenseIsAcademic

  • Indicator if license is academic
  • 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
  • Function returns Boolean

palLicenseLevel(Set)

  • Access the license level
  • Property of type Integer
  • Actions
    • r
    • w

palLicenseReadU

  • Reads license file in various line formats
  • Function returns Boolean
  • Arguments:
    • const filename : ShortString
      name of the license file to read
      out msg : ShortString
      message
      var rc : Integer
      return code

palLicenseRegisterGAMS

  • Registers a line of the license file
  • Procedure
  • Arguments:
    • linenr : Integer
      license file line number
      const liceline : ShortString
      license file line

palLicenseRegisterGAMSDone

  • Completion of license registration
  • Procedure

palLicenseRegisterSystem

  • Registers the system to be licensed
  • Procedure
  • Arguments:
    • numcodes : Integer
      number of license codes for system
      const codes : ShortString
      license codes for system
      magicnum : Integer
      magic number

palLicenseSolverCheck

  • Checks if system with codes is licensed and returns true on failure uses registered size
  • Function returns Boolean
  • Arguments:
    • const codes : ShortString
      license codes for system

palLicenseSolverCheckSizes

  • Checks if system with codes is licensed and returns true on failure uses sizes from arguments
  • Function returns Boolean
  • Arguments:
    • const codes : ShortString
      license codes for system
      M : Integer
      number of equations
      N : Integer
      number of variables
      NZ : Integer
      number of non-zeros
      NLNZ : Integer
      number of non-linear non-zeros
      NDisc : Integer
      number of discrete variables

palLicenseValidation

  • Validates license and returns true on failure
  • Function returns Boolean

palPrintDemoMessage

  • Retrieves message about demo usage. Return indicates if message should be printed (true means print)
  • Function returns Boolean
  • Arguments:
    • out msg : ShortString
      message

palSetAuditLine

  • Sets audit string
  • Procedure
  • Arguments:
    • const auditline: ShortString
      audit line

palSetSystemName

  • Sets system name and sets up a generic audit string
  • Procedure
  • Arguments:
    • const sname : ShortString
      name of solver/subsystem

Enumerated Constants

  • palModelSizeLimits
    • palLDemo = 2000
    • palNLDemo = 1000
    • palLCommunit = 5000
    • palNLCommuni = 2500

Undocumented Arguments

  • result
  • s