Class NoticeFrameRow

PID controller for automatic adjustment of pop up message check rate
Row Object for table 'notice_frame'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
NoticeFrameRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class NoticeFrameRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks

Row objects can be created in several ways.

  • Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
  • You can create a (nested) NoticeFrameRow NoticeFrameRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(NoticeFrameRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
  • For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
  • Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the NoticeFrameTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, NoticeFrameTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Non-unique indexes are handled through the NoticeFrameRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, NoticeFrameTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table NoticeFrame are:

Index fieldsNested index class name

Constructors

NoticeFrameRow(NoticeFrameRow.NoticeFrameRowIdxBase)

Constructor for the class taking an index as argument. PID controller for automatic adjustment of pop up message check rate

Declaration
protected NoticeFrameRow(NoticeFrameRow.NoticeFrameRowIdxBase idx)
Parameters
Type Name Description
NoticeFrameRow.NoticeFrameRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAverageDt

Current value, see property AverageDt.

Declaration
protected double _currentAverageDt
Field Value
Type Description
Double

_currentErrorD

Current value, see property ErrorD.

Declaration
protected double _currentErrorD
Field Value
Type Description
Double

_currentErrorI

Current value, see property ErrorI.

Declaration
protected double _currentErrorI
Field Value
Type Description
Double

_currentErrorP

Current value, see property ErrorP.

Declaration
protected double _currentErrorP
Field Value
Type Description
Double

_currentNoticeFrameId

Current value, see property NoticeFrameId.

Declaration
protected int _currentNoticeFrameId
Field Value
Type Description
Int32

_currentRefreshRate

Current value, see property RefreshRate.

Declaration
protected double _currentRefreshRate
Field Value
Type Description
Double

_currentT0

Current value, see property T0.

Declaration
protected double _currentT0
Field Value
Type Description
Double

_persistedAverageDt

Persisted value, see property AverageDt.

Declaration
protected double _persistedAverageDt
Field Value
Type Description
Double

_persistedErrorD

Persisted value, see property ErrorD.

Declaration
protected double _persistedErrorD
Field Value
Type Description
Double

_persistedErrorI

Persisted value, see property ErrorI.

Declaration
protected double _persistedErrorI
Field Value
Type Description
Double

_persistedErrorP

Persisted value, see property ErrorP.

Declaration
protected double _persistedErrorP
Field Value
Type Description
Double

_persistedNoticeFrameId

Persisted value, see property NoticeFrameId.

Declaration
protected int _persistedNoticeFrameId
Field Value
Type Description
Int32

_persistedRefreshRate

Persisted value, see property RefreshRate.

Declaration
protected double _persistedRefreshRate
Field Value
Type Description
Double

_persistedT0

Persisted value, see property T0.

Declaration
protected double _persistedT0
Field Value
Type Description
Double

Properties

AverageDt

.NET type: double. Average dt

Declaration
public virtual double AverageDt { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ErrorD

.NET type: double. PID error D

Declaration
public virtual double ErrorD { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ErrorI

.NET type: double. PID error I

Declaration
public virtual double ErrorI { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ErrorP

.NET type: double. PID error P

Declaration
public virtual double ErrorP { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides

Item[String]

Get or set a value based on the name of the field.

Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type Name Description
String fieldName

Name of the field in the database
Property Value
Type Description
Object

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

NoticeFrameId

.NET type: int. The primary key (auto-incremented)

Declaration
public virtual int NoticeFrameId { get; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: PK.

This field is the primary key and can only be read, never written.

This field is not protected by the Sentry system, and can always be read

NoticeFrameTableInfo

Get the NoticeFrameTableInfo object associated with the row.

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

RefreshRate

.NET type: double. Notice frame refresh rate

Declaration
public virtual double RefreshRate { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

T0

.NET type: double. Last executing

Declaration
public virtual double T0 { get; set; }
Property Value
Type Description
Double
Remarks

Original type in dictionary: Double.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

Methods

CreateNew()

Create a new instance of the NoticeFrameRow object. PID controller for automatic adjustment of pop up message check rate

Declaration
public static NoticeFrameRow CreateNew()
Returns
Type Description
NoticeFrameRow

A new instance of the NoticeFrameRow object.

GetFromCustomSearch(NoticeFrameRow.CustomSearch)

Create a new instance of the NoticeFrameRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).

Declaration
public static NoticeFrameRow GetFromCustomSearch(NoticeFrameRow.CustomSearch query)
Parameters
Type Name Description
NoticeFrameRow.CustomSearch query

The custom search to execute against the database
Returns
Type Description
NoticeFrameRow

A new instance of the NoticeFrameRow object, reflecting the result of the query.

GetFromIdxNoticeFrameId(Int32)

Create a new instance of the NoticeFrameRow object, by querying the database table via the index 'IDXNotice_frameId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static NoticeFrameRow GetFromIdxNoticeFrameId(int noticeFrameId)
Parameters
Type Name Description
Int32 noticeFrameId
Returns
Type Description
NoticeFrameRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the NoticeFrame table. Non-unique indexes have corresponding inner classes and methods in the NoticeFrameRows collection, since they may return more than one row.

GetFromReader(SoDataReader, NoticeFrameTableInfo)

Create a new instance of the NoticeFrameRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. PID controller for automatic adjustment of pop up message check rate

Declaration
public static NoticeFrameRow GetFromReader(SoDataReader reader, NoticeFrameTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
NoticeFrameTableInfo tableInfo

NoticeFrameTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
NoticeFrameRow

A new instance of the NoticeFrameRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Boolean

True if the value is known and sentry permits read.
Overrides

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.
TableInfo tableInfo

The TableInfo used for the SELECT statement.
Overrides

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.
Overrides
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)
Overrides

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle
Overrides

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.
Overrides

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation
Overrides

Events

_onAverageDtChange

Change envent for property AverageDt; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onAverageDtChange
Event Type
Type Description
OnFieldChange<Double>

_onErrorDChange

Change envent for property ErrorD; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onErrorDChange
Event Type
Type Description
OnFieldChange<Double>

_onErrorIChange

Change envent for property ErrorI; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onErrorIChange
Event Type
Type Description
OnFieldChange<Double>

_onErrorPChange

Change envent for property ErrorP; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onErrorPChange
Event Type
Type Description
OnFieldChange<Double>

_onRefreshRateChange

Change envent for property RefreshRate; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onRefreshRateChange
Event Type
Type Description
OnFieldChange<Double>

_onT0Change

Change envent for property T0; field is of .NET type double.

Declaration
protected event OnFieldChange<double> _onT0Change
Event Type
Type Description
OnFieldChange<Double>

OnAverageDtChange

Event raised when AverageDt is changing.

Declaration
public event OnFieldChange<double> OnAverageDtChange
Event Type
Type Description
OnFieldChange<Double>

OnErrorDChange

Event raised when ErrorD is changing.

Declaration
public event OnFieldChange<double> OnErrorDChange
Event Type
Type Description
OnFieldChange<Double>

OnErrorIChange

Event raised when ErrorI is changing.

Declaration
public event OnFieldChange<double> OnErrorIChange
Event Type
Type Description
OnFieldChange<Double>

OnErrorPChange

Event raised when ErrorP is changing.

Declaration
public event OnFieldChange<double> OnErrorPChange
Event Type
Type Description
OnFieldChange<Double>

OnRefreshRateChange

Event raised when RefreshRate is changing.

Declaration
public event OnFieldChange<double> OnRefreshRateChange
Event Type
Type Description
OnFieldChange<Double>

OnT0Change

Event raised when T0 is changing.

Declaration
public event OnFieldChange<double> OnT0Change
Event Type
Type Description
OnFieldChange<Double>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)