BaseTools/Source/Python/CommonDataClass/CommonClass.py

   1 ## @file
   2 # This file is used to define common items of class object
   3 #
   4 # Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5 # SPDX-License-Identifier: BSD-2-Clause-Patent
   6
   7
   8 ## SkuInfoClass
   9 #
  10 # This class defined SkuInfo item used in Module/Platform/Package files
  11 #
  12 # @param object:           Inherited from object class
  13 # @param SkuIdName:        Input value for SkuIdName, default is ''
  14 # @param SkuId:            Input value for SkuId, default is ''
  15 # @param VariableName:     Input value for VariableName, default is ''
  16 # @param VariableGuid:     Input value for VariableGuid, default is ''
  17 # @param VariableOffset:   Input value for VariableOffset, default is ''
  18 # @param HiiDefaultValue:  Input value for HiiDefaultValue, default is ''
  19 # @param VpdOffset:        Input value for VpdOffset, default is ''
  20 # @param DefaultValue:     Input value for DefaultValue, default is ''
  21 #
  22 # @var SkuIdName:          To store value for SkuIdName
  23 # @var SkuId:              To store value for SkuId
  24 # @var VariableName:       To store value for VariableName
  25 # @var VariableGuid:       To store value for VariableGuid
  26 # @var VariableOffset:     To store value for VariableOffset
  27 # @var HiiDefaultValue:    To store value for HiiDefaultValue
  28 # @var VpdOffset:          To store value for VpdOffset
  29 # @var DefaultValue:       To store value for DefaultValue
  30 #
  31 class SkuInfoClass(object):
  32     def __init__(self, SkuIdName = '', SkuId = '', VariableName = '', VariableGuid = '', VariableOffset = '',
  33                  HiiDefaultValue = '', VpdOffset = '', DefaultValue = '', VariableGuidValue = '', VariableAttribute = '', DefaultStore = None):
  34         self.SkuIdName = SkuIdName
  35         self.SkuId = SkuId
  36
  37         #
  38         # Used by Hii
  39         #
  40         if DefaultStore is None:
  41             DefaultStore = {}
  42         self.VariableName = VariableName
  43         self.VariableGuid = VariableGuid
  44         self.VariableGuidValue = VariableGuidValue
  45         self.VariableOffset = VariableOffset
  46         self.HiiDefaultValue = HiiDefaultValue
  47         self.VariableAttribute = VariableAttribute
  48         self.DefaultStoreDict = DefaultStore
  49
  50         #
  51         # Used by Vpd
  52         #
  53         self.VpdOffset = VpdOffset
  54
  55         #
  56         # Used by Default
  57         #
  58         self.DefaultValue = DefaultValue
  59
  60     ## Convert the class to a string
  61     #
  62     #  Convert each member of the class to string
  63     #  Organize to a single line format string
  64     #
  65     #  @retval Rtn Formatted String
  66     #
  67     def __str__(self):
  68         Rtn = 'SkuId = ' + str(self.SkuId) + "," + \
  69                     'SkuIdName = ' + str(self.SkuIdName) + "," + \
  70                     'VariableName = ' + str(self.VariableName) + "," + \
  71                     'VariableGuid = ' + str(self.VariableGuid) + "," + \
  72                     'VariableOffset = ' + str(self.VariableOffset) + "," + \
  73                     'HiiDefaultValue = ' + str(self.HiiDefaultValue) + "," + \
  74                     'VpdOffset = ' + str(self.VpdOffset) + "," + \
  75                     'DefaultValue = ' + str(self.DefaultValue) + ","
  76         return Rtn
  77
  78     def __deepcopy__(self,memo):
  79         new_sku = SkuInfoClass()
  80         new_sku.SkuIdName = self.SkuIdName
  81         new_sku.SkuId = self.SkuId
  82         new_sku.VariableName = self.VariableName
  83         new_sku.VariableGuid = self.VariableGuid
  84         new_sku.VariableGuidValue = self.VariableGuidValue
  85         new_sku.VariableOffset = self.VariableOffset
  86         new_sku.HiiDefaultValue = self.HiiDefaultValue
  87         new_sku.VariableAttribute = self.VariableAttribute
  88         new_sku.DefaultStoreDict = {key:value for key,value in self.DefaultStoreDict.items()}
  89         new_sku.VpdOffset = self.VpdOffset
  90         new_sku.DefaultValue = self.DefaultValue
  91         return new_sku