Craig's Utility Library  4.0 Beta
Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType > Class Template Referenceabstract

Format base class More...

Inheritance diagram for Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >:
Utilities.IO.FileFormats.Interfaces.IFormat< FormatType, ContentType >

Public Member Functions

abstract object Clone ()
 Clones the object More...
 
int CompareTo (object obj)
 Compares the object to another object More...
 
abstract int CompareTo (FormatType other)
 Compares the object to another object More...
 
abstract bool Equals (FormatType other)
 Determines if the objects are equal More...
 
override bool Equals (object obj)
 Determines if the objects are equal More...
 
override int GetHashCode ()
 Gets the hash code for the object More...
 
abstract FormatType Save (string Location)
 Saves the object More...
 

Static Public Member Functions

static FormatType Load (string Location)
 Loads the object from the location specified More...
 
static bool operator!= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if the two are not equal More...
 
static bool operator< (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is less than More...
 
static bool operator<= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is less than or equal More...
 
static bool operator== (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if the two are equal More...
 
static bool operator> (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is greater than More...
 
static bool operator>= (FormatBase< FormatType, ContentType > Value1, FormatBase< FormatType, ContentType > Value2)
 Determines if it is greater than or equal More...
 

Protected Member Functions

 FormatBase ()
 Constructor More...
 
abstract FormatType InternalLoad (string Location)
 Loads the object from the location specified More...
 

Detailed Description

Format base class

Template Parameters
ContentTypeContent type
FormatTypeFormat type
Type Constraints
FormatType :FormatBase 
FormatType :FormatType 
FormatType :ContentType 
FormatType :new() 

Definition at line 33 of file FormatBase.cs.

Constructor & Destructor Documentation

Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.FormatBase ( )
protected

Constructor

Definition at line 39 of file FormatBase.cs.

Member Function Documentation

abstract object Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.Clone ( )
pure virtual

Clones the object

Returns
A newly cloned object

Implemented in Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.

int Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.CompareTo ( object  obj)

Compares the object to another object

Parameters
objObject to compare to
Returns
0 if they are equal, -1 if this is smaller, 1 if it is larger

Definition at line 134 of file FormatBase.cs.

abstract int Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.CompareTo ( FormatType  other)
pure virtual

Compares the object to another object

Parameters
otherObject to compare to
Returns
0 if they are equal, -1 if this is smaller, 1 if it is larger

Implemented in Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.

abstract bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.Equals ( FormatType  other)
pure virtual

Determines if the objects are equal

Parameters
otherOther object to compare to
Returns
True if they are equal, false otherwise

Implemented in Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.

override bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.Equals ( object  obj)

Determines if the objects are equal

Parameters
objOther object to compare to
Returns
True if they are equal, false otherwise

Definition at line 158 of file FormatBase.cs.

override int Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.GetHashCode ( )

Gets the hash code for the object

Returns
The hash code for the object

Definition at line 170 of file FormatBase.cs.

abstract FormatType Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.InternalLoad ( string  Location)
protectedpure virtual

Loads the object from the location specified

Parameters
LocationLocation of the file to load
Returns
This

Implemented in Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.

static FormatType Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.Load ( string  Location)
static

Loads the object from the location specified

Parameters
LocationLocation of the file to load
Returns
The object specified in the location

Definition at line 48 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator!= ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if the two are not equal

Parameters
Value1Value 1
Value2Value 2
Returns
True if they are not equal, false otherwise

Definition at line 59 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator< ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if it is less than

Parameters
Value1Value 1
Value2Value 2
Returns
True if it is less than, false otherwise

Definition at line 70 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator<= ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if it is less than or equal

Parameters
Value1Value 1
Value2Value 2
Returns
True if it is less than or equal, false otherwise

Definition at line 82 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator== ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if the two are equal

Parameters
Value1Value 1
Value2Value 2
Returns
True if they are equal, false otherwise

Definition at line 94 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator> ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if it is greater than

Parameters
Value1Value 1
Value2Value 2
Returns
True if it is greater than, false otherwise

Definition at line 105 of file FormatBase.cs.

static bool Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.operator>= ( FormatBase< FormatType, ContentType >  Value1,
FormatBase< FormatType, ContentType >  Value2 
)
static

Determines if it is greater than or equal

Parameters
Value1Value 1
Value2Value 2
Returns
True if it is greater than or equal, false otherwise

Definition at line 117 of file FormatBase.cs.

abstract FormatType Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, ContentType >.Save ( string  Location)
pure virtual

Saves the object

Parameters
LocationLocation to save it to
Returns
This

Implements Utilities.IO.FileFormats.Interfaces.IFormat< FormatType, ContentType >.

Implemented in Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >.


The documentation for this class was generated from the following file: