
86 Appendix A3 Modelbase and OxPack
Modelbase::SendVarStatus
virtual SendVarStatus();
Return value
Returns an array, where each item is an array defining the type of variable:
(1) string: status text,
(2) character: status letter,
(3) integer: status flags,
(4) integer: status group.
Description
Called by OxPack as part of model formulation, after IsCrossSection,tode-
termine the variable types which are available in the model formulation dialog.
For example, the Modelbase default is:
return
{{ "&Y variable", ’Y’, STATUS_GROUP + STATUS_ENDOGENOUS, Y_VAR},
{ "&X variable", ’X’, STATUS_GROUP, X_VAR}};
The status text, and is used on the data selection dialog button. The status letter
used to indicate the presence of the status. The status flags can be:
• STATUS
DEFAULT: is default: no status letter displayed;
• STATUS
ENDOGENOUS: apply to first (non-special) variable at lag 0;
• STATUS
GROUP : is a group (each variable is in only one group);
• STATUS
GROUP2: is a second group (each variable is only in one of each
group);
• STATUS
GROUP3: is a third group (each variable is only in one of each
group);
• STATUS
GROUP4: is a fourth group (each variable is only in one of each
group);
• STATUS
GROUP5: is a fifth group (each variable is only in one of each
group);
• STATUS
MULTIPLE: multiple instances of a variable are allowed
• STATUS
MULTIVARIATE: apply to all (non-special) variables at lag 0;
• STATUS
ONEONLY: only one variable can have this status.
• STATUS
SPECIAL: apply to all special variables;
• STATUS
TRANSFORM: is a transformation;
Some flags can be combined by adding the values together.
As a second example, consider the status definitions of the DPD class:
return
{{ "&Y variable", ’Y’, STATUS_GROUP + STATUS_ENDOGENOUS, Y_VAR},
{ "&X variable", ’X’, STATUS_GROUP, X_VAR},
{ "&Instrument", ’I’, STATUS_GROUP2, I_VAR},
{ "&Level instr",’L’, STATUS_GROUP2, IL_VAR},
{ "Yea&r", ’r’, STATUS_GROUP + STATUS_ONEONLY, YEAR_VAR},
{ "I&ndex", ’n’, STATUS_GROUP + STATUS_ONEONLY, IDX_VAR}
};
Commentaires sur ces manuels