[Items/] Add descriptors to each class

This commit is contained in:
Matt Nadareski
2017-10-09 12:58:46 -07:00
parent 2264dbebc5
commit 636df5f0b5
8 changed files with 66 additions and 11 deletions

View File

@@ -1,8 +1,10 @@
using System;
using SabreTools.Library.Data;
using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents generic archive files to be included in a set
/// </summary>
public class Archive : DatItem
{
#region Constructors

View File

@@ -2,6 +2,9 @@
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents which BIOS(es) is associated with a set
/// </summary>
public class BiosSet : DatItem
{
#region Private instance variables

View File

@@ -14,6 +14,9 @@ using NaturalSort;
namespace SabreTools.Library.Items
{
/// <summary>
/// Base class for all items included in a set
/// </summary>
public abstract class DatItem : IEquatable<DatItem>, IComparable<DatItem>, ICloneable
{
#region Protected instance variables

View File

@@ -4,6 +4,9 @@ using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents Compressed Hunks of Data (CHD) formatted disks which use internal hashes
/// </summary>
public class Disk : DatItem
{
#region Private instance variables

View File

@@ -5,6 +5,9 @@ using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents the information specific to a set/game/machine
/// </summary>
public class Machine : ICloneable
{
#region Protected instance variables

View File

@@ -1,9 +1,10 @@
using System;
using SabreTools.Library.Data;
using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents release information about a set
/// </summary>
public class Release : DatItem
{
#region Private instance variables

View File

@@ -4,14 +4,23 @@ using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
public class Rom : Disk, ICloneable
/// <summary>
/// Represents a generic file within a set
/// </summary>
public class Rom : DatItem
{
#region Private instance variables
// Rom information
protected long _size;
protected string _crc;
private long _size;
private string _crc;
private string _md5;
private string _sha1;
private string _sha256;
private string _sha384;
private string _sha512;
private string _date;
private ItemStatus _itemStatus;
#endregion
@@ -28,11 +37,41 @@ namespace SabreTools.Library.Items
get { return _crc; }
set { _crc = value; }
}
public string MD5
{
get { return _md5; }
set { _md5 = value; }
}
public string SHA1
{
get { return _sha1; }
set { _sha1 = value; }
}
public string SHA256
{
get { return _sha256; }
set { _sha256 = value; }
}
public string SHA384
{
get { return _sha384; }
set { _sha384 = value; }
}
public string SHA512
{
get { return _sha512; }
set { _sha512 = value; }
}
public string Date
{
get { return _date; }
set { _date = value; }
}
public ItemStatus ItemStatus
{
get { return _itemStatus; }
set { _itemStatus = value; }
}
#endregion

View File

@@ -1,9 +1,10 @@
using System;
using SabreTools.Library.Data;
using SabreTools.Library.Data;
namespace SabreTools.Library.Items
{
/// <summary>
/// Represents a (usually WAV-formatted) sample to be included for use in the set
/// </summary>
public class Sample : DatItem
{
#region Constructors