API Docs for:
Show:

ControlVariables Class

Defined in: c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:328

Stores the variables used in step evaluators

Methods

clear

()

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:415

Clear the control variables collection

get

(
  • name
)
Any

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:378

Gets a variable value

Parameters:

  • name String

    The variable name

Returns:

Any:

The variable value

getNameValuePair

(
  • name
)
Object

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:390

Gets a pair with name and value

Parameters:

  • name String

    The variable name

Returns:

Object:

A pair with the variable name and value

isDefined

(
  • name
)
Boolean

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:367

Checks if some variable is already defined

Parameters:

  • name String

    The variable name

Returns:

Boolean:

A boolean indicating if the variable is already defined

remove

(
  • name
)
Object

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:404

Remove some variable from the control variables collection

Parameters:

  • name String

    The variable name

Returns:

Object:

A pair with the removed variable name and value

set

(
  • name
  • value
)
String

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:336

Sets a variable value

Parameters:

  • name String

    The variable name

  • value String

    The variable value

Returns:

String:

A formatted key=value pair representing the defined variable

setIfUndefined

(
  • name
  • value
)
String

Defined in c:\alcides\fortes\projetos\Sideshow\distr\sideshow.js:355

Sets a variable if not defined yet

Parameters:

  • name String

    The variable name

  • value String

    The variable value

Returns:

String:

A formatted key=value pair representing the defined variable