Source code for abaqus.TableCollection.ParameterColumn

from abaqusConstants import *


class ParameterColumn:
    """The ParameterColumn object is used to define the type of parameters that will
    collectively build the type of parameter table. Once the object is created, it is 
    noneditable. 

    Notes
    -----
    This object can be accessed by:

    .. code-block:: python

        mdb.models[name].tableCollections[name].parameterTables[name].columns[i]

    The corresponding analysis keywords are:

    - *PARAMETER TABLE TYPE
            - *PARAMETER TABLE

    """

    def __init__(self, type: SymbolicConstant, unit: str = '', description: str = '', default: str = '',
                 allowedValues: str = ''):
        """ParameterColumn is a constructor method that creates a ParameterColumn object and stores
        it in the array data structure. It is accessible from the ParameterTable object using a
        column member.

        Notes
        -----
        This function can be accessed by:

        .. code-block:: python

            mdb.models[name].tableCollections[name].parameterTables[name].Column
        
        Parameters
        ----------
        type
            A SymbolicConstant specifying the data type of the parameter. Possible values are 
            STRING, INTEGER, and FLOAT. 
        unit
            A String specifying the unit of the parameter. 
        description
            A String specifying the description of the parameter. 
        default
            The default value of the first parameter. The data type of the value depends on the 
            value of *type* argument. 
        allowedValues
            A Set of allowed values for the parameter. 

        Returns
        -------
            A ParameterTable object. 

        Raises
        ------
            Incompatible data are given. 
        """
        pass