TAiwVariant Class Reference
#include
<mw/AiwVariant.h>
Link against: ServiceHandler.lib
Detailed Description
Variant data class to hold a value of a TAiwGenericParam instance. The variant contains a data type and a value. This class is attached to TAiwGenericParam instance which holds the semantic type of the value.
See also: TAiwGenericParam
Constructor & Destructor Documentation
TAiwVariant ( )
Default constructor. Initializes this variant to be empty.
TAiwVariant ( TInt32 )
| TAiwVariant | ( | TInt32 | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const TUid & )
| TAiwVariant | ( | const TUid & | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const TTime & )
| TAiwVariant | ( | const TTime & | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const TDesC & )
| TAiwVariant | ( | const TDesC & | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const HBufC * )
| TAiwVariant | ( | const HBufC * | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const TDesC8 & )
| TAiwVariant | ( | const TDesC8 & | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const RFile & )
| TAiwVariant | ( | const RFile & | aValue | ) | [inline] |
Constructor from a value.
| Parameter | Description | | aValue | The value to set for this variant object. |
TAiwVariant ( const TAiwVariant & )
Copy constructor. Does not take ownership of data.
| Parameter | Description | | aSrc | The source object. |
Member Function Documentation
AsData ( )
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
AsDes ( )
| IMPORT_C TPtrC | AsDes | ( | ) | const |
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
AsFileHandle ( )
| IMPORT_C RFile | AsFileHandle | ( | ) | const |
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
AsTInt32 ( )
| IMPORT_C TInt32 | AsTInt32 | ( | ) | const |
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
AsTTime ( )
| IMPORT_C TTime | AsTTime | ( | ) | const |
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
AsTUid ( )
| IMPORT_C TUid | AsTUid | ( | ) | const |
Returns the value held by this variant.
Returns: The value held by this variant. If the data type does not match the function, the default initialized data is returned.
Get ( TInt32 & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
Get ( TUid & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
Get ( TPtrC & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
Get ( TTime & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
Get ( TPtrC8 & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
Get ( RFile & )
Retrieves the value held by this variant.
| Parameter | Description | | aValue | If this variant's type does not match the parameter type, the parameter will not be modified. |
Returns: ETrue if aValue was set, EFalse if types did not match.
IsEmpty ( )
|
TBool
| IsEmpty | ( | ) | const [inline] |
Returns ETrue if this variant is empty (it does not hold any value).
Reset ( )
Deletes possibly set value and resets this variant to empty.
Set ( TInt32 )
| IMPORT_C void | Set | ( | TInt32 | aValue | ) | |
Sets integer value to this variant. The previous value is overwritten.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | Value for this variant object to hold. |
Set ( const TUid & )
| IMPORT_C void | Set | ( | const TUid & | aValue | ) | |
Sets unique ID value to this variant. The previous value is overwritten.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | Value for this variant object to hold. |
Set ( const TTime & )
| IMPORT_C void | Set | ( | const TTime & | aValue | ) | |
Sets date and time value to this variant. The previous value is overwritten.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | Value for this variant object to hold. |
Set ( const TDesC & )
| IMPORT_C void | Set | ( | const TDesC & | aValue | ) | |
Sets constant text reference to this variant.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | Text value for this variant object to hold. |
Set ( const HBufC * )
| void | Set | ( | const HBufC * | aValue | ) | [inline] |
Sets constant text reference to this variant.
| Parameter | Description | | aValue | Text value for this variant object to hold. Ownership is not taken. |
Set ( const TDesC8 & )
| IMPORT_C void | Set | ( | const TDesC8 & | aValue | ) | |
Sets constant 8-bit text reference to this variant.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | Text value for this variant object to hold. |
Set ( const RFile & )
| IMPORT_C void | Set | ( | const RFile & | aValue | ) | |
Sets RFile file handle to this variant.
- Post-condition
- *this == aValue
| Parameter | Description | | aValue | File handle for this variant object to hold. |
TypeId ( )
Returns the type id of data this variant object is holding.
operator= ( const TAiwVariant & )
Assignment operator. Does not take ownership of data.
| Parameter | Description | | aValue | The source object. |
operator= ( const TTime & )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( const TUid & )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( TInt32 )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( const TDesC & )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( const HBufC * )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( const TDesC8 & )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |
operator= ( const RFile & )
Assignment operator for the variant.
| Parameter | Description | | aValue | The source object. |