C# Class Depressurizer.AutoCat

Abstract base class for autocategorization schemes. Call PreProcess before any set of autocat operations. This is a preliminary form, and may change in future versions. Returning only true / false on a categorization attempt may prove too simplistic.
Mostrar archivo Open project: Theo47/depressurizer Class Usage Examples

Protected Properties

Property Type Description
db Depressurizer.GameDB
games GameList

Public Methods

Method Description
CategorizeGame ( GameInfo game, Depressurizer.Filter filter ) : AutoCatResult

Applies this autocategorization scheme to the game with the given ID.
CategorizeGame ( int gameId, Depressurizer.Filter filter ) : AutoCatResult

Applies this autocategorization scheme to the game with the given ID.
Clone ( ) : AutoCat
CompareTo ( object other ) : int
Create ( AutoCatType type, string name ) : AutoCat
DeProcess ( ) : void
LoadACFromXmlElement ( XmlElement xElement ) : AutoCat
PreProcess ( GameList games, Depressurizer.GameDB db ) : void

Must be called before any categorizations are done. Should be overridden to perform any necessary database analysis or other preparation. After this is called, no configuration options should be changed before using CategorizeGame.
ToString ( ) : string
WriteToXml ( XmlWriter writer ) : void

Protected Methods

Method Description
AutoCat ( AutoCat other ) : System
AutoCat ( string name ) : System

Method Details

AutoCat() protected method

protected AutoCat ( AutoCat other ) : System
other AutoCat
return System

AutoCat() protected method

protected AutoCat ( string name ) : System
name string
return System

CategorizeGame() public abstract method

Applies this autocategorization scheme to the game with the given ID.
public abstract CategorizeGame ( GameInfo game, Depressurizer.Filter filter ) : AutoCatResult
game GameInfo The GameInfo object to process
filter Depressurizer.Filter
return AutoCatResult

CategorizeGame() public method

Applies this autocategorization scheme to the game with the given ID.
public CategorizeGame ( int gameId, Depressurizer.Filter filter ) : AutoCatResult
gameId int The game ID to process
filter Depressurizer.Filter
return AutoCatResult

Clone() public abstract method

public abstract Clone ( ) : AutoCat
return AutoCat

CompareTo() public method

public CompareTo ( object other ) : int
other object
return int

Create() public static method

public static Create ( AutoCatType type, string name ) : AutoCat
type AutoCatType
name string
return AutoCat

DeProcess() public method

public DeProcess ( ) : void
return void

LoadACFromXmlElement() public static method

public static LoadACFromXmlElement ( XmlElement xElement ) : AutoCat
xElement System.Xml.XmlElement
return AutoCat

PreProcess() public method

Must be called before any categorizations are done. Should be overridden to perform any necessary database analysis or other preparation. After this is called, no configuration options should be changed before using CategorizeGame.
public PreProcess ( GameList games, Depressurizer.GameDB db ) : void
games GameList
db Depressurizer.GameDB
return void

ToString() public method

public ToString ( ) : string
return string

WriteToXml() public abstract method

public abstract WriteToXml ( XmlWriter writer ) : void
writer System.Xml.XmlWriter
return void

Property Details

db protected_oe property

protected GameDB,Depressurizer db
return Depressurizer.GameDB

games protected_oe property

protected GameList,Depressurizer games
return GameList