BaseTools: Various typo

[mirror_edk2.git] / BaseTools / Source / Python / CommonDataClass / CommonClass.py

## @file\r
# This file is used to define common items of class object\r
#\r
# Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
# This program and the accompanying materials\r
# are licensed and made available under the terms and conditions of the BSD License\r
# which accompanies this distribution.    The full text of the license may be found at\r
# http://opensource.org/licenses/bsd-license.php\r
#\r
# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
\r
## SkuInfoClass\r
#\r
# This class defined SkuInfo item used in Module/Platform/Package files\r
#\r
# @param object:           Inherited from object class\r
# @param SkuIdName:        Input value for SkuIdName, default is ''\r
# @param SkuId:            Input value for SkuId, default is ''\r
# @param VariableName:     Input value for VariableName, default is ''\r
# @param VariableGuid:     Input value for VariableGuid, default is ''\r
# @param VariableOffset:   Input value for VariableOffset, default is ''\r
# @param HiiDefaultValue:  Input value for HiiDefaultValue, default is ''\r
# @param VpdOffset:        Input value for VpdOffset, default is ''\r
# @param DefaultValue:     Input value for DefaultValue, default is ''\r
#\r
# @var SkuIdName:          To store value for SkuIdName\r
# @var SkuId:              To store value for SkuId\r
# @var VariableName:       To store value for VariableName\r
# @var VariableGuid:       To store value for VariableGuid\r
# @var VariableOffset:     To store value for VariableOffset\r
# @var HiiDefaultValue:    To store value for HiiDefaultValue\r
# @var VpdOffset:          To store value for VpdOffset\r
# @var DefaultValue:       To store value for DefaultValue\r
#\r
class SkuInfoClass(object):\r
    def __init__(self, SkuIdName = '', SkuId = '', VariableName = '', VariableGuid = '', VariableOffset = '',\r
                 HiiDefaultValue = '', VpdOffset = '', DefaultValue = '', VariableGuidValue = '', VariableAttribute = '', DefaultStore = None):\r
        self.SkuIdName = SkuIdName\r
        self.SkuId = SkuId\r
\r
        #\r
        # Used by Hii\r
        #\r
        if DefaultStore is None:\r
            DefaultStore = {}\r
        self.VariableName = VariableName\r
        self.VariableGuid = VariableGuid\r
        self.VariableGuidValue = VariableGuidValue\r
        self.VariableOffset = VariableOffset\r
        self.HiiDefaultValue = HiiDefaultValue\r
        self.VariableAttribute = VariableAttribute\r
        self.DefaultStoreDict = DefaultStore\r
\r
        #\r
        # Used by Vpd\r
        #\r
        self.VpdOffset = VpdOffset\r
\r
        #\r
        # Used by Default\r
        #\r
        self.DefaultValue = DefaultValue\r
\r
    ## Convert the class to a string\r
    #\r
    #  Convert each member of the class to string\r
    #  Organize to a single line format string\r
    #\r
    #  @retval Rtn Formatted String\r
    #\r
    def __str__(self):\r
        Rtn = 'SkuId = ' + str(self.SkuId) + "," + \\r
                    'SkuIdName = ' + str(self.SkuIdName) + "," + \\r
                    'VariableName = ' + str(self.VariableName) + "," + \\r
                    'VariableGuid = ' + str(self.VariableGuid) + "," + \\r
                    'VariableOffset = ' + str(self.VariableOffset) + "," + \\r
                    'HiiDefaultValue = ' + str(self.HiiDefaultValue) + "," + \\r
                    'VpdOffset = ' + str(self.VpdOffset) + "," + \\r
                    'DefaultValue = ' + str(self.DefaultValue) + ","\r
        return Rtn\r
\r
    def __deepcopy__(self,memo):\r
        new_sku = SkuInfoClass()\r
        new_sku.SkuIdName = self.SkuIdName\r
        new_sku.SkuId = self.SkuId\r
        new_sku.VariableName = self.VariableName\r
        new_sku.VariableGuid = self.VariableGuid\r
        new_sku.VariableGuidValue = self.VariableGuidValue\r
        new_sku.VariableOffset = self.VariableOffset\r
        new_sku.HiiDefaultValue = self.HiiDefaultValue\r
        new_sku.VariableAttribute = self.VariableAttribute\r
        new_sku.DefaultStoreDict = {key:value for key,value in self.DefaultStoreDict.items()}\r
        new_sku.VpdOffset = self.VpdOffset\r
        new_sku.DefaultValue = self.DefaultValue\r
        return new_sku\r