ROSoapSerializer

Overview

This class is a helper class used internally by the ROSoapMessage to convert simple data to SOAP-compatible XML expressions. This class is not intended to be instantiated or used by users.
Pointer data types from libxml library are widely used here.

Location

 

anonymousMode  assign

@property (assign) BOOL anonymousMode

currentHrefId

Holds the C string that describes the current reference that is being processed. Used only when parsing an XML message containing complex types references (RPC/Encoding style).

@property (readonly) char *currentHrefId

currentNS

@property (readonly) xmlNsPtr currentNS

getXmlType:

Returns an XML data type name that is equivalent to the given RODL data type name.

+ (xmlChar *) getXmlType:(NSString *)rodlType

Parameters:

  • rodlType: The RODL type name to convert.

initWithSerializationOptions:

Initializes the class instance and sets the required serialization options.

- (id) initWithSerializationOptions:(int)aOptions

Parameters:

  • aOptions: The options combination to set (bit flags).

nextHrefId

Generates the C string that will be used for the next reference when building an XML message that requires complex type references (RPC/Encoding style).

@property (readonly) char *nextHrefId

popNs

- (xmlNsPtr) popNs

pushNs:

- (void) pushNs:(xmlNsPtr)aNs

Parameters:

  • aNs:

readAnsiStringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is ANSI-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readAnsiStringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readBinaryParamFromNode:withName:

Reads the content of the message node with the given name and converts the content from MIME-encoded string to binary data. The required node is searched among the nodes nested in the root node.

- (NSData *) readBinaryParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readBoolParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to boolean data. The required node is searched among the nodes nested in the root node.

- (BOOL) readBoolParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDateParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to date/time data. The required node is searched among the nodes nested in the root node.

- (NSDate *) readDateParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDecimalParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to a fixed-point number. The required node is searched among the nodes nested in the root node.

- (NSDecimalNumber *) readDecimalParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDoubleParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to a floating-point number. The required node is searched among the nodes nested in the root node.

- (double) readDoubleParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readEnumParamFromNode:withName:asEnum:

Reads the content of the message node with the given name and converts the content from enum string representation to integer. The required node is searched among the nodes nested in the root node.

- (int32) readEnumParamFromNode:(xmlNodePtr)node withName:(NSString *)name asEnum:(ROEnumMetaData *)enumData

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.
  • enumData: The enum metadata class instance that corresponds to the expected enumerated type.

readIntegerParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to an integer number. The required node is searched among the nodes nested in the root node.

- (int64) readIntegerParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readUTF16StringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is UTF16-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readUTF16StringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readUTF8StringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is UTF8-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readUTF8StringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

retrContentOfParamWithName:ofNode:

The helper method to retrieve the raw string content of the required node.

- (xmlChar *) retrContentOfParamWithName:(NSString *)name ofNode:(xmlNodePtr)node

Parameters:

  • name: The required node name.
  • node: The root node to start searching from.

SerializationOptions

Serialization options for the current message that is being processed. This value is set at the moment of instance initialization.

@property (readonly) int SerializationOptions

writeAnsiStringParam:toNode:withName:

Writes the string value as a content of the new node with the given name in ANSI encoding. The new node is created as a child of the specified root node.

- (void) writeAnsiStringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeBinaryParam:toNode:withName:

Writes the binary data value as a content of the new node with the given name in the MIME encoding. The new node is created as a child of the specified root node.

- (void) writeBinaryParam:(NSData *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeBoolParam:toNode:withName:

Writes the boolean value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeBoolParam:(BOOL)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeByteParam:toNode:withName:

Writes the byte value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeByteParam:(byte)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDateParam:toNode:withName:

Writes the date/time value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDateParam:(NSDate *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDecimalParam:toNode:withName:

Writes the fixed-point number value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDecimalParam:(NSDecimalNumber *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDoubleParam:toNode:withName:

Writes the floating-point number value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDoubleParam:(double)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeEnumParam:toNode:withName:asEnum:

Writes the value of the enumerated type as content of the new node with the given name. The enumerated value is represented as ANSI-encoded string. The new node is created as a child of the specified root node.

- (void) writeEnumParam:(int32)value toNode:(xmlNodePtr)node withName:(NSString *)name asEnum:(ROEnumMetaData *)enumData

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.
  • enumData: The enum metadata class instance of the required enum type.

writeIntParam:toNode:withName:

Writes the 32-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeIntParam:(int)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeLongParam:toNode:withName:

Writes the 64-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeLongParam:(int64)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeShortParam:toNode:withName:

Writes the 16-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeShortParam:(int)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeUTF16StringParam:toNode:withName:

Writes the string value as content of the new node with the given name in UTF16 encoding. The new node is created as a child of the specified root node.

- (void) writeUTF16StringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeUTF8StringParam:toNode:withName:

Writes the string value as content of the new node with the given name in UTF8 encoding. The new node is created as a child of the specified root node.

- (void) writeUTF8StringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

 

anonymousMode  assign

@property (assign) BOOL anonymousMode

currentHrefId

Holds the C string that describes the current reference that is being processed. Used only when parsing an XML message containing complex types references (RPC/Encoding style).

@property (readonly) char *currentHrefId

currentNS

@property (readonly) xmlNsPtr currentNS

nextHrefId

Generates the C string that will be used for the next reference when building an XML message that requires complex type references (RPC/Encoding style).

@property (readonly) char *nextHrefId

SerializationOptions

Serialization options for the current message that is being processed. This value is set at the moment of instance initialization.

@property (readonly) int SerializationOptions

 

getXmlType:

Returns an XML data type name that is equivalent to the given RODL data type name.

+ (xmlChar *) getXmlType:(NSString *)rodlType

Parameters:

  • rodlType: The RODL type name to convert.

 

initWithSerializationOptions:

Initializes the class instance and sets the required serialization options.

- (id) initWithSerializationOptions:(int)aOptions

Parameters:

  • aOptions: The options combination to set (bit flags).

popNs

- (xmlNsPtr) popNs

pushNs:

- (void) pushNs:(xmlNsPtr)aNs

Parameters:

  • aNs:

readAnsiStringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is ANSI-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readAnsiStringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readBinaryParamFromNode:withName:

Reads the content of the message node with the given name and converts the content from MIME-encoded string to binary data. The required node is searched among the nodes nested in the root node.

- (NSData *) readBinaryParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readBoolParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to boolean data. The required node is searched among the nodes nested in the root node.

- (BOOL) readBoolParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDateParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to date/time data. The required node is searched among the nodes nested in the root node.

- (NSDate *) readDateParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDecimalParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to a fixed-point number. The required node is searched among the nodes nested in the root node.

- (NSDecimalNumber *) readDecimalParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readDoubleParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to a floating-point number. The required node is searched among the nodes nested in the root node.

- (double) readDoubleParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readEnumParamFromNode:withName:asEnum:

Reads the content of the message node with the given name and converts the content from enum string representation to integer. The required node is searched among the nodes nested in the root node.

- (int32) readEnumParamFromNode:(xmlNodePtr)node withName:(NSString *)name asEnum:(ROEnumMetaData *)enumData

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.
  • enumData: The enum metadata class instance that corresponds to the expected enumerated type.

readIntegerParamFromNode:withName:

Reads the content of the message node with the given name and converts the content to an integer number. The required node is searched among the nodes nested in the root node.

- (int64) readIntegerParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readUTF16StringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is UTF16-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readUTF16StringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

readUTF8StringParamFromNode:withName:

Reads the string content of the message node with the given name, assuming the string is UTF8-encoded. The required node is searched among the nodes nested in the root node.

- (NSString *) readUTF8StringParamFromNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • node: The root node to start searching from.
  • name: The required node name.

retrContentOfParamWithName:ofNode:

The helper method to retrieve the raw string content of the required node.

- (xmlChar *) retrContentOfParamWithName:(NSString *)name ofNode:(xmlNodePtr)node

Parameters:

  • name: The required node name.
  • node: The root node to start searching from.

writeAnsiStringParam:toNode:withName:

Writes the string value as a content of the new node with the given name in ANSI encoding. The new node is created as a child of the specified root node.

- (void) writeAnsiStringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeBinaryParam:toNode:withName:

Writes the binary data value as a content of the new node with the given name in the MIME encoding. The new node is created as a child of the specified root node.

- (void) writeBinaryParam:(NSData *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeBoolParam:toNode:withName:

Writes the boolean value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeBoolParam:(BOOL)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeByteParam:toNode:withName:

Writes the byte value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeByteParam:(byte)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDateParam:toNode:withName:

Writes the date/time value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDateParam:(NSDate *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDecimalParam:toNode:withName:

Writes the fixed-point number value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDecimalParam:(NSDecimalNumber *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeDoubleParam:toNode:withName:

Writes the floating-point number value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeDoubleParam:(double)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeEnumParam:toNode:withName:asEnum:

Writes the value of the enumerated type as content of the new node with the given name. The enumerated value is represented as ANSI-encoded string. The new node is created as a child of the specified root node.

- (void) writeEnumParam:(int32)value toNode:(xmlNodePtr)node withName:(NSString *)name asEnum:(ROEnumMetaData *)enumData

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.
  • enumData: The enum metadata class instance of the required enum type.

writeIntParam:toNode:withName:

Writes the 32-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeIntParam:(int)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeLongParam:toNode:withName:

Writes the 64-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeLongParam:(int64)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeShortParam:toNode:withName:

Writes the 16-bit integer value as content of the new node with the given name. The new node is created as a child of the specified root node.

- (void) writeShortParam:(int)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeUTF16StringParam:toNode:withName:

Writes the string value as content of the new node with the given name in UTF16 encoding. The new node is created as a child of the specified root node.

- (void) writeUTF16StringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.

writeUTF8StringParam:toNode:withName:

Writes the string value as content of the new node with the given name in UTF8 encoding. The new node is created as a child of the specified root node.

- (void) writeUTF8StringParam:(NSString *)value toNode:(xmlNodePtr)node withName:(NSString *)name

Parameters:

  • value: The value to write.
  • node: The root node to create the new node in.
  • name: The name of the new node.