Variable Preset Functions

This group of functions can be used to add, remove, and modify Variable Presets through the API.

Click here to return to the main page. More...

Functions
void	AddVarPresetGroup (const string &in group_name)
void	AddVarPresetSetting (const string &in setting_name)
void	AddVarPresetParm (const string &in parm_ID)
void	AddVarPresetParm (const string &in parm_ID, const string &in group_name)
void	EditVarPresetParm (const string &in parm_ID, double parm_val)
void	EditVarPresetParm (const string &in parm_ID, double parm_val, const string &in group_name, const string &in setting_name)
void	DeleteVarPresetParm (const string &in parm_ID)
void	DeleteVarPresetParm (const string &in parm_ID, const string &in group_name)
void	SwitchVarPreset (const string &in group_name, const string &in setting_name)
bool	DeleteVarPresetSet (const string &in group_name, const string &in setting_name)
string	GetCurrentGroupName ()
string	GetCurrentSettingName ()
string []	GetVarPresetGroupNames ()
string []	GetVarPresetSettingNamesWName (const string &in group_name)
string []	GetVarPresetSettingNamesWIndex (int group_index)
double []	GetVarPresetParmVals ()
double []	GetVarPresetParmValsWNames (const string &in group_name, const string &in setting_name)
string []	GetVarPresetParmIDs ()
string []	GetVarPresetParmIDsWName (const string &in group_name)

Detailed Description

Function Documentation

AddVarPresetGroup()

void AddVarPresetGroup

(

const string &in

group_name

)

Add a Variable Presets group

Parameters

[in]

group_name

Variable Presets group name

AddVarPresetParm() [1/2]

void AddVarPresetParm

(

const string &in

parm_ID

)

Add a Parm to the currently active Variable Preset

Parameters

[in]

parm_ID

Parm ID

AddVarPresetParm() [2/2]

void AddVarPresetParm	(	const string &in	parm_ID,
		const string &in	group_name
	)

Add a Parm to the specified Variable Preset group

Parameters

[in]	parm_ID	Parm ID
[in]	group_name	Variable Presets group name

AddVarPresetSetting()

void AddVarPresetSetting

(

const string &in

setting_name

)

Add a setting to the currently active Variable Preset

Parameters

[in]

setting_name

Variable Presets setting name

DeleteVarPresetParm() [1/2]

void DeleteVarPresetParm

(

const string &in

parm_ID

)

Remove a Parm from the currently active Variable Preset group

Parameters

[in]

parm_ID

Parm ID

DeleteVarPresetParm() [2/2]

void DeleteVarPresetParm	(	const string &in	parm_ID,
		const string &in	group_name
	)

Remove a Parm from a Variable Preset group

Parameters

[in]	parm_ID	Parm ID
[in]	group_name	Variable Presets group name

DeleteVarPresetSet()

bool DeleteVarPresetSet	(	const string &in	group_name,
		const string &in	setting_name
	)

Delete a Variable Preset

Parameters

[in]	group_name	Variable Presets group
[in]	setting_name	Variable Presets setting name

Returns

true is successful, false otherwise

EditVarPresetParm() [1/2]

void EditVarPresetParm	(	const string &in	parm_ID,
		double	parm_val
	)

Edit the value of a Parm in the currently active Variable Preset

Parameters

[in]	parm_ID	Parm ID
[in]	parm_val	Parm value

EditVarPresetParm() [2/2]

void EditVarPresetParm	(	const string &in	parm_ID,
		double	parm_val,
		const string &in	group_name,
		const string &in	setting_name
	)

Edit the value of a Parm in the specified Variable Preset group and setting

Parameters

[in]	parm_ID	Parm ID
[in]	parm_val	Parm value
[in]	group_name	Variable Presets group name
[in]	setting_name	Variable Presets setting name

GetCurrentGroupName()

string GetCurrentGroupName

(

)

Get the currently active Variable Presets group name

Returns

Variable Presets group name

GetCurrentSettingName()

string GetCurrentSettingName

(

)

Get the currently active Variable Presets setting name

Returns

Variable Presets setting name

GetVarPresetGroupNames()

string [] GetVarPresetGroupNames

(

)

Get all Variable Preset group names

Returns

Array of Variable Presets group names

GetVarPresetParmIDs()

string [] GetVarPresetParmIDs

(

)

Get the Parm IDs contained in the currently active Variable Presets group

Returns

Array of Variable Presets Parm IDs

GetVarPresetParmIDsWName()

string [] GetVarPresetParmIDsWName

(

const string &in

group_name

)

Get the Parm IDs contained in the specitied Variable Presets group

Parameters

[in]

group_name

Variable Presets group name

Returns

Array of Parm IDs

GetVarPresetParmVals()

double [] GetVarPresetParmVals

(

)

Get the value of each Parm in the currently active Variable Preset group and setting

Returns

Array of Variable Presets Parm values

GetVarPresetParmValsWNames()

double [] GetVarPresetParmValsWNames	(	const string &in	group_name,
		const string &in	setting_name
	)

Get the value of each Parm in the specified Variable Preset group and setting

Parameters

[in]	group_name	Variable Presets group name
[in]	setting_name	Variable Presets setting name

Returns

Array of Variable Presets Parm values

GetVarPresetSettingNamesWIndex()

string [] GetVarPresetSettingNamesWIndex

(

int

group_index

)

Get the name of each settings in the specified Variable Presets group index

Parameters

[in]

group_index

Variable Presets group index

Returns

Array of Variable Presets setting names

GetVarPresetSettingNamesWName()

string [] GetVarPresetSettingNamesWName

(

const string &in

group_name

)

Get the name of each settings in the specified Variable Presets group name

Parameters

[in]

group_name

Variable Presets group name

Returns

Array of Variable Presets setting names

SwitchVarPreset()

void SwitchVarPreset	(	const string &in	group_name,
		const string &in	setting_name
	)

Change the currently active Variable Preset

Parameters

[in]	group_name	Variable Presets group name
[in]	setting_name	Variable Presets setting name