Craig's Utility Library  4.0 Beta
Utilities.IO.FileFormats.FixedLength.BaseClasses.RecordBase< T > Class Template Referenceabstract

Record base class More...

Inheritance diagram for Utilities.IO.FileFormats.FixedLength.BaseClasses.RecordBase< T >:
Utilities.IO.FileFormats.FixedLength.Interfaces.IRecord< T >

Public Member Functions

void Add (IField< T > item)
 Adds a Field to the file More...
 
void Clear ()
 Clears the file More...
 
bool Contains (IField< T > item)
 Determines if the file contains a Field More...
 
void CopyTo (IField< T >[] array, int arrayIndex)
 Copies the delimited file to an array More...
 
IEnumerator< IField< T > > GetEnumerator ()
 Gets the enumerator for the file More...
 
int IndexOf (IField< T > item)
 Index of a specific Field More...
 
void Insert (int index, IField< T > item)
 Inserts a Field at a specific index More...
 
abstract void Parse (string Value, int Length=-1)
 Parses the record More...
 
bool Remove (IField< T > item)
 Removes a Field from the file More...
 
void RemoveAt (int index)
 Removes a Field at a specific index More...
 
override string ToString ()
 Converts the record to a string More...
 

Protected Member Functions

 RecordBase ()
 Constructor More...
 

Properties

int Count [get]
 Number of Fields More...
 
bool IsReadOnly [get]
 Is the file read only More...
 
int Length [get, set]
 Length More...
 
IList< IField< T > > Fields [get]
 The list of fields More...
 
IField< T > this[int Position] [get, set]
 Individual records More...
 
- Properties inherited from Utilities.IO.FileFormats.FixedLength.Interfaces.IRecord< T >
int Length [get, set]
 Length of the record More...
 

Detailed Description

Record base class

Template Parameters
TField type

Definition at line 32 of file RecordBase.cs.

Constructor & Destructor Documentation

Constructor

Definition at line 37 of file RecordBase.cs.

Member Function Documentation

Adds a Field to the file

Parameters
itemField to add

Definition at line 83 of file RecordBase.cs.

Clears the file

Definition at line 91 of file RecordBase.cs.

Determines if the file contains a Field

Parameters
itemField to check for
Returns
True if it does, false otherwise

Definition at line 101 of file RecordBase.cs.

void Utilities.IO.FileFormats.FixedLength.BaseClasses.RecordBase< T >.CopyTo ( IField< T >[]  array,
int  arrayIndex 
)

Copies the delimited file to an array

Parameters
arrayArray to copy to
arrayIndexIndex to start at

Definition at line 111 of file RecordBase.cs.

Gets the enumerator for the file

Returns
The enumerator for this file

Definition at line 120 of file RecordBase.cs.

Index of a specific Field

Parameters
itemField to search for
Returns
The index of a specific Field

Definition at line 130 of file RecordBase.cs.

void Utilities.IO.FileFormats.FixedLength.BaseClasses.RecordBase< T >.Insert ( int  index,
IField< T >  item 
)

Inserts a Field at a specific index

Parameters
indexIndex to insert at
itemField to insert

Definition at line 140 of file RecordBase.cs.

abstract void Utilities.IO.FileFormats.FixedLength.BaseClasses.RecordBase< T >.Parse ( string  Value,
int  Length = -1 
)
pure virtual

Parses the record

Parameters
ValueValue
LengthLength of the record

Implements Utilities.IO.FileFormats.FixedLength.Interfaces.IRecord< T >.

Removes a Field from the file

Parameters
itemField to remove
Returns
True if it is removed, false otherwise

Definition at line 157 of file RecordBase.cs.

Removes a Field at a specific index

Parameters
indexIndex of the Field to remove

Definition at line 166 of file RecordBase.cs.

Converts the record to a string

Returns
The record as a string

Definition at line 184 of file RecordBase.cs.

Property Documentation

Number of Fields

Definition at line 46 of file RecordBase.cs.

The list of fields

Definition at line 66 of file RecordBase.cs.

Is the file read only

Definition at line 54 of file RecordBase.cs.

Length

Definition at line 61 of file RecordBase.cs.

Individual records

Parameters
PositionThe record that you want to get
Returns
The record requested

Definition at line 74 of file RecordBase.cs.


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