ACBC Functions

Top  Previous  Next

ACBC Functions are only applicable in studies containing Adaptive CBC exercises.

 

Sawtooth Script:

Description:

ACBCBYOLabel(ExerciseName, Attribute#)

Returns the level label selected in the BYO question for the indicated attribute#.

ACBCBYOValue(ExerciseName, Attribute#)

Returns the level value selected in the BYO question for the indicated attribute#.

ACBCCalibrationText()

Displays ACBC Calibration question text from the Concept Text settings area.  Must be used within an ACBC Calibration question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCCurrentCalibration()

Returns the index of the current Calibration Concept. Needs to be used inside of an ACBC Calibration.

ACBCCurrentChoiceTask()

 

Returns the index of the current Choice Task. Needs to be used inside of an ACBC ChoiceTask.

ACBCCurrentScreener()

Returns the index of the current Screening Task. Needs to be used inside of an ACBC Screener.

ACBCIsMustHave

(ExerciseName, Attribute#, Level#)

Returns True if the attribute and level specified has been declared a "Must Have."

ACBCIsUnacceptable

(ExerciseName, Attribute#, Level#)

Returns True if the attribute and level specified has been declared "Unacceptable."  If referencing a Summed Price attribute, specify a price value rather than the Level#.

ACBCMustHaveRules()

Displays all previous "Must Have" rules.  Must be used within an ACBC Must Have question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCMustHaveText()

Displays "Must Have" question text from "No Rules Exist" and "Rules Exist" labels.  Must be used within an ACBC Must Have question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCNumCalibrations()

Returns the total number of Calibration Concepts. Can use this inside of a ACBCCalibration. If used outside of an ACBCCalibration needs to have the ACBCExerciseName passed as a parameter.

ACBCNumChoiceTasks()

Returns the total number of Choice Tasks. Can use this inside of a ACBCChoiceTask. If used outside of an ACBCChoiceTask needs to have the ACBCExerciseName passed as a parameter.

ACBCNumScreenedInConcepts(ExerciseName)

Returns the total number of Product Concepts marked "a possibility" by the respondent.

NOTE: Does not include the BYO if it is included in the tournament.

ACBCNumScreeners()

Returns the total number of Screening Tasks. Can use this inside of a ACBCScreener. If used outside of an ACBCScreener needs to have the ACBCExerciseName passed as a parameter.

ACBCPriceLevelText()

Returns the price associated with the current level to the screen.  Must be used within a ACBCBYO question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCUnacceptableRules()

Displays all previous "Unacceptable" rules.  Must be used within an ACBC Unacceptable question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCUnacceptableText()

Displays "Unacceptable" question text from "No Rules Exist" and "Rules Exist" labels.  Must be used within an ACBC Unacceptable question. This function is different than other Sawtooth Script.  See Location Specific Functions.

ACBCWinnerLabel(ExerciseName, Attribute#)

Returns the level label for the choice tournament winner for the indicated attribute# (if no tournament exists, returns nothing).  Hint: use ACBCNumScreenedInConcepts to determine if you should skip a question in which you might show the tournament winner.

ACBCWinnerValue(ExerciseName, Attribute#)

Returns the level value for the choice tournament winner for the indicated attribute# (if no tournament exists, returns nothing).  Hint: use ACBCNumScreenedInConcepts to determine if you should skip a question in which you might show the tournament winner.

BYOCondText(ExerciseName, CondText#)

 

BYOCondText(ExerciseName, CondText#,

 XPos,YPos)

Within a BYO question, returns the conditional text/graphic element for the CondText# relationship from the conditional relationship table.  If XPos and YPos (values expressed in Pixels) are given, then the conditional element is shown at that fixed position on the screen (hovering graphic).

 

For additional flexibility in Sawtooth Scripting, see the Unverified Perl documentation.

 

 

Page link: http://www.sawtoothsoftware.com/help/lighthouse-studio/manual/index.html?acbcfunctions.html