Table of Contents

Class DataParameterDescriptor

Namespace
Lers.Data
Assembly
Lers.Core.dll

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

public class DataParameterDescriptor
Inheritance
DataParameterDescriptor
Inherited Members
Extension Methods

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

ElectricConsumptionInTable 

public static IEnumerable<DataParameterDescriptor> ElectricConsumptionInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

ElectricCurrentsParams

Возвращает параметры текущих данных для ресурса Электричество (Параметры качества электроэнергии).

public static ReadOnlyCollection<DataParameterDescriptor> ElectricCurrentsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricCurrentsValue

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

public ElectricCurrentsRecordValues ElectricCurrentsValue { get; }

Property Value

ElectricCurrentsRecordValues

ElectricLastConsumptionParams

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

public static ReadOnlyCollection<DataParameterDescriptor> ElectricLastConsumptionParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricLastTotalsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> ElectricLastTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricParams

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

public static ReadOnlyCollection<DataParameterDescriptor> ElectricParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricPhase

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

public ElectricPhase ElectricPhase { get; }

Property Value

ElectricPhase

ElectricPowerParams

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

public static ReadOnlyCollection<DataParameterDescriptor> ElectricPowerParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricPowerValue

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

public ElectricPowerRecordValues ElectricPowerValue { get; }

Property Value

ElectricPowerRecordValues

ElectricTotalsInTable

Возвращает интеграторы по электричеству, которые хранятся в таблице с данными.

public static IEnumerable<DataParameterDescriptor> ElectricTotalsInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

ElectricTotalsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> ElectricTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

ElectricValue

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

public ElectricRecordValues ElectricValue { get; }

Property Value

ElectricRecordValues

FieldName

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

public string FieldName { get; }

Property Value

string

FullTitle

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

public string FullTitle { get; }

Property Value

string

GasConsumptionInTable 

public static IEnumerable<DataParameterDescriptor> GasConsumptionInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

GasCurrentsInTable 

public static IEnumerable<DataParameterDescriptor> GasCurrentsInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

GasCurrentsParams

Возвращает текущие параметры потребления и интеграторы для ресурса Газ.

public static ReadOnlyCollection<DataParameterDescriptor> GasCurrentsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

GasLastConsumptionParams

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

public static ReadOnlyCollection<DataParameterDescriptor> GasLastConsumptionParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

GasLastTotalsParams

Возвращает параметры последних данных интеграторов для ресурса Газ.

public static ReadOnlyCollection<DataParameterDescriptor> GasLastTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

GasParams

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

public static ReadOnlyCollection<DataParameterDescriptor> GasParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

GasTotalsInTable

Возвращает интеграторы по газу, которые хранятся в таблице с данными.

public static IEnumerable<DataParameterDescriptor> GasTotalsInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

GasTotalsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> GasTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

GasValue

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

public GasRecordValues GasValue { get; }

Property Value

GasRecordValues

IsAdditive

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

public bool IsAdditive { get; }

Property Value

bool

IsEav

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

public bool IsEav { 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>

ReportFieldName

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

public string ReportFieldName { get; }

Property Value

string

ResourceKinds

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

public ResourceKind ResourceKinds { get; }

Property Value

ResourceKind

ShortTitle

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

public string ShortTitle { get; }

Property Value

string

SystemParams

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

public static Dictionary<SystemType, ReadOnlyCollection<DataParameterDescriptor>> SystemParams { get; }

Property Value

Dictionary<SystemType, ReadOnlyCollection<DataParameterDescriptor>>

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[]

WaterConsumptionInTable 

public static IEnumerable<DataParameterDescriptor> WaterConsumptionInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

WaterCurrentsInTable 

public static IEnumerable<DataParameterDescriptor> WaterCurrentsInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

WaterCurrentsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> WaterCurrentsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

WaterLastConsumptionParams

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

public static ReadOnlyCollection<DataParameterDescriptor> WaterLastConsumptionParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

WaterLastTotalsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> WaterLastTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

WaterParams

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

public static ReadOnlyCollection<DataParameterDescriptor> WaterParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

WaterPipe

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

public WaterPipe WaterPipe { get; }

Property Value

WaterPipe

WaterTotalsInTable

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

public static IEnumerable<DataParameterDescriptor> WaterTotalsInTable { get; }

Property Value

IEnumerable<DataParameterDescriptor>

WaterTotalsParams

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

public static ReadOnlyCollection<DataParameterDescriptor> WaterTotalsParams { get; }

Property Value

ReadOnlyCollection<DataParameterDescriptor>

WaterValue

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

public WaterRecordValues WaterValue { get; }

Property Value

WaterRecordValues

Methods

Get(DataParameter)

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

public static DataParameterDescriptor Get(DataParameter param)

Parameters

param DataParameter

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

Returns

DataParameterDescriptor

GetDefaultDataParametersBySystemType(SystemType, bool)

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

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

Parameters

systemType SystemType

Тип системы.

isTwoChannels bool

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

Returns

DataParameter[]

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

GetResourceParams(ResourceKind)

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

public static IList<DataParameterDescriptor> GetResourceParams(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

Тип ресурса.

Returns

IList<DataParameterDescriptor>

Список параметров.

GetResourceTotalParams(ResourceKind)

Возвращает список интегральных параметров для указанного ресурса.

public static IList<DataParameterDescriptor> GetResourceTotalParams(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

Returns

IList<DataParameterDescriptor>

GetStoredResourceParams(ResourceKind)

Возвращает список всех параметров ресурса, которые сохраняются в БД.

public static IEnumerable<DataParameterDescriptor> GetStoredResourceParams(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

Returns

IEnumerable<DataParameterDescriptor>

GetValueId(ResourceKind)

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

public long GetValueId(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

Ресурс.

Returns

long

Идентификатор в виде целого числа.

GetValueId(DataRecordType)

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

public long GetValueId(DataRecordType recordType)

Parameters

recordType DataRecordType

Тип записи.

Returns

long

Идентификатор в виде целого числа.

IsExists(DataParameter)

Определяет существует ли такой параметр.

public static bool IsExists(DataParameter param)

Parameters

param DataParameter

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

Returns

bool

true, если параметр существует, иначе - false.

IsStored(ResourceKind)

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

public bool IsStored(ResourceKind resourceKind)

Parameters

resourceKind ResourceKind

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

Returns

bool

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

IsWorkTimeParameter(DataParameter)

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

public static bool IsWorkTimeParameter(DataParameter parameter)

Parameters

parameter DataParameter

Параметр.

Returns

bool

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

RecordValueToDataParameter(ElectricCurrentsRecordValues)

Преобразовывает значение ElectricCurrentsRecordValues в DataParameter.

public static DataParameter RecordValueToDataParameter(ElectricCurrentsRecordValues recordValue)

Parameters

recordValue ElectricCurrentsRecordValues

Returns

DataParameter

RecordValueToDataParameter(ElectricPowerRecordValues)

Преобразовывает значение ElectricPowerRecordValues в DataParameter.

public static DataParameter RecordValueToDataParameter(ElectricPowerRecordValues recordValue)

Parameters

recordValue ElectricPowerRecordValues

Returns

DataParameter

RecordValueToDataParameter(ElectricRecordValues)

Преобразовывает значение ElectricRecordValues в DataParameter.

public static DataParameter RecordValueToDataParameter(ElectricRecordValues recordValue)

Parameters

recordValue ElectricRecordValues

Returns

DataParameter

RecordValueToDataParameter(GasRecordValues)

Преобразовывает значение ElectricRecordValues в DataParameter.

public static DataParameter RecordValueToDataParameter(GasRecordValues recordValue)

Parameters

recordValue GasRecordValues

Returns

DataParameter

RecordValueToDataParameter(WaterRecordValues)

Преобразовывает значение ElectricRecordValues в DataParameter.

public static DataParameter RecordValueToDataParameter(WaterRecordValues recordValue)

Parameters

recordValue WaterRecordValues

Returns

DataParameter

ToString()

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

public override string ToString()

Returns

string

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

TryGet(DataParameter, out DataParameterDescriptor)

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

public static bool TryGet(DataParameter param, out DataParameterDescriptor result)

Parameters

param DataParameter
result DataParameterDescriptor

Returns

bool