Programmer Guide/Macro Library/Kernal/CAppSetup: Difference between revisions

From STX Wiki
Jump to navigationJump to search
(initial import)
 
No edit summary
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{DISPLAYTITLE:{{SUBPAGENAME}}}}
{{TOC limit|4}}
==CAppSetup : CObj==
==CAppSetup : CObj==


The CAPPSETUP class is still being documented
The CAPPSETUP class is still being documented


====CAppSetup Member Functions====
===CAppSetup Member Functions===


=====CONSTRUCT profileType profileSubType profileName=====
====CONSTRUCT profileType profileSubType profileName====


=====Usage:=====
=====Usage:=====
Line 34: Line 35:
Viewer1<nowiki>|</nowiki>Viewer2|Viewer3|DSP1App|DSP1Copy|DSP1Amplify|DSP1Normalize|DSP1AGC|DSP1Filter|DSP1Bandpass|DSP1Spectrum|DSP1DeNoise|DSP1Irrelevance
Viewer1<nowiki>|</nowiki>Viewer2|Viewer3|DSP1App|DSP1Copy|DSP1Amplify|DSP1Normalize|DSP1AGC|DSP1Filter|DSP1Bandpass|DSP1Spectrum|DSP1DeNoise|DSP1Irrelevance


=====DELETEPROFILE=====
====DELETEPROFILE====


=====Result:=====
=====Result:=====
Line 44: Line 45:
Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.
Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.


=====DESTRUCT=====
====DESTRUCT====


=====Description:=====
=====Description:=====
Line 50: Line 51:
Destroy the CAppSetup instance and clean up.
Destroy the CAppSetup instance and clean up.


=====LISTPROFILES [table]=====
====LISTPROFILES [table]====


=====Usage:=====
=====Usage:=====
Line 68: Line 69:
Creates a sorted list of profile names for the current profile type.
Creates a sorted list of profile names for the current profile type.


=====LOAD<nowiki>|</nowiki>LOADPROFILE [profileName]=====
====LOAD<nowiki>|</nowiki>LOADPROFILE [profileName]====


=====Usage:=====
=====Usage:=====
Line 86: Line 87:
Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.
Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.


=====RESTART=====
====RESTART====


=====Usage:=====
=====Usage:=====
Line 94: Line 95:
=====Description:=====
=====Description:=====


=====RUN wait ; audioSet ; audioSegment ; channel=====
====RUN wait ; audioSet ; audioSegment ; channel====


=====Usage:=====
=====Usage:=====
Line 121: Line 122:
Run the application.
Run the application.


=====SAVEPROFILEAS=====
====SAVEPROFILEAS====


=====Result:=====
=====Result:=====
Line 131: Line 132:
Show a dialog box prompting the user to save the current profile under a new name.
Show a dialog box prompting the user to save the current profile under a new name.


=====SAVE<nowiki>|</nowiki>SAVEPROFILE [profileName]=====
====SAVE<nowiki>|</nowiki>SAVEPROFILE [profileName]====


=====usage:=====
=====usage:=====
Line 149: Line 150:
Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.
Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.


=====SET parameter=value [parameterX=valueX ...]=====
====SET parameter=value [parameterX=valueX ...]====


=====Usage:=====
=====Usage:=====
Line 167: Line 168:
Set one or multiple parameter values.
Set one or multiple parameter values.


=====SETUPDIALOG=====
====SETUPDIALOG====


=====Result:=====
=====Result:=====
Line 177: Line 178:
Show the setup dialog for the instance's current profile.
Show the setup dialog for the instance's current profile.


=====WAIT=====
====WAIT====


=====Usage:=====
=====Usage:=====

Latest revision as of 11:23, 28 November 2018

CAppSetup : CObj

The CAPPSETUP class is still being documented

CAppSetup Member Functions

CONSTRUCT profileType profileSubType profileName

Usage:
profileType the name of the application profile type (see below)
profileSubType the name of the sub-profile type to use or * if there is no sub-profile type
profileName the profile name
Result:

0

Description:

Initializes a new CAppSetup instance with data from the profile passed.

The following application profile types are supported:

Viewer1|Viewer2|Viewer3|DSP1App|DSP1Copy|DSP1Amplify|DSP1Normalize|DSP1AGC|DSP1Filter|DSP1Bandpass|DSP1Spectrum|DSP1DeNoise|DSP1Irrelevance

DELETEPROFILE

Result:

1 on success, 0 on failure

Description:

Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.

DESTRUCT

Description:

Destroy the CAppSetup instance and clean up.

LISTPROFILES [table]

Usage:
table name of target table or * if a table should be created.
Result:

a table containing a list of all profile ids for the current instance's profile type

Description:

Creates a sorted list of profile names for the current profile type.

LOAD|LOADPROFILE [profileName]

Usage:
profileName the name of the application profile to load
Result:

void

Description:

Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.

RESTART

Usage:
Result:
Description:

RUN wait ; audioSet ; audioSegment ; channel

Usage:
wait 1 if the macro/script should wait for the application to finish before continuing to the next command.
audioSet the audio set IREF
audioSegment the audio segment
channel the audio channel
Result:

0 for success, 1 on failure

Description:

Run the application.

SAVEPROFILEAS

Result:

1

Description:

Show a dialog box prompting the user to save the current profile under a new name.

SAVE|SAVEPROFILE [profileName]

usage:
profileName the name of the application profile
result:

void

description:

Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.

SET parameter=value [parameterX=valueX ...]

Usage:
parameter=value set the specified parameter to the specified value
Result:

void

Description:

Set one or multiple parameter values.

SETUPDIALOG

Result:

the string 'Okay' if the user pressed the OK button, or 'Cancel' if the user pressed the Cancel button.

Description:

Show the setup dialog for the instance's current profile.

WAIT

Usage:

WAIT exit

Parameters:
exit
1 if application should exit, 0 if the application should wait until the user closes it.
Retrieved from "https://mediawiki.kfs.oeaw.ac.at/stx/docs/wiki/index.php?title=Programmer_Guide/Macro_Library/Kernal/CAppSetup&oldid=10251"

Navigation menu

Personal tools