variable.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 Variable:
00039     """
00040     Represents the C++ data member/variable in the object form.
00041     
00042     Class attributes:
00043     _XMLTAG -- constant string with the xml tag description
00044     """
00045     _XMLTAG = 'var'
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         Required attributes:
00055         name    -- name of the variable
00056         type    -- type name of the variable
00057         Optional attributes:
00058         bits - number of bits that should be reserved for the variable
00059         min - minimal value of the variable
00060         max - maximal value of the variable
00061         quant - the quantization of the variable
00062         cond - conditional serialization (will be serialized only when the value is True)
00063         default - the default value of the variable
00064         """
00065         self.name = 'unnamed'
00066         self.type = 'void'
00067         self.default = None
00068         self.cond = None
00069         self.bits = None
00070         self.min = None
00071         self.max = None
00072         self.quant = None
00073         
00074         if xmlnode != None: self.from_xml(xmlnode)
00075         
00076     def from_xml(self, xmlnode):
00077         """
00078         Extracts the variable attributes from the XML node.
00079         
00080         xmlnode -- the XML node with the member definition
00081         """
00082         
00083         if xmlnode.tag != self._XMLTAG:
00084             raise NameError(self.__class__.__name__ + 
00085                             ' expected XML tag: "' + 
00086                             self._XMLTAG + 
00087                             '"')
00088         
00089         self.name = xmlnode.get('name',self.name)
00090         self.type = xmlnode.get('type',self.type)
00091         self.default = xmlnode.get('default', self.default)
00092         self.cond = xmlnode.get('if', self.cond)
00093         self.bits = xmlnode.get('bits', self.bits)
00094         self.min = xmlnode.get('min', self.min)
00095         self.max = xmlnode.get('max', self.max)
00096         self.quant = xmlnode.get('quant', self.quant)        
00097         
00098         


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