#include <dotXSIParam.h>
Inheritance diagram for CdotXSIParam:
Public Member Functions |
|
| CdotXSIParam () | |
| CdotXSIParam (CSIBCString *i_sName, SI_Int i_nVariantType) | |
| CdotXSIParam (SI_Char *i_sName, SI_Int i_nVariantType) | |
| CdotXSIParam (CSIBCString *i_sName, SI_Int i_nVariantType, SI_Int i_nTweakType) | |
| CdotXSIParam (SI_Char *i_sName, SI_Int i_nVariantType, SI_Int i_nTweakType) | |
| CdotXSIParam (CSIBCString *i_sName, SI_TinyVariant i_vValue) | |
| CdotXSIParam (SI_Char *i_sName, SI_TinyVariant i_vValue) | |
| virtual | ~CdotXSIParam () |
| SI_Void | GetValue (SI_TinyVariant *o_vValue) |
| SI_Void | SetValue (SI_TinyVariant i_vValue) |
| SI_TinyVariant * | GetVariantPtr () |
| SI_Void | InitializeVarValue (SI_TinyVariant *i_pValue) |
| SI_Void | InitializeDefaultVarValue () |
A CdotXSIParam object is the interface used to access type, value, and tweaking information for a parameter within a CdotXSITemplate. The class provides accessor and mutator functions that use the SI_TinyInvariant structure.
| CdotXSIParam | ( | ) |
Default constructor. Sets the parameter to a dummy type, and initializes its value.
| CdotXSIParam | ( | CSIBCString * | i_sName, | |
| SI_Int | i_nVariantType | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName and the parameter type given by i_nVariantType. The constructor then initializes the parameter value to its default value, based on the type given. See the defines in Variant Parameter types for information on which values this parameter can take on.
| i_sName | Name of the new parameter. | |
| i_nVariantType | Type of the new parameter. (See Variant Parameter types). |
| CdotXSIParam | ( | SI_Char * | i_sName, | |
| SI_Int | i_nVariantType | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName and the parameter type given by i_nVariantType. The constructor then initializes the parameter value to its default value, based on the type given. See the defines in Variant Parameter types for information on which values this parameter can take on.
| i_sName | Name of the new parameter. | |
| i_nVariantType | Type of the new parameter. (See Variant Parameter types). |
| CdotXSIParam | ( | CSIBCString * | i_sName, | |
| SI_Int | i_nVariantType, | |||
| SI_Int | i_nTweakType | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName, the parameter type given by i_nVariantType, and the Tweak type given by i_nTweakType. The constructor then initializes the parameter value to its default value, based on the type given. See the defines in Variant Parameter types for information on which values this parameter can take on. See the defines in Variant Parameter Tweak types for information on wihch values this parameter can take on.
| i_sName | Name of the new parameter. | |
| i_nVariantType | Type of the new parameter. (See Variant Parameter types). | |
| i_nTweakType | Type of tweaking control. (See Variant Parameter Tweak types). |
| CdotXSIParam | ( | SI_Char * | i_sName, | |
| SI_Int | i_nVariantType, | |||
| SI_Int | i_nTweakType | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName, the parameter type given by i_nVariantType, and the Tweak type given by i_nTweakType. The constructor then initializes the parameter value to its default value, based on the type given. See the defines in Variant Parameter types for information on which values this parameter can take on. See the defines in Variant Parameter Tweak types for information on wihch values this parameter can take on.
| i_sName | Name of the new parameter. | |
| i_nVariantType | Type of the new parameter. (See Variant Parameter types). | |
| i_nTweakType | Type of tweaking control. (See Variant Parameter Tweak types). |
| CdotXSIParam | ( | CSIBCString * | i_sName, | |
| SI_TinyVariant | i_vValue | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName. The parameter type, tweak type, and number of elements for the parameter is copied from the i_vValue parameter. The constructor the initializes the parameter value to its default value, based on the type in i_vValue. Note: the values from i_vValue are not copied from the i_vValue parameter.
| i_sName | Name of the new parameter. | |
| i_vValue | Parameter value to use the type, tweak type and number of elements information from. |
| CdotXSIParam | ( | SI_Char * | i_sName, | |
| SI_TinyVariant | i_vValue | |||
| ) |
Constructor. Sets the parameter name to the string given by i_sName. The parameter type, tweak type, and number of elements for the parameter is copied from the i_vValue parameter. The constructor the initializes the parameter value to its default value, based on the type in i_vValue. Note: the values from i_vValue are not copied from the i_vValue parameter.
| i_sName | Name of the new parameter. | |
| i_vValue | Parameter value to use the type, tweak type and number of elements information from. |
Destructor Clears the variant parameter. This destructor frees the arrays located within its parameters' value.
| SI_Void GetValue | ( | SI_TinyVariant * | o_vValue | ) |
Returns the value of this parameter in the o_vValue parameter
| o_vValue | Pointer to recieve the value of this parameter. |
Sets the value of this parameter to the value of the parameter given by i_vValue.
| i_vValue | Contains the new value for this parameter. (includes type, tweak type, and number of elements). |
Returns a pointer to the SI_TinyVariant structure that contains the type and value information for this parameter.
Initializes this parameter's value and type information with the information contained in the i_pValue parameter (includes type, tweak type, and number of elements).
| i_pValue | Pointer to the structure containing type and value information to set. |
Initializes this parameter's value to the default value, based on the type of the parameter. In general, the default value is zero (or equivalent for pointer types).