dsdecmp/CSharp/DSDecmp/Formats/Nitro/CompositeFormats.cs
barubary 4302517e58 C#: Added xml comments to methods that did not have any (in the main DSDecmp project).
The SupportsDecompression-flag is now also used in the main program, and not just in composite formats.
2011-11-14 17:33:30 +00:00

95 lines
2.9 KiB
C#

using System;
using System.Collections.Generic;
using System.Text;
namespace DSDecmp.Formats.Nitro
{
/// <summary>
/// A composite format with all formats supported natively by the GBA.
/// </summary>
public class CompositeGBAFormat : CompositeFormat
{
/// <summary>
/// Creates a new instance of the format composed of all native GBA compression formats.
/// </summary>
public CompositeGBAFormat()
: base(new Huffman4(), new Huffman8(), new LZ10()) { }
/// <summary>
/// Gets a short string identifying this compression format.
/// </summary>
public override string ShortFormatString
{
get { return "GBA"; }
}
/// <summary>
/// Gets a short description of this compression format (used in the program usage).
/// </summary>
public override string Description
{
get { return "All formats natively supported by the GBA."; }
}
/// <summary>
/// Gets if this format supports compressing a file.
/// </summary>
public override bool SupportsCompression
{
get { return true; }
}
/// <summary>
/// Gets the value that must be given on the command line in order to compress using this format.
/// </summary>
public override string CompressionFlag
{
get { return "gba*"; }
}
}
/// <summary>
/// A composite format with all formats supported natively by the NDS (but not LZ-Overlay)
/// </summary>
public class CompositeNDSFormat : CompositeFormat
{
/// <summary>
/// Creates a new instance of the format composed of all native NDS compression formats.
/// </summary>
public CompositeNDSFormat()
: base(new Huffman4(), new Huffman8(), new LZ10(), new LZ11()) { }
/// <summary>
/// Gets a short string identifying this compression format.
/// </summary>
public override string ShortFormatString
{
get { return "NDS"; }
}
/// <summary>
/// Gets a short description of this compression format (used in the program usage).
/// </summary>
public override string Description
{
get { return "All formats natively supported by the NDS."; }
}
/// <summary>
/// Gets if this format supports compressing a file.
/// </summary>
public override bool SupportsCompression
{
get { return true; }
}
/// <summary>
/// Gets the value that must be given on the command line in order to compress using this format.
/// </summary>
public override string CompressionFlag
{
get { return "nds*"; }
}
}
}