#include <mw/MSenProperties.h>
| class MSenProperties |
| Public Member Enumerations | |
|---|---|
| enum | TSenPropertiesClassType { ENotInUse, ESenXmlProperties, ESenTransportProperties, ESenHttpTransportProperties, ..., ESenLayeredVtcpTransportProperties } |
| Public Member Functions | |
|---|---|
| pure virtual HBufC8 * | AsUtf8L() |
| pure virtual HBufC8 * | AsUtf8LC() |
| pure virtual TInt | BoolPropertyL(const TDesC8 &, TBool &) |
| pure virtual MSenProperties * | Clone(TInt &) |
| pure virtual MSenProperties * | CloneL() |
| pure virtual TInt | IntPropertyL(const TDesC8 &, TInt &) |
| pure virtual TBool | IsSafeToCast(TSenPropertiesClassType) |
| pure virtual TSenPropertiesClassType | PropertiesClassType() |
| pure virtual TInt | PropertyL(const TDesC8 &, TPtrC8 &) |
| pure virtual void | ReadFromL(const TDesC8 &) |
| pure virtual TInt | SetBoolPropertyL(const TDesC8 &, const TBool) |
| pure virtual TInt | SetIntPropertyL(const TDesC8 &, const TInt) |
| pure virtual TInt | SetPropertyL(const TDesC8 &, const TDesC8 &) |
| pure virtual void | SetReader(CSenXmlReader &) |
| pure virtual void | WriteToL(RWriteStream &) |
| HBufC8 * | AsUtf8L | ( | ) | [pure virtual] |
Returns: a pointer to UTF-8 encoded descriptor. Caller takes ownership.
| HBufC8 * | AsUtf8LC | ( | ) | [pure virtual] |
Returns: a pointer to UTF-8 encoded descriptor, which is has been left on cleanup stack. Caller takes ownership.
| Parameter | Description |
|---|---|
| aName | The name identifying this property. |
| aValue | A TBool reference to be filled in with the value of the property. |
Returns: KErrNone on success, KErrSenOmitted if property has been omitted, or some of the system-wide error codes otherwise.
| MSenProperties * | Clone | ( | TInt & | aOkOrError | ) | const [pure virtual] |
Method creates exact copy of the properties, preserving the real, concrete subclass type (this can be resolved via PropertiesClassType() method. Furthermore, the IsSafeToCast() method can be used to reflect the returned pointer to a concrete class. NOTE: one must cast the returned pointer to concrete class in order to safely de-allocate any memory allocated by this method.
| Parameter | Description |
|---|---|
| aOkOrError | is KErrNone when clone is successfully allocated, or some system-wide error otherwise. |
Returns: pointer to *concrete* properties object, which MUST be class cast to known subclass(!).
| MSenProperties * | CloneL | ( | ) | const [pure virtual] |
Method creates exact copy of the properties, preserving the real, concrete subclass type (this can be resolved via PropertiesClassType() method. Furthermore, the IsSafeToCast() method can be used to reflect the returned pointer to a concrete class. NOTE: one must cast the returned pointer to concrete class in order to safely de-allocate any memory allocated by this method.
Returns: pointer to *concrete* properties object, which MUST be class cast to known subclass(!).
| Parameter | Description |
|---|---|
| aName | The name identifying this property. |
| aValue | A TInt reference to be filled in with the value of the property. |
Returns: KErrNone on success, KErrSenOmitted if property has been omitted, or some of the system-wide error codes otherwise.
| TBool | IsSafeToCast | ( | TSenPropertiesClassType | aClass | ) | [pure virtual] |
Method provies reflection support for properties classes, enabling safe class-casts to concrete subclass objects.
Returns: ETrue, if object is of a known subclass type EFalse, if the object cannot be cast to given type.
| TSenPropertiesClassType | PropertiesClassType | ( | ) | [pure virtual] |
Get an integer identifying properties class type. All subclasses MUST return use unique integer value.
Returns: unique TInt identifying this properties class type
| Parameter | Description |
|---|---|
| aName | The name identifying this property. |
| aValue | The value of the property, or KNullDesC8 if property is not found. |
Returns: KErrNone on success, KErrSenOmitted if property has been omitted, or some of the system-wide error codes otherwise.
| void | ReadFromL | ( | const TDesC8 & | aBuffer | ) | [pure virtual] |
| Parameter | Description |
|---|---|
| aBuffer | The buffer to read from. |
Sets new boolean property.
If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.
| Parameter | Description |
|---|---|
| aName | Name of the property, which can be later used to refer the given value. |
| aValue | The boolean value of this property. |
Returns: KErrNone if no error, or some of the system wide error codes. Leave codes: According to implementing classes.
Sets new integer property.
If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.
| Parameter | Description |
|---|---|
| aName | Name of the property, which can be later used to refer the given value. |
| aValue | Is the integer value of this property. |
Returns: KErrNone if no error, or some of the system wide error codes. Leave codes: According to implementing classes.
Sets new property.
If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.
| Parameter | Description |
|---|---|
| aName | Name of the property, which can be later used to refer the given value. |
| aValue | Is the value of this property. |
Returns: KErrNone if no error, or some of the system wide error codes. Leave codes: According to implementing classes.
| void | SetReader | ( | CSenXmlReader & | aReader | ) | [pure virtual] |
Sets the XML reader to be used for parsing.
| void | WriteToL | ( | RWriteStream & | aWriteStream | ) | [pure virtual] |
| Parameter | Description |
|---|---|
| aWriteStream | The stream to write to. |