Cube

Cube(name, dimensions, rules=None)

Bases: TM1Object

Abstraction of a TM1 Cube

Parameters:

Name	Type	Description	Default
name	str	name of the Cube	required
dimensions	Iterable[str]	list of (existing) dimension names	required
rules	Optional[Union[str, Rules]]	instance of TM1py.Objects.Rules	None

Source code in TM1py/Objects/Cube.py

def __init__(self, name: str, dimensions: Iterable[str], rules: Optional[Union[str, Rules]] = None):
    """

    :param name: name of the Cube
    :param dimensions: list of (existing) dimension names
    :param rules: instance of TM1py.Objects.Rules
    """
    self._name = name
    self.dimensions = list(dimensions)
    self.rules = rules

body property

dimensions property writable

feedstrings property

has_rules property

name property

rules property writable

skipcheck property

undefvals property

from_dict(cube_as_dict) classmethod

Alternative constructor

Parameters:

Name	Type	Description	Default
cube_as_dict	Dict	user as dict	required

Returns:

Type	Description
Cube	user, an instance of this class

Source code in TM1py/Objects/Cube.py

@classmethod
def from_dict(cls, cube_as_dict: Dict) -> "Cube":
    """Alternative constructor

    :param cube_as_dict: user as dict
    :return: user, an instance of this class
    """
    return cls(
        name=cube_as_dict["Name"],
        dimensions=[dimension["Name"] for dimension in cube_as_dict["Dimensions"]],
        rules=Rules(cube_as_dict["Rules"]) if cube_as_dict["Rules"] else None,
    )

from_json(cube_as_json) classmethod

Alternative constructor

Parameters:

Name	Type	Description	Default
cube_as_json	str	user as JSON string	required

Returns:

Type	Description
Cube	cube, an instance of this class

Source code in TM1py/Objects/Cube.py

@classmethod
def from_json(cls, cube_as_json: str) -> "Cube":
    """Alternative constructor

    :param cube_as_json: user as JSON string
    :return: cube, an instance of this class
    """
    cube_as_dict = json.loads(cube_as_json)
    return cls.from_dict(cube_as_dict)