Table of Contents

Class DataParameterDescriptor

Namespace
Lers.Data
Assembly
Lers.Core.dll

Описывает свойства параметра данных.

public class DataParameterDescriptor
Inheritance
DataParameterDescriptor
Inherited Members
Extension Methods

Fields

UserDescriptorStartId

Идентификатор, с которого начинаются пользовательские параметры.

public const int UserDescriptorStartId = 100000

Field Value

int

Properties

Category

Возвращает категорию, к которой относится этот параметр.

public DataParameterCategory Category { get; }

Property Value

DataParameterCategory

CategoryDescriptor

Возвращает описатель категории, к которой относится параметр.

public DataParameterCategoryDescriptor CategoryDescriptor { get; }

Property Value

DataParameterCategoryDescriptor

DataParameter

Возвращает идентификатор параметра данных.

public DataParameter DataParameter { get; }

Property Value

DataParameter

ElectricCurrentsValue

Возвращает уникальное значение параметра качества электроэнергии.

public ElectricCurrentsRecordValues ElectricCurrentsValue { get; }

Property Value

ElectricCurrentsRecordValues

ElectricPhase

Возвращает электрическую фазу, к которой относится этот параметр или None если параметр не относится к какой-либо фазе.

public ElectricPhase ElectricPhase { get; }

Property Value

ElectricPhase

ElectricPowerValue

Возвращает уникальное значение профиля мощности для ресурса Электричество.

public ElectricPowerRecordValues ElectricPowerValue { get; }

Property Value

ElectricPowerRecordValues

ElectricValue

Возвращает уникальное значение для ресурса Электричество.

public ElectricRecordValues ElectricValue { get; }

Property Value

ElectricRecordValues

ElectricValueType

Тип значения электроэнергии.

public ElectricValueType ElectricValueType { get; }

Property Value

ElectricValueType

FieldName

Возвращает имя поля в базе данных.

public string FieldName { get; }

Property Value

string

FullTitle

Возвращает полное наименование параметра, состоящего из краткого и обычного (через дефис).

public string FullTitle { get; }

Property Value

string

GasValue

Возвращает уникальное значение для ресурса Газ.

public GasRecordValues GasValue { get; }

Property Value

GasRecordValues

Id

Идентификатор параметра данных.

public int Id { get; }

Property Value

int

Instance

Статические дескрипторы, которые не включают пользовательские.

public static IDataParameterDescriptorsStore Instance { get; }

Property Value

IDataParameterDescriptorsStore

IsAdditive

Возвращает значение, определяющее, является ли данный параметр аддитивной величиной.

public bool IsAdditive { get; }

Property Value

bool

IsEav

Возвращает значение, определяющее, хранится ли этот параметр в ленточной форме.

public bool IsEav { get; }

Property Value

bool

IsUser

Указывает, что это пользовательский параметр.

public bool IsUser { get; }

Property Value

bool

IsWorkTime

Возвращает значение, определяющее, является ли данный параметр одним из времен наработки (категория Time).

public bool IsWorkTime { get; }

Property Value

bool

Name

Возвращает текстовое представление значения.

public string Name { get; }

Property Value

string

Params

Возвращает все параметры.

public static ReadOnlyCollection<DataParameterDescriptor> Params { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

RecordTypes

Типы записей, в которых может использоваться этот параметр.

public HashSet<DataRecordType> RecordTypes { get; }

Property Value

HashSet<DataRecordType>

ReportFieldName

Возвращает имя поля в отчёте.

public string ReportFieldName { get; }

Property Value

string

ResourceKinds

Виды ресурсов, в которых поддерживается этот параметр.

public ResourceKind ResourceKinds { get; }

Property Value

ResourceKind

ShortTitle

Возвращает краткое наименование параметра.

public string ShortTitle { get; }

Property Value

string

SystemTypes

Типы систем, в которых поддерживается этот параметр.

public SystemType SystemTypes { get; }

Property Value

SystemType

SystemUnit

Возвращает системную единицу измерения для этого параметра.

public Unit SystemUnit { get; }

Property Value

Unit

SystemUnitTitle

Возвращает наименование системной единицы измерения для этого параметра.

public string SystemUnitTitle { get; }

Property Value

string

Title

Возвращает наименование параметра.

public string Title { get; }

Property Value

string

ValidUnits

Возможные единицы измерения для параметра.

public Unit[] ValidUnits { get; }

Property Value

Unit[]

WaterPipe

Возвращает тип магистрали трубопровода.

public WaterPipe WaterPipe { get; }

Property Value

WaterPipe

WaterValue

Возвращает уникальное значение для ресурса Вода.

public WaterRecordValues WaterValue { get; }

Property Value

WaterRecordValues

Methods

FromUser(int, string, string, string, SystemType, DataParameterCategory)

Создаёт пользовательский параметр.

public static DataParameterDescriptor FromUser(int id, string name, string title, string shortTitle, SystemType systemTypes, DataParameterCategory category)

Parameters

id int
name string
title string
shortTitle string
systemTypes SystemType
category DataParameterCategory

Returns

DataParameterDescriptor

Get(DataParameter)

Получает описание параметра по его значению.

public static DataParameterDescriptor Get(DataParameter param)

Parameters

param DataParameter

Идентификатор параметров.

Returns

DataParameterDescriptor

Get(int)

Возвращает описание параметра по идентификатору.

public static DataParameterDescriptor Get(int paramId)

Parameters

paramId int

Returns

DataParameterDescriptor

GetDefaultDataParametersBySystemType(SystemType, bool)

Возвращает отображаемые параметры по умолчанию для указанной системы.

public static DataParameter[] GetDefaultDataParametersBySystemType(SystemType systemType, bool isTwoChannels)

Parameters

systemType SystemType

Тип системы.

isTwoChannels bool

Признак двухтрубной системы ГВС.

Returns

DataParameter[]

Список отображаемых параметров.

IsStored(ResourceKind)

Определяет, хранится ли этот параметр в базе данных.

public bool IsStored(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

Ресурс, для которого выполняется проверка.

Returns

bool

true, если параметр хранится в базе данных, иначе - false.

ToString()

Возвращает название параметра и его краткое наименование.

public override string ToString()

Returns

string

Название параметра и его краткое наименование.