FGX.Asserts.TfgAssert: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(Метка: замена)
(summary)
 
(не показано 90 промежуточных версий этого же участника)
Строка 1: Строка 1:
* [[ FGX.Asserts | Вверх к родителю: FGX.Asserts ]]
+
* [[ System.TObject | Вверх к родителю: TObject ]]
* [[ FGX.Asserts.TfgAssert_Methods | Методы ]]
+
* [[ FGX.Asserts | К модулю: FGX.Asserts ]]
* [[ FGX.Asserts.TfgAssert_Properties | Свойства ]]
 
  
 
Delphi
 
Delphi
  
<code>TfgAssert = class (TObject)</code>
+
<syntaxhighlight lang="Delphi">TfgAssert = class (TObject)</syntaxhighlight>
 +
 
 +
<p class="class-inheritance"><span class="type-border">[[System.TObject|TObject]]</span> -> <span class="type-border">[[FGX.Asserts.TfgAssert|TfgAssert]]</span></p>
 +
 
 +
== Описание ==
 +
 
 +
<p>Класс проверки контрактов в коде библиотеке. Отвечает за выполнение базовых проверок. Работает только в DEBUG конфигурации. Во всех остальных проверки вырезаются. По умолчанию, все нарушения выводятся в системный лог устройства.</p>
 +
== Методы ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsTrue(const AValue: [[Boolean]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsFalse(const AValue: [[Boolean]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsMainThread(const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNotMainThread(const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNotNil(const AValue: [[IInterface]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNotNil(const AValue: [[TObject]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNotNil(const AValue: [[TClass]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNotNil(const AValue: [[Pointer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNil(const AValue: [[IInterface]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNil(const AValue: [[TObject]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNil(const AValue: [[TClass]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsNil(const AValue: [[Pointer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">IsClass(const AValue: [[TObject]]; const AClass: [[TClass]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Implements(const AValue: [[TObject]]; const AInterface: [[TGUID]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">InRange(const AValue: [[Integer]]; const ALow: [[Integer]]; const AHigh: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">InRange(const AValue: [[Extended]]; const ALow: [[Extended]]; const AHigh: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">InRange(const AValue: [[Single]]; const ALow: [[Single]]; const AHigh: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickLessThan(const AValue: [[Integer]]; const AHigh: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickLessThan(const AValue: [[Extended]]; const AHigh: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickLessThan(const AValue: [[Single]]; const AHigh: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickMoreThan(const AValue: [[Integer]]; const ALow: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickMoreThan(const AValue: [[Extended]]; const ALow: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">StrickMoreThan(const AValue: [[Single]]; const ALow: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">LessAndEqualThan(const AValue: [[Integer]]; const AHigh: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">LessAndEqualThan(const AValue: [[Extended]]; const AHigh: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">LessAndEqualThan(const AValue: [[Single]]; const AHigh: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">MoreAndEqualThan(const AValue: [[Integer]]; const ALow: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">MoreAndEqualThan(const AValue: [[Extended]]; const ALow: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">MoreAndEqualThan(const AValue: [[Single]]; const ALow: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">AreEqual(const AValue1: [[Integer]]; const AValue2: [[Integer]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">AreEqual(const AValue1: [[Extended]]; const AValue2: [[Extended]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">AreEqual(const AValue1: [[Single]]; const AValue2: [[Single]]; const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">Fail(const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">class procedure</syntaxhighlight> || <code lang="Delphi">NotImplemented(const AMessage: [[string]])</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|}
 +
 
 +
== Свойства ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>FailCallback: [[TfgAssertFailCallback|TfgAssertFailCallback]]</code>
 +
 
 +
<p>Коллбек, который вызывается в случаях нарушения контракта.</p><div class="info">Используйте этот колбек для того, чтобы выполнить логирование нарушения контракта в своей системе логов. Например: можно отправить эту информацию на ваш сервер или в любое другое место.</div>
 +
|}

Текущая версия на 03:12, 6 декабря 2021

Delphi

TfgAssert = class (TObject)

TObject -> TfgAssert

Описание

Класс проверки контрактов в коде библиотеке. Отвечает за выполнение базовых проверок. Работает только в DEBUG конфигурации. Во всех остальных проверки вырезаются. По умолчанию, все нарушения выводятся в системный лог устройства.

Методы

class procedure
IsTrue(const AValue: Boolean; const AMessage: string)

Описание отсутствует.

class procedure
IsFalse(const AValue: Boolean; const AMessage: string)

Описание отсутствует.

class procedure
IsMainThread(const AMessage: string)

Описание отсутствует.

class procedure
IsNotMainThread(const AMessage: string)

Описание отсутствует.

class procedure
IsNotNil(const AValue: IInterface; const AMessage: string)

Описание отсутствует.

class procedure
IsNotNil(const AValue: TObject; const AMessage: string)

Описание отсутствует.

class procedure
IsNotNil(const AValue: TClass; const AMessage: string)

Описание отсутствует.

class procedure
IsNotNil(const AValue: Pointer; const AMessage: string)

Описание отсутствует.

class procedure
IsNil(const AValue: IInterface; const AMessage: string)

Описание отсутствует.

class procedure
IsNil(const AValue: TObject; const AMessage: string)

Описание отсутствует.

class procedure
IsNil(const AValue: TClass; const AMessage: string)

Описание отсутствует.

class procedure
IsNil(const AValue: Pointer; const AMessage: string)

Описание отсутствует.

class procedure
IsClass(const AValue: TObject; const AClass: TClass; const AMessage: string)

Описание отсутствует.

class procedure
Implements(const AValue: TObject; const AInterface: TGUID; const AMessage: string)

Описание отсутствует.

class procedure
InRange(const AValue: Integer; const ALow: Integer; const AHigh: Integer; const AMessage: string)

Описание отсутствует.

class procedure
InRange(const AValue: Extended; const ALow: Extended; const AHigh: Extended; const AMessage: string)

Описание отсутствует.

class procedure
InRange(const AValue: Single; const ALow: Single; const AHigh: Single; const AMessage: string)

Описание отсутствует.

class procedure
StrickLessThan(const AValue: Integer; const AHigh: Integer; const AMessage: string)

Описание отсутствует.

class procedure
StrickLessThan(const AValue: Extended; const AHigh: Extended; const AMessage: string)

Описание отсутствует.

class procedure
StrickLessThan(const AValue: Single; const AHigh: Single; const AMessage: string)

Описание отсутствует.

class procedure
StrickMoreThan(const AValue: Integer; const ALow: Integer; const AMessage: string)

Описание отсутствует.

class procedure
StrickMoreThan(const AValue: Extended; const ALow: Extended; const AMessage: string)

Описание отсутствует.

class procedure
StrickMoreThan(const AValue: Single; const ALow: Single; const AMessage: string)

Описание отсутствует.

class procedure
LessAndEqualThan(const AValue: Integer; const AHigh: Integer; const AMessage: string)

Описание отсутствует.

class procedure
LessAndEqualThan(const AValue: Extended; const AHigh: Extended; const AMessage: string)

Описание отсутствует.

class procedure
LessAndEqualThan(const AValue: Single; const AHigh: Single; const AMessage: string)

Описание отсутствует.

class procedure
MoreAndEqualThan(const AValue: Integer; const ALow: Integer; const AMessage: string)

Описание отсутствует.

class procedure
MoreAndEqualThan(const AValue: Extended; const ALow: Extended; const AMessage: string)

Описание отсутствует.

class procedure
MoreAndEqualThan(const AValue: Single; const ALow: Single; const AMessage: string)

Описание отсутствует.

class procedure
AreEqual(const AValue1: Integer; const AValue2: Integer; const AMessage: string)

Описание отсутствует.

class procedure
AreEqual(const AValue1: Extended; const AValue2: Extended; const AMessage: string)

Описание отсутствует.

class procedure
AreEqual(const AValue1: Single; const AValue2: Single; const AMessage: string)

Описание отсутствует.

class procedure
Fail(const AMessage: string)

Описание отсутствует.

class procedure
NotImplemented(const AMessage: string)

Описание отсутствует.

Свойства

property
FailCallback: TfgAssertFailCallback

Коллбек, который вызывается в случаях нарушения контракта.

Используйте этот колбек для того, чтобы выполнить логирование нарушения контракта в своей системе логов. Например: можно отправить эту информацию на ваш сервер или в любое другое место.