Objective Systems, Inc.  
Home
About ASN.1
Products
Free Software
Documents
Services
Resources
Resellers
Customers
Careers
About Us
Contact Us
 

Google


Objective Systems, Inc.

OSXMLStringClass Class Reference

XML string. More...

#include <rtxCppXmlString.h>

Inheritance diagram for OSXMLStringClass:

OSBaseType List of all members.

Public Member Functions

 OSXMLStringClass ()
 The default constructor does not creates an empty string but rather set value to 0.
 OSXMLStringClass (const OSUTF8CHAR *strval, OSBOOL cdata_=FALSE, OSBOOL ownMemory=FALSE)
 This constructor initializes the string to contain the value.
 OSXMLStringClass (const OSXMLSTRING &str)
 Copy constructor.
 OSXMLStringClass (const OSXMLStringClass &str)
 Copy constructor.
virtual ~OSXMLStringClass ()
 The destructor frees string memory if the memory ownership flag is set.
OSBaseTypeclone () const
 Clone method.
void copyValue (const OSUTF8CHAR *utf8str)
 This method copies the given string value to the internal string storage variable.
void copyValue (const char *cstring)
 This method copies the given string value to the internal string storage variable.
const char * c_str () const
 This method returns the pointer to C null terminated string.
const OSUTF8CHAR * getValue () const
 This method returns the pointer to UTF-8 null terminated string.
OSBOOL isCDATA () const
 This method returns the value of the cdata member variable.
void setCDATA (OSBOOL bvalue)
 This method sets the value of the cdata member variable.
void print (const char *name)
 This method prints the string value to standard output.
void setValue (const OSUTF8CHAR *utf8str)
 This method sets the string value to the given string.
void setValue (const char *cstring)
 This method sets the string value to the given string.
OSXMLStringClassoperator= (const OSXMLStringClass &original)
 Assignment operator.
int length ()
 This method returns the number of characters.
int size ()
 This method returns the number of bytes.

Detailed Description

XML string.

This is the base class for generated C++ data type classes for XSD string types (string, token, NMTOKEN, etc.).

Definition at line 39 of file rtxCppXmlString.h.


Constructor & Destructor Documentation

OSXMLStringClass::OSXMLStringClass const OSUTF8CHAR *  strval,
OSBOOL  cdata_ = FALSE,
OSBOOL  ownMemory = FALSE
 

This constructor initializes the string to contain the value.

A deep-copy of the given value is not done; the pointer is stored directly in the class member variable.

Parameters:
strval - String value
cdata_ - Should string be encoded as a CDATA section?
ownMemory - Transfer ownership of memory to object.

OSXMLStringClass::OSXMLStringClass const OSXMLSTRING &  str  ) 
 

Copy constructor.

Parameters:
str - C XML string structure.

OSXMLStringClass::OSXMLStringClass const OSXMLStringClass str  ) 
 

Copy constructor.

Parameters:
str - C++ XML string class.


Member Function Documentation

OSBaseType* OSXMLStringClass::clone  )  const [inline]
 

Clone method.

Creates a copied instance and returns pointer to OSBaseType.

Definition at line 84 of file rtxCppXmlString.h.

void OSXMLStringClass::copyValue const char *  cstring  )  [inline]
 

This method copies the given string value to the internal string storage variable.

A deep-copy of the given value is done; the class will delete this memory when the object is deleted.

Parameters:
cstring - C null-terminated string.

Definition at line 102 of file rtxCppXmlString.h.

void OSXMLStringClass::copyValue const OSUTF8CHAR *  utf8str  ) 
 

This method copies the given string value to the internal string storage variable.

A deep-copy of the given value is done; the class will delete this memory when the object is deleted.

Parameters:
utf8str - C null-terminated string.

OSBOOL OSXMLStringClass::isCDATA  )  const [inline]
 

This method returns the value of the cdata member variable.

This indicates if this string should be encoded as a CDATA section in an XML document.

Returns:
- True if string is to be encoded as CDATA section

Definition at line 127 of file rtxCppXmlString.h.

void OSXMLStringClass::print const char *  name  )  [inline]
 

This method prints the string value to standard output.

Parameters:
name - Name of generated string variable.

Definition at line 143 of file rtxCppXmlString.h.

void OSXMLStringClass::setCDATA OSBOOL  bvalue  )  [inline]
 

This method sets the value of the cdata member variable.

This indicates if this string should be encoded as a CDATA section in an XML document.

Parameters:
bvalue - Boolean value.

Definition at line 136 of file rtxCppXmlString.h.

void OSXMLStringClass::setValue const char *  cstring  )  [inline]
 

This method sets the string value to the given string.

A deep-copy of the given value is not done; the pointer is stored directly in the class member variable.

Parameters:
cstring - C null-terminated string.

Definition at line 161 of file rtxCppXmlString.h.

void OSXMLStringClass::setValue const OSUTF8CHAR *  utf8str  ) 
 

This method sets the string value to the given string.

A deep-copy of the given value is not done; the pointer is stored directly in the class member variable.

Parameters:
utf8str - C null-terminated string.


The documentation for this class was generated from the following file:

This file was last modified on 8 Jan 2007.
XBinder, Version 1.1.9