<Type Name="Assertion" FullName="NUnit.Framework.Assertion">
  <TypeSignature Language="C#" Value="public class Assertion" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>NUnit.Framework</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>2.1.4.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes>
      <Attribute>
        <AttributeName>System.CLSCompliantAttribute</AttributeName>
      </Attribute>
    </Attributes>
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
  <Docs>
    <summary>
    The class Assertion is used to make assertions in methods flaged as a Test in a class flages as a TestFixture.
    </summary>
    <remarks>
      <para>
    Note: It is not mandatory to inherit from Assertion, 
    but if you do, the code becomes a little more clear and you will save some typing.
    Assertion.AssertionEquals (...) vs AssertionEquals (...)
    </para>
      <para>
    A good idea is to tag your Test with the name of the test and a number. 
    That information can be used when generating bug reports.
    </para>
      <example>
        <code lang="C#">
    using NUnit.Framework;

    [TestFixture]
    public class MyUnitTest : Assertion {

	string foo;

	[SetUp]
	public void GetReady()
	{
		foo = "Foobar";
	}

	[Test]
	public void TestLength()
	{
		AssertEquals ("(1) Length", 6, foo.Length);
	}
    }
    </code>
      </example>
    </remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Fail">
      <MemberSignature Language="C#" Value="public static void Fail (string message);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
      </Parameters>
      <Docs>
        <summary>Fails a Test with a message</summary>
        <param name="message">The message</param>
      </Docs>
    </Member>
    <Member MemberName="Fail">
      <MemberSignature Language="C#" Value="public static void Fail ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Fails a Test</summary>
      </Docs>
    </Member>
    <Member MemberName="AssertSame">
      <MemberSignature Language="C#" Value="public static void AssertSame (string message, object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Assert that two references refers to the same object</summary>
        <param name="message">A message</param>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertSame">
      <MemberSignature Language="C#" Value="public static void AssertSame (object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Assert that two references refers to the same object</summary>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNull">
      <MemberSignature Language="C#" Value="public static void AssertNull (string message, object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object references null</summary>
        <param name="message">A message</param>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNull">
      <MemberSignature Language="C#" Value="public static void AssertNull (object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object references null</summary>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNotNull">
      <MemberSignature Language="C#" Value="public static void AssertNotNull (string message, object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object do not reference null</summary>
        <param name="message">A message</param>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertNotNull">
      <MemberSignature Language="C#" Value="public static void AssertNotNull (object anObject);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="anObject" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that an object do not reference null</summary>
        <param name="anObject">The object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that two objects are Equal</summary>
        <param name="message">A message</param>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, float expected, float actual, float delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Single" />
        <Parameter Name="actual" Type="System.Single" />
        <Parameter Name="delta" Type="System.Single" />
      </Parameters>
      <Docs>
        <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, double expected, double actual, double delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Double" />
        <Parameter Name="actual" Type="System.Double" />
        <Parameter Name="delta" Type="System.Double" />
      </Parameters>
      <Docs>
        <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (string message, int expected, int actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="expected" Type="System.Int32" />
        <Parameter Name="actual" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Asserts that two ints are equal</summary>
        <param name="message">A message</param>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (int expected, int actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Int32" />
        <Parameter Name="actual" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Asserts that two ints are equal</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (object expected, object actual);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Object" />
        <Parameter Name="actual" Type="System.Object" />
      </Parameters>
      <Docs>
        <summary>Asserts that two objects are Equal</summary>
        <param name="expected">The expected object</param>
        <param name="actual">The actual object</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (float expected, float actual, float delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Single" />
        <Parameter Name="actual" Type="System.Single" />
        <Parameter Name="delta" Type="System.Single" />
      </Parameters>
      <Docs>
        <summary>Asserts that two floats are equal, accepting some difference expresed by the delta</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="AssertEquals">
      <MemberSignature Language="C#" Value="public static void AssertEquals (double expected, double actual, double delta);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="expected" Type="System.Double" />
        <Parameter Name="actual" Type="System.Double" />
        <Parameter Name="delta" Type="System.Double" />
      </Parameters>
      <Docs>
        <summary>Asserts that two doubles are equal, accepting some difference expresed by the delta</summary>
        <param name="expected">The expected</param>
        <param name="actual">The actual</param>
        <param name="delta">The delta difference allowed</param>
      </Docs>
    </Member>
    <Member MemberName="Assert">
      <MemberSignature Language="C#" Value="public static void Assert (bool condition);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="condition" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Asserts that a condition is true</summary>
        <param name="condition">The condition</param>
      </Docs>
    </Member>
    <Member MemberName="Assert">
      <MemberSignature Language="C#" Value="public static void Assert (string message, bool condition);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="message" Type="System.String" />
        <Parameter Name="condition" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Asserts that a condition is true</summary>
        <param name="message">A message</param>
        <param name="condition">The condition</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Assertion ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Creates an Assertion object</summary>
        <remarks>Should not be used, all methods are static</remarks>
      </Docs>
    </Member>
  </Members>
</Type>