5.3.4 - KDM Print Options - JdlKDMPrintOptions

John W. Campbell

5.3.4.1 Introduction

This is an interface for objects which can check which name is to be used when a JdlKeywordDataModule parameter with an alias name or a suffixed parameter is to be printed . This will only need to be used if, for example, the print option to be used depends on the value of some other parameter(s). There is also a method to reset the numbers of subsets parameters again based, for example, on the values of other parameters.

Definition and methods:

Class Details
Accessible Fields
Methods

5.3.4.2 Class Details

Package:
Jdl.JdlKDM;
Class name:
JdlKDMPrintOptions
Class definition:
public interface JdlKDMPrintOptions
Extends:
Object
Implements:
none
Actions:
none

5.3.4.3 Accessible Fields

No fields with public, package or protected access defined.

5.3.4.4 Methods

5.3.4.4.1 Introduction

This interface has two methods to perform the required checks.

Method:

Use alias name - use_alias_name
Use parameter suffixes - use_suffixed_names
Reset numbers of sets/subsets - reset_set_subset_numbers

5.3.4.4.2 Use alias name - use_alias_name

This method checks to see whether the alias or normal parameter name is to be used.

Method Definition:
public boolean use_alias_name(JdlKeywordDataModule kdm_obj, String parnam, int ipar)
Parameters List:
kdm_obj
The JdlKeywordDataModule object to which the parameter belongs.
parnam
The parameter name.
ipar
The parameter number (from 1 upwards)
Method Return:
Return true to use the alias name or false to use the orginal name.

5.3.4.4.3 Use parameter suffixes - use_suffixed_names

This method checks to see whether the suffixed parameter names are to be used when printing a suffixed parameter.

Method Definition:
public boolean use_suffixed_names(JdlKeywordDataModule kdm_obj, String parnam, int ipar)
Parameters List:
kdm_obj
The JdlKeywordDataModule object to which the parameter belongs.
parnam
The parameter name.
ipar
The parameter number (from 1 upwards)
Method Return:
Return true to use the suffixed names or false to use the name without an added suffix.

5.3.4.4.4 Reset numbers of sets/subsets - reset_set_subset_numbers

This method may be used to update the numbers sets and/or subsets parameters prior to writing/printing using the writeKDM() methods where the number of sets and numbers of subsets are not explicitly given.

Method Definition:
public void reset_set_subset_numbers(JdlKeywordDataModule kdm_obj, int max_sets, int max_subsets, JdlInt nums, int[] numss)
Parameters List:
kdm_obj
The JdlKeywordDataModule object.
max_sets
The maximum allowed value for the number of sets.
max_subsets
The maximum allowed value for the number of subsets.
nums
This contains on input the current number of sets which may be changed if required.
max_subsets
The maximum allowed value for the number of subsets.
numss
This is an array containing the numbers of subsets parameter for each possible set. The method may be used to update these values as required. Any updated values will be automatically updated in the keyword data module.

⇑ Up 2   ⇑ Up 1   ⇑ Top of this