kappa_sdk.DataType#

class kappa_sdk.DataType(alias, name, measure, comment=' ', is_built_in=False, plot_channel_aspect_dto=None)[source]#

Data Type object.

Presents a KAPPA Automate Data Type object.

Attributes

DataType.alias

Gets the alias of the DataType object.

DataType.channel_aspect_dto

Returns the channel Aspect Dto of the data

DataType.comment

Gets the comment of the DataType object.

DataType.is_built_in

if the DataType object is a built-in data type.

DataType.measure

Gets the measure of the DataType object.

DataType.name

Gets the name of the DataType object.

Methods

Parameters:

  • alias (str)

  • name (str)

  • measure (MeasureEnum | str)

  • comment (str)

  • is_built_in (bool)

  • plot_channel_aspect_dto (ChannelAspectDto | None)

__init__(alias, name, measure, comment=' ', is_built_in=False, plot_channel_aspect_dto=None)[source]#
Parameters:

  • alias (str)

  • name (str)

  • measure (MeasureEnum | str)

  • comment (str)

  • is_built_in (bool)

  • plot_channel_aspect_dto (ChannelAspectDto | None)

property alias: str#

Gets the alias of the DataType object.

property name: str#

Gets the name of the DataType object.

property comment: str#

Gets the comment of the DataType object.

property measure: MeasureEnum | str#

Gets the measure of the DataType object.

property is_built_in: bool#

if the DataType object is a built-in data type.

property channel_aspect_dto: ChannelAspectDto | None#

Returns the channel Aspect Dto of the data

Returns:

ChannelAspectDto – dto of the channel aspect