enum.py
Go to the documentation of this file.
00001 """
00002 Created on Nov 22, 2014
00003 
00004 Software License Agreement (BSD License)
00005  Copyright (c) 2014, LABUST, UNIZG-FER
00006  All rights reserved.
00007  
00008  Redistribution and use in source and binary forms, with or without
00009  modification, are permitted provided that the following conditions
00010  are met:
00011  
00012  * Redistributions of source code must retain the above copyright
00013    notice, this list of conditions and the following disclaimer.
00014  * Redistributions in binary form must reproduce the above
00015    copyright notice, this list of conditions and the following
00016    disclaimer in the documentation and/or other materials provided
00017    with the distribution.
00018  * Neither the name of the LABUST nor the names of its
00019    contributors may be used to endorse or promote products derived
00020    from this software without specific prior written permission.
00021  
00022  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00023  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00024  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00025  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
00026  COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00027  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00028  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
00029  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00030  CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00031  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
00032  ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00033  POSSIBILITY OF SUCH DAMAGE.
00034 
00035 @author: Dula Nad
00036 """
00037 
00038 class Enum:
00039     """
00040     Represents the C++ data enumeration in the object form.
00041     
00042     Class attributes:
00043     _XMLTAG -- constant string with the xml tag description
00044     """
00045     _XMLTAG = 'enum'
00046 
00047     def __init__(self, xmlnode = None):
00048         """
00049         Populates the variable from a XML node info.
00050         When the XML node is not defined, does nothing.
00051         
00052         xmlnode -- the XML node with the member definition
00053             
00054         Instance attributes:
00055         ename -- name of the enumerator
00056         evalue -- value of the enumerator
00057         """
00058         self.ename = 'unnamed'
00059         self.evalue = '0x00'
00060         
00061         if xmlnode != None: self.from_xml(xmlnode)
00062         
00063     def from_xml(self, xmlnode):
00064         """
00065         Extracts the enum attributes from the XML node.
00066         
00067         xmlnode -- the XML node with the member definition
00068         """
00069         
00070         if xmlnode.tag != self._XMLTAG:
00071             raise NameError(self.__class__.__name__ + 
00072                             ' expected XML tag: "' + 
00073                             self._XMLTAG + 
00074                             '"')
00075         
00076         self.ename = xmlnode.get('name',self.ename)
00077         self.evalue = xmlnode.get('value',self.evalue)  
00078         
00079     def gen_code(self, bindent = '', indent = '  '):
00080         """
00081         Generates the full member definition C++ code and
00082         returns it as a string
00083         
00084         bindent -- the current indent in the document
00085         indent -- the usual minimum indentation
00086         """
00087         return (bindent + indent + 'enum {' + self.ename + ' = ' + 
00088                 self.evalue + '};') 
00089         
00090     def __str__(self):
00091         """
00092         Overriden string specifier returns the C++ code snippet 
00093         without indentation.
00094         """
00095         return self.gen_code(indent = '')
00096         
00097         
00098         


snippets
Author(s): Gyula Nagy
autogenerated on Fri Aug 28 2015 11:22:33