Difference between revisions of "Contest definition"

From DXLog.net
Jump to navigation Jump to search
(Configuration screen control)
(Configuration screen control)
Line 121: Line 121:
  
 
* '''CFG_GRID_ERRORTEXT'''
 
* '''CFG_GRID_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in GRIDSQUARE field at contest configuration screen.<br>
  
 
* '''CFG_GRID_MANDATORY'''
 
* '''CFG_GRID_MANDATORY'''
 +
 +
Is GRIDSQUARE field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_GRID_RGX_CHECK'''
 
* '''CFG_GRID_RGX_CHECK'''
 +
 +
Regex expression which will be used to verify if data entered in GRIDSQUARE field at contest configuration screen is valid.<br>
  
 
* '''CFG_ITUZONE_ERRORTEXT'''
 
* '''CFG_ITUZONE_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in ITU field at contest configuration screen.<br>
  
 
* '''CFG_ITUZONE_MANDATORY'''
 
* '''CFG_ITUZONE_MANDATORY'''
 +
 +
Is ITU field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_MYDXCC_ERRORTEXT'''
 
* '''CFG_MYDXCC_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in DXCC field at contest configuration screen.<br>
  
 
* '''CFG_MYDXCC_MANDATORY'''
 
* '''CFG_MYDXCC_MANDATORY'''
 +
 +
Is DXCC field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_OPNAME_ERRORTEXT'''
 
* '''CFG_OPNAME_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in OPNAME field at contest configuration screen.<br>
  
 
* '''CFG_OPNAME_MANDATORY'''
 
* '''CFG_OPNAME_MANDATORY'''
 +
 +
Is OPNAME field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_POWER_ERRORTEXT'''
 
* '''CFG_POWER_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in POWER field at contest configuration screen.<br>
  
 
* '''CFG_POWER_MANDATORY'''
 
* '''CFG_POWER_MANDATORY'''
 +
 +
Is POWER field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_POWER_RGX_CHECK'''
 
* '''CFG_POWER_RGX_CHECK'''
 +
 +
Regex expression which will be used to verify if data entered in POWER field at contest configuration screen is valid.<br>
 +
  
 
* '''CFG_STATE_ERRORTEXT'''
 
* '''CFG_STATE_ERRORTEXT'''
 +
 +
Defines error text which will be shown in case that user enters wrong data in STATE/PROVINCE/OTHER field at contest configuration screen.<br>
  
 
* '''CFG_STATE_FROM'''
 
* '''CFG_STATE_FROM'''
 +
  
 
* '''CFG_STATE_MANDATORY'''
 
* '''CFG_STATE_MANDATORY'''
 +
 +
Is STATE/PROVINCE/OTHER field mandatory (needs to be filled) or can be blank.<br>
 +
 +
Acceptable values are: YES/NO<br>
 +
Default value: NO<br>
  
 
* '''CFG_STATE_RGX_CHECK'''
 
* '''CFG_STATE_RGX_CHECK'''
 +
 +
Regex expression which will be used to verify if data entered in STATE/PROVINCE/OTHER field at contest configuration screen is valid.<br>
  
 
==Band and mode specific==
 
==Band and mode specific==
  
 
==Entry field definitions==
 
==Entry field definitions==

Revision as of 14:51, 7 February 2014

Description

Rules for each of the contests are more or less different from each other.
It can be difference in points per qso calculations, multiplier determination and calculations etc.

To support all these different rules and to allow easier adding / changing contest rules in DXLog.net, all parameters in contest rules are defined and controlled through contest config files.
Contest config files are plain text files which are installed in Contest sub-folder in DXLog.net installation folder.

When application is started, content of Contest folder is copied into ApplicationData folder in your Windows OS.
During copying process, DXLog.net compares modify date of each file in installation folder with version in ApplicationData folder.
If newer version already exists in ApplicationData folder, file wouldn't be copied there.

User can change existing or create new files in Application folder, in case it is needed for some testing purposes, or if user wants to create new contest definition file to support some new contest.

File structure

Each line in contest config file usually contains of KEY + VALUE pairs.
This pair is separated by "=" sign.
For example:

 CONTEST_NAME=9A CW 
This means that field KEY is CONTEST-NAME, and 9A CW is value for that field.

General contest description

These keys are used for general contest description in config file, such as contest name, link to the rules etc.

  • CONTESTGROUP

Used for group contest when displaying on config screen for contest selection.
For example: Digital, 9A Local Contest etc.

  • CONTESTNAME

Contest name as it will be shown and recognized in contest selection box.
Note: this can be same as cabrillo contest name, but usually it is full contest name.
This field is mandatory and must be unique for all files in contest definition folder.

  • CONTESTRULES

Link to contest rules.

  • CONTESTWEB

Link to contest web.

Configuration screen control

  • CATEGORIES

List of available categories separated by ";" to build category selection list at contest configuration screen.

Default value: Single operator;Single operator assisted;Multioperator, single transmitter;Multioperator, two transmitter;Multi operator, multi-transmitter

  • CATEGORY_MODES

List of available modes separated by ";" to build mode selection list at contest configuration screen.

Default value: CW;SSB;MIXED

  • CLASS

List of available classes separated by ";" to build class selection list at contest configuration screen.

Default value: High;Low;QRP

  • OVERLAY

List of available category overlays separated by ";" to build overlay selection list at contest configuration screen.

Default value: ---;Band restricted;Radio club;Dxpedition;Headquarters;Open;Restricted;Novice;Classic;Rookie;Tribander/Single element;QRP;Fixed station;Portable station

  • CFG_MULT

Controls exchange field at contest configuration screen.
Acceptable values are: YES/NO.

If set to YES, exchange field will be enabled for entering data. Usually in exchange field user enters own multiplier, zone or some other info.

Default value: NO

  • CFG_MULT_DX_ALLOWED

Is "DX" acceptable entry in exchange field at contest configuration screen.
For example in ARRL DX Contest, all USA/VE stations needs to enter their state/province, while all other stations enters DX here.

Acceptable values are: YES/NO
Default value: NO

  • CFG_MULT_MANDATORY

Is exchange field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_MULT_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in exchange field at contest configuration screen.
For example, in ARRL DX Contest, user enters state abbreviation which isn't on predefined list.

  • CFG_MULT_FROM


  • CFG_MULT_RGX_CHECK

Regex expression which will be used to verify if data entered in exchange field at contest configuration screen is valid.

  • CFG_CQZONE_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in WAZ field at contest configuration screen.

  • CFG_CQZONE_MANDATORY

Is WAZ field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO


  • CFG_GRID_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in GRIDSQUARE field at contest configuration screen.

  • CFG_GRID_MANDATORY

Is GRIDSQUARE field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_GRID_RGX_CHECK

Regex expression which will be used to verify if data entered in GRIDSQUARE field at contest configuration screen is valid.

  • CFG_ITUZONE_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in ITU field at contest configuration screen.

  • CFG_ITUZONE_MANDATORY

Is ITU field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_MYDXCC_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in DXCC field at contest configuration screen.

  • CFG_MYDXCC_MANDATORY

Is DXCC field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_OPNAME_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in OPNAME field at contest configuration screen.

  • CFG_OPNAME_MANDATORY

Is OPNAME field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_POWER_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in POWER field at contest configuration screen.

  • CFG_POWER_MANDATORY

Is POWER field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_POWER_RGX_CHECK

Regex expression which will be used to verify if data entered in POWER field at contest configuration screen is valid.


  • CFG_STATE_ERRORTEXT

Defines error text which will be shown in case that user enters wrong data in STATE/PROVINCE/OTHER field at contest configuration screen.

  • CFG_STATE_FROM


  • CFG_STATE_MANDATORY

Is STATE/PROVINCE/OTHER field mandatory (needs to be filled) or can be blank.

Acceptable values are: YES/NO
Default value: NO

  • CFG_STATE_RGX_CHECK

Regex expression which will be used to verify if data entered in STATE/PROVINCE/OTHER field at contest configuration screen is valid.

Band and mode specific

Entry field definitions