Class DataParameterDescriptor

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

Inheritance
System.Object
DataParameterDescriptor
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lers.Data
Assembly: Lers.Core.dll
Syntax
public class DataParameterDescriptor

Fields

UserDescriptorStartId

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

Declaration
public const int UserDescriptorStartId = 100000
Field Value
Type Description
System.Int32

Properties

Category

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

Declaration
public DataParameterCategory Category { get; }
Property Value
Type Description
DataParameterCategory

CategoryDescriptor

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

Declaration
public DataParameterCategoryDescriptor CategoryDescriptor { get; }
Property Value
Type Description
DataParameterCategoryDescriptor

DataParameter

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

Declaration
public DataParameter DataParameter { get; }
Property Value
Type Description
DataParameter

ElectricCurrentsValue

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

Declaration
public ElectricCurrentsRecordValues ElectricCurrentsValue { get; }
Property Value
Type Description
ElectricCurrentsRecordValues

ElectricPhase

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

Declaration
public ElectricPhase ElectricPhase { get; }
Property Value
Type Description
ElectricPhase

ElectricPowerValue

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

Declaration
public ElectricPowerRecordValues ElectricPowerValue { get; }
Property Value
Type Description
ElectricPowerRecordValues

ElectricValue

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

Declaration
public ElectricRecordValues ElectricValue { get; }
Property Value
Type Description
ElectricRecordValues

ElectricValueType

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

Declaration
public ElectricValueType ElectricValueType { get; }
Property Value
Type Description
ElectricValueType

FieldName

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

Declaration
public string FieldName { get; }
Property Value
Type Description
System.String

FullTitle

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

Declaration
public string FullTitle { get; }
Property Value
Type Description
System.String

GasValue

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

Declaration
public GasRecordValues GasValue { get; }
Property Value
Type Description
GasRecordValues

Id

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

Declaration
public int Id { get; }
Property Value
Type Description
System.Int32

Instance

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

Declaration
public static IDataParameterDescriptorsStore Instance { get; }
Property Value
Type Description
IDataParameterDescriptorsStore

IsAdditive

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

Declaration
public bool IsAdditive { get; }
Property Value
Type Description
System.Boolean

IsEav

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

Declaration
public bool IsEav { get; }
Property Value
Type Description
System.Boolean

IsUser

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

Declaration
public bool IsUser { get; }
Property Value
Type Description
System.Boolean

IsWorkTime

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

Declaration
public bool IsWorkTime { get; }
Property Value
Type Description
System.Boolean

Name

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

Declaration
public string Name { get; }
Property Value
Type Description
System.String

Params

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

Declaration
public static ReadOnlyCollection<DataParameterDescriptor> Params { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<DataParameterDescriptor>

RecordTypes

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

Declaration
public HashSet<DataRecordType> RecordTypes { get; }
Property Value
Type Description
HashSet<DataRecordType>

ReportFieldName

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

Declaration
public string ReportFieldName { get; }
Property Value
Type Description
System.String

ResourceKinds

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

Declaration
public ResourceKind ResourceKinds { get; }
Property Value
Type Description
ResourceKind

ShortTitle

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

Declaration
public string ShortTitle { get; }
Property Value
Type Description
System.String

SystemTypes

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

Declaration
public SystemType SystemTypes { get; }
Property Value
Type Description
SystemType

SystemUnit

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

Declaration
public Unit SystemUnit { get; }
Property Value
Type Description
Unit

SystemUnitTitle

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

Declaration
public string SystemUnitTitle { get; }
Property Value
Type Description
System.String

Title

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

Declaration
public string Title { get; }
Property Value
Type Description
System.String

ValidUnits

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

Declaration
public Unit[] ValidUnits { get; }
Property Value
Type Description
Unit[]

WaterPipe

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

Declaration
public WaterPipe WaterPipe { get; }
Property Value
Type Description
WaterPipe

WaterValue

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

Declaration
public WaterRecordValues WaterValue { get; }
Property Value
Type Description
WaterRecordValues

Methods

FromUser(Int32, String, String, String, SystemType, DataParameterCategory)

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

Declaration
public static DataParameterDescriptor FromUser(int id, string name, string title, string shortTitle, SystemType systemTypes, DataParameterCategory category)
Parameters
Type Name Description
System.Int32 id
System.String name
System.String title
System.String shortTitle
SystemType systemTypes
DataParameterCategory category
Returns
Type Description
DataParameterDescriptor

Get(DataParameter)

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

Declaration
public static DataParameterDescriptor Get(DataParameter param)
Parameters
Type Name Description
DataParameter param

Идентификатор параметров.
Returns
Type Description
DataParameterDescriptor

Get(Int32)

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

Declaration
public static DataParameterDescriptor Get(int paramId)
Parameters
Type Name Description
System.Int32 paramId
Returns
Type Description
DataParameterDescriptor

GetDefaultDataParametersBySystemType(SystemType, Boolean)

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

Declaration
public static DataParameter[] GetDefaultDataParametersBySystemType(SystemType systemType, bool isTwoChannels)
Parameters
Type Name Description
SystemType systemType

Тип системы.
System.Boolean isTwoChannels

Признак двухтрубной системы ГВС.
Returns
Type Description
DataParameter[]

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

IsStored(ResourceKind)

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

Declaration
public bool IsStored(ResourceKind resourceKind)
Parameters
Type Name Description
ResourceKind resourceKind

Ресурс, для которого выполняется проверка.
Returns
Type Description
System.Boolean

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
System.String

Название параметра и его краткое наименование.
Overrides
System.Object.ToString()

Extension Methods