Class: TFileRange

Declaration: FileSystemInterface.h

Taxonomy Categories:

Member Functions:

SetLength
SetOffset
GetLength
GetOffset
operator<<=
operator>>=
operator==
operator=
~TFileRange
TFileRange

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

Specifies some part of a file. Consists of an offset and a length.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFileRange::SetLength

void SetLength (FileSystemEntitySize length)

Interface Category:

API.

Purpose:

Sets the length of the file range.

Calling Context:

Call this function directly.

Parameters:

FileSystemEntitySize length -The length of this range.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::SetOffset

void SetOffset (FileSystemEntitySize offset)

Interface Category:

API.

Purpose:

Sets the offset of the file range.

Calling Context:

Call this function directly.

Parameters:

FileSystemEntitySize offset -The offset of this range.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::GetLength

FileSystemEntitySize GetLength () const

Interface Category:

API.

Purpose:

Returns the length of the file range.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The length of the file range.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::GetOffset

FileSystemEntitySize GetOffset () const

Interface Category:

API.

Purpose:

Returns the offset of the file range.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The offset of the file range.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::operator<<=

TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::operator>>=

TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Call this function directly.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::operator==

bool operator ==(const TFileRange & compareMe)

Interface Category:

API.

Purpose:

Tests equality of TFileRange objects.

Calling Context:

Call this function directly.

Parameters:

const TFileRange & compareMe -The object to compare.

Return Value:

Returns true if this and compareMe are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::operator=

TFileRange & operator =(const TFileRange & copy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFileRange & copy -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::~TFileRange

~ TFileRange ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Member Function: TFileRange::TFileRange

TFileRange (const TFileRange & copyMe)
TFileRange (FileSystemEntitySize offset, FileSystemEntitySize length)
TFileRange ()

Interface Category:

API.

Purpose:

Copy constructor.
Constructs a TFileRange from an offset and a length.
Default constructor.

Calling Context:

Called to copy an object.
Call this function directly.
Called by the stream-in operators, and for later assignment.

Parameters:

const TFileRange & copyMe -The object to copy.
FileSystemEntitySize offset -The offset from the beginning of the file to the beginning of the range, in bytes.
FileSystemEntitySize length -The length of the range, in bytes.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe. This handle class is not safe. The master it refers to is.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.