You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by ro...@apache.org on 2004/06/13 16:20:17 UTC
cvs commit: ws-axis/c/src/soap ComplexElement.h
roshan 2004/06/13 07:20:17
Modified: c/src/soap ComplexElement.h
Log:
added doxygen comments to automate API building
Revision Changes Path
1.12 +85 -14 ws-axis/c/src/soap/ComplexElement.h
Index: ComplexElement.h
===================================================================
RCS file: /home/cvs/ws-axis/c/src/soap/ComplexElement.h,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- ComplexElement.h 25 May 2004 12:15:05 -0000 1.11
+++ ComplexElement.h 13 Jun 2004 14:20:17 -0000 1.12
@@ -13,17 +13,10 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*
- * @author Samisa Abeysinghe (sabeysinghe@virtusa.com)
*
*/
/*
- * Revision 1.1 2004/05/25 samisa
- * Added copy constructure and clone for copy constructing derived classes
- */
-
-
-/*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
@@ -32,6 +25,16 @@
*
*/
+/*
+ * Revision 1.1 2004/05/25 samisa
+ * Added copy constructure and clone for copy constructing derived classes
+ */
+
+/*
+ * Revision 1.2 2004/06/13 roshan
+ * Added doxygen comments to help autobuild API docs
+ */
+
#if !defined(AXIS_COMPLEXELEMENT_H__OF_AXIS_INCLUDED_)
#define AXIS_COMPLEXELEMENT_H__OF_AXIS_INCLUDED_
@@ -43,34 +46,102 @@
#include <axis/server/BasicNode.h>
using namespace std;
-/*
+
+/**
* @class ComplexElement
* @brief interface for the ComplexElement class.
*
- * @author Roshan Weerasuriya (roshan@jkcs.slt.lk, roshan@opensource.lk)
+ * @author Roshan Weerasuriya (roshan@opensource.lk, roshanw@jkcsworld.com)
+ * @author Samisa Abeysinghe (sabeysinghe@virtusa.com)
*/
+
class ComplexElement : public BasicNode
{
public:
ComplexElement(AxisChar* pachLocalName, AxisChar* pachPrefix, AxisChar* pachUri);
- /*
- * Returns the number of child elements of this ComplexElement.
- * @return The number of child elements of this ComplexElement.
- */
+
+ /**
+ * Returns the number of child elements of this ComplexElement.
+ *
+ * @return The number of child elements of this ComplexElement.
+ */
int getNoOfChildren();
+
+ /**
+ * Get the Child Node of the given position.
+ *
+ * @param iChildPosition The child position.
+ * @return The Child Node of the given position.
+ */
const BasicNode* getChild(int iChildPosition) const;
+
+ /**
+ * Gets the last Child Node of this Complex Element.
+ *
+ * @return The last Child Node of this Complex Element.
+ */
const BasicNode* getLastChild() const;
+
+ /**
+ * Gets the first Child Node of this Complex Element.
+ *
+ * @return The first Child Node of this Complex Element.
+ */
const BasicNode* getFirstChild() const;
+
+ /**
+ * Adds the given child node to this Complex Element.
+ *
+ * @param pBasicNode the child node to be added to this Complex Element.
+ * @return AXIS_SUCCESS to indicate successfull operation.
+ */
+ int addChild(BasicNode* pBasicNode);
+
+ /**
+ * Gets the Node Type of the Complex Element which is ELEMENT_NODE.
+ *
+ * @return The Node Type of the Complex Element which is ELEMENT_NODE.
+ */
NODE_TYPE getNodeType() const;
+
+ /**
+ * Sets the namespace URI of this Complex Element.
+ *
+ * @param pachURI the namespace URI of this Complex Element.
+ * @return AXIS_SUCCESS to indicate successfull operation.
+ */
int setURI(const AxisChar* pachURI);
- int addChild(BasicNode* pBasicNode);
+
+ /**
+ * Sets the local name of this Complex Element.
+ *
+ * @param pachLocalName the local name of this Complex Element.
+ * @return AXIS_SUCCESS to indicate successfull operation.
+ */
int setLocalName(const AxisChar* pachLocalName);
+
+ /**
+ * Sets the prefix of this Complex Element.
+ *
+ * @param pachPrefix the prefix of this Complex Element.
+ * @return AXIS_SUCCESS to indicate successfull operation.
+ */
int setPrefix(const AxisChar* pachPrefix);
+
int serialize(SoapSerializer& pSZ);
+
int serialize(SoapSerializer& pSZ, list<AxisChar*>& lstTmpNameSpaceStack);
+
+ /**
+ * The Constructor.
+ */
ComplexElement();
ComplexElement(const ComplexElement& rCopy);
BasicNode* clone();
+
+ /**
+ * The Destructor.
+ */
virtual ~ComplexElement();
/*