Chapter 3KCMS Test Suite Commands
In This Chapter
This chapter alphabetically presents each of the kcmstest
test script commands. For each command, the chapter provides a summary description,
the command syntax, and a detailed description of each keyword. Generally,
all of the command keywords must be used for a command to execute successfully.
The text indicates when certain keywords do not need to be used.
Table 3-1 lists each of the test script commands
and the KCMS "C" API function call to which it corresponds.
Table 3-1 Test Script Commands and "C" API Functions
Test Script Command | KCMS "C" API Function |
|---|
CONNECT: | KcsConnectProfile() |
CREATE: | KcsCreateProfile() |
EVAL: | KcsEvaluate() |
FREE: | KcsFreeProfile() |
GETATTR: | KcsGetAttribute() |
LOAD: | KcsLoadProfile() |
LOG: | No specific function. It writes to a log file. |
MODIFYLH: | KcsModifyLoadHints() |
OPTIMIZE: | KcsOptimizeProfile() |
SAVE: | KcsSaveProfile() |
SETATTR: | KcsSetAttribute() |
UPDATE: | KcsUpdateProfile() |
CONNECT:
CONNECT: Command Description
CONNECT: functionality corresponds to the KcsConnectProfile() call. When this command is command is interpreted,
the KcsConnectProfile() function is executed and the status
is reported back from the kcmstest command display to
the test log.
CONNECT: Command Syntax Example
CONNECT:NAME=reverse; Count=2; Reference=monitor; Reference=scanner; Operation=Forward;
CONNECT: Keywords and Values
Table 3-2 presents the CONNECT:
command keywords and their descriptions.
Table 3-2 CONNECT: Command Keywords
Keyword | Description |
|---|
Name= | Is the reference name that will be assigned to the new profile if the CONNECT:command completes successfully. |
Reference= | Is the name that was assigned when the profiles were loaded or created. |
Count= | Is the number of profiles that will be used in the connection. Currently two
profiles are used to connect forward and reverse profiles. Three profiles
are used to connect simulate profiles. |
Operation= | Defines the operation load hint that will be used to connect the new profile.
This keyword has the operation and content hint values shown in Table 3-3.
It indicates what transforms in the profiles will be loaded and connected
in the final (complete) profile. An Operation= keyword
can appear more than once in a single script command. Multiple operations
are logically OR'd together. |
XStatus= | The default expected status is KcsSuccess. If the
script command is expected to complete successfully, the XStatus= keyword is not required. In cases where a script command is expected
to return a non- success status, the XStatus= is followed
by the corresponding expected, non-success status in hexadecimal format. |
Table 3-3 shows the acceptable values for the Operation= keyword.
Table 3-3 CONNECT: Command Operation= Keyword
Values
Value | Load Hint Set |
|---|
Forward; | KcsOpForward |
Reverse; | KcsOpReverse |
Simulate; | KcsOpSimulate |
Gamut; | KcsOpGamutTest |
OpsAll; | KcsOpAll |
ContUnkn; | KcsContUnknown |
Graphics; | KcsContGraphics |
Image; | KcsContImage |
ColorMtrc; | KcsContColorimetric |
ContAll; | KcsContAll |
CREATE:
CREATE: Command Description
CREATE: functionality corresponds to the KcsCreateProfile() call. When this command is interpreted, the KcsCreateProfile() function is executed and the status is reported
back from the kcmstest command display to the test log.
The CREATE: command creates a generic profile with the
default CMM Id.
CREATE: Command Syntax Example
CREATE:Reference=umax;
CREATE: Keywords and Values
Table 3-4 presents the CREATE:
command keywords and their descriptions.
Table 3-4 CREATE: Command Keywords
Keyword | Description |
|---|
Reference= | Is the name that this profile will be referred to in subsequent script commands.
In the context of the test script, it is the profile name. |
XStatus= | The default expected status is KcsSuccess. If the
script command is expected to complete successfully, the XStatus keyword is not required. In cases where a script command is expected
to return a non-success status, the keyword is followed by the corresponding
expected, non-success status in hexadecimal format. |
EVAL:
EVAL: Command Description
EVAL: functionality corresponds to the KcsEvaluate() call. When this command is interpreted, the KcsEvaluate() function is executed and the status is reported back
from the kcmstest command display to the test log.
EVAL: Command Syntax Example
EVAL:Reference=forward; SourcePixLayout=RGBInterLeaved; DestPixLayout=RGBInterLeaved; Callbacks=; ImageIn=test;
ImageOut=None; Operation=Forward;
EVAL: Keywords and Values
Table 3-5 presents the EVAL: command
keywords and their descriptions.
Table 3-5 EVAL: Command Keywords
Keyword | Description |
|---|
Reference= | Is the name that was assigned when the profiles were connected. |
SourcePixLayout= | Sets the pixel layout structure and, if necessary, restructures the input
data. This keyword has one of the following values: RGBInterLeaved (also called component- or pixel-interleaved) RGBPlanar RGBRowInterleaved (also
called planar- or band-interleaved) (For details on these values, see the description of the KcsPixelLayout structure
in the SDK manual KCMS Application Developer's Guide) |
DestPixLayout= | Sets the pixel layout structure. This keyword has one of the following values: RGBInterLeaved RGBPlanar RGBRowInterleaved |
ImageIn= | Is the image file name that will be processed in the EVAL:
command. The image file must be located in the kcmstest/images directory. Only images stored in the TIFF file format
can be processed by kcmstest at this time. |
ImageOut= | Is the image file name that will be output from the EVAL:
command. The image file will be located in the kcmstest/images directory. Only TIFF image file format can be output by kcmstest at this time. In the event that no image output is required,
specify None for the image name. Note that TIFF files
can use up your disk space very quickly. Be sure to remove them after inspection.
Specify NULL if you do not want to save the output image. |
Operation= | Defines the operation load hint that will be used to evaluate the data. This
keyword has the operation and content hint values listed inTable 3-6.
In the table, the keyword value is followed by the corresponding value set
in the Operations parameter passed to the KcsEvaluate() function. Only one direction and one content operation hint can
appear in a single EVAL: script command, and the complete
profile that is evaluated must include the matching operation hint (transform).
If, for example, you connect profiles requesting the Reverse
operation, and you evaluate the resulting profile requesting the Forward operation, you will get an error. |
Callbacks= | Causes kcmstest to perform a KcsSetCallback()
call. Callbacks are registered in the log file. |
XStatus= | The default expected status is KcsSuccess. If the
script command is expected to complete successfully, the XStatus= keyword is not required. In cases where a script command is expected
to return a non-success status, the keyword is followed by the corresponding
expected, non-success status in hexadecimal format. |
Table 3-6 presents the acceptable values for the EVAL: command Operation= keyword.
Table 3-6 EVAL: Command Operation= Keyword
Values
Value | Value Set |
|---|
Forward; | KcsOpForward |
Reverse; | KcsOpReverse |
Simulate; | KcsOpSimilate |
Gamut; | KcsOpGamutTest |
ContUnkn; | KcsContUnknown |
Graphics; | KcsContGraphics |
Image; | KcsContImage |
ColorMtrc; | KcsContColorimetric |
Note - The EVAL: command also produces pixel evaluation
speeds, in terms of 24-bit pixels per second, for the log
file.
FREE:
FREE: Command Description
FREE: functionality corresponds to the KcsFreeProfile() call. When this command is interpreted, the KcsFreeProfile() function is executed and the status is reported
back from the kcmstest command display to the test log.
| 
Previous