Format base class for objects that are string based and list of records More...

Inheritance diagram for Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >:

Public Member Functions
void	Add (RecordType item)
	Adds a Record to the file More...

void	Clear ()
	Clears the file More...

bool	Contains (RecordType item)
	Determines if the file contains a Record More...

void	CopyTo (RecordType[] array, int arrayIndex)
	Copies the delimited file to an array More...

IEnumerator< RecordType >	GetEnumerator ()
	Gets the enumerator for the delimited file More...

int	IndexOf (RecordType item)
	Index of a specific Record More...

void	Insert (int index, RecordType item)
	Inserts a Record at a specific index More...

bool	Remove (RecordType item)
	Removes a Record from the file More...

void	RemoveAt (int index)
	Removes a Record at a specific index More...

Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >
override object	Clone ()
	Clones the object More...

override int	CompareTo (FormatType other)
	Compares the object to another object More...

override bool	Equals (FormatType other)
	Determines if the objects are equal More...

override FormatType	Save (string Location)
	Saves the object More...

Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
int	CompareTo (object obj)
	Compares the object to another object More...

override bool	Equals (object obj)
	Determines if the objects are equal More...

override int	GetHashCode ()
	Gets the hash code for the object More...

Protected Member Functions
	StringListFormatBase ()
	Constructor More...

Protected Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >
	StringFormatBase ()
	Constructor More...

override FormatType	InternalLoad (string Location)
	Loads the object from the location specified More...

abstract void	LoadFromData (string Data)
	Loads the object from the data specified More...

Protected Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
	FormatBase ()
	Constructor More...

Properties
int	Count `[get]`
	Count of records More...

bool	IsReadOnly `[get]`
	Is read only? More...

IList< RecordType >	Records `[get]`
	The list of records More...

RecordType	this[int Position] `[get, set]`
	Individual records More...

Additional Inherited Members
Static Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.StringFormatBase< FormatType >
static implicit	operator string (StringFormatBase< FormatType > Value)
	Converts the format to a string More...

static implicit	operator StringFormatBase< FormatType > (string Value)
	Converts the string to the format specified More...

Static Public Member Functions inherited from Utilities.IO.FileFormats.BaseClasses.FormatBase< FormatType, string >
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...

Detailed Description

Format base class for objects that are string based and list of records

Type Constraints

FormatType	:	StringListFormatBase
FormatType	:	FormatType
FormatType	:	RecordType
FormatType	:	new()

Definition at line 29 of file StringListFormatBase.cs.

Constructor & Destructor Documentation

Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.StringListFormatBase ( )

protected

Constructor

Definition at line 35 of file StringListFormatBase.cs.

Member Function Documentation

void Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Add ( RecordType item )

Adds a Record to the file

Parameters

item	Record to add

Definition at line 76 of file StringListFormatBase.cs.

void Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Clear ( )

Clears the file

Definition at line 84 of file StringListFormatBase.cs.

bool Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Contains ( RecordType item )

Determines if the file contains a Record

Parameters

item	Record to check for

Returns: True if it does, false otherwise

Definition at line 94 of file StringListFormatBase.cs.

void Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.CopyTo	(	RecordType[]	array,
		int	arrayIndex
	)

Copies the delimited file to an array

Parameters

array	Array to copy to
arrayIndex	Index to start at

Definition at line 104 of file StringListFormatBase.cs.

IEnumerator<RecordType> Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.GetEnumerator ( )

Gets the enumerator for the delimited file

Returns: The enumerator for this file

Definition at line 113 of file StringListFormatBase.cs.

int Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.IndexOf ( RecordType item )

Index of a specific Record

Parameters

item	Record to search for

Returns: The index of a specific Record

Definition at line 123 of file StringListFormatBase.cs.

void Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Insert	(	int	index,
		RecordType	item
	)

Inserts a Record at a specific index

Parameters

index	Index to insert at
item	Record to insert

Definition at line 133 of file StringListFormatBase.cs.

bool Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Remove ( RecordType item )

Removes a Record from the file

Parameters

item	Record to remove

Returns: True if it is removed, false otherwise

Definition at line 143 of file StringListFormatBase.cs.

void Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.RemoveAt ( int index )

Removes a Record at a specific index

Parameters

index Index of the Record to remove

Definition at line 152 of file StringListFormatBase.cs.

Property Documentation

int Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Count

get

Count of records

Definition at line 44 of file StringListFormatBase.cs.

bool Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.IsReadOnly

get

Is read only?

Definition at line 52 of file StringListFormatBase.cs.

IList<RecordType> Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.Records

getprotected

The list of records

Definition at line 59 of file StringListFormatBase.cs.

RecordType Utilities.IO.FileFormats.BaseClasses.StringListFormatBase< FormatType, RecordType >.this[int Position]

getset

Individual records

Parameters

Position The record that you want to get

Returns: The record requested

Definition at line 67 of file StringListFormatBase.cs.

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

Utilities/IO/FileFormats/BaseClasses/StringListFormatBase.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation