Interface IGorgonReadOnlyChunkCollection

A collection of available chunks within a Gorgon Chunk File(GCFF).

Inherited Members
Namespace: Gorgon.IO
Assembly: Gorgon.Core.dll
Syntax
public interface IGorgonReadOnlyChunkCollection : IReadOnlyList<GorgonChunk>, IReadOnlyCollection<GorgonChunk>, IEnumerable<GorgonChunk>, IEnumerable

Properties

| Edit this page View Source

this[string]

Property to return a chunk by a string identifier.

Declaration
GorgonChunk this[string chunkName] { get; }
Parameters
Type Name Description
string chunkName
Property Value
Type Description
GorgonChunk
Remarks

If the chunk is not found, then this property will return null.

| Edit this page View Source

this[ulong]

Property to return a chunk by its ulong ID.

Declaration
GorgonChunk this[ulong id] { get; }
Parameters
Type Name Description
ulong id
Property Value
Type Description
GorgonChunk
Remarks

If the chunk is not found, then this property will return null.

Methods

| Edit this page View Source

Contains(GorgonChunk)

Function to return whether a chunk exists in this collection or not.

Declaration
bool Contains(GorgonChunk chunk)
Parameters
Type Name Description
GorgonChunk chunk

The chunk to find in the collection.
Returns
Type Description
bool

true if the chunk exists, false if not.
| Edit this page View Source

Contains(string)

Function to return whether a chunk exists in this collection or not.

Declaration
bool Contains(string chunkName)
Parameters
Type Name Description
string chunkName

A text representation of the ulong chunk ID.
Returns
Type Description
bool

true if a chunk exists with the specified chunkName, false if not.
| Edit this page View Source

Contains(ulong)

Function to return whether a chunk exists in this collection or not.

Declaration
bool Contains(ulong chunkID)
Parameters
Type Name Description
ulong chunkID

The ulong ID of the chunk.
Returns
Type Description
bool

true if a chunk exists with the specified chunkID, false if not.
| Edit this page View Source

IndexOf(GorgonChunk)

Function to return the index of a chunk by its name.

Declaration
int IndexOf(GorgonChunk chunk)
Parameters
Type Name Description
GorgonChunk chunk

The the chunk to find in the collection.
Returns
Type Description
int

The index of the chunk, or -1 if not found.
| Edit this page View Source

IndexOf(string)

Function to return the index of a chunk by its name.

Declaration
int IndexOf(string chunkName)
Parameters
Type Name Description
string chunkName

A text representation of the ulong chunk ID.
Returns
Type Description
int

The index of the chunk with the specific chunkName, or -1 if not found.
| Edit this page View Source

IndexOf(ulong)

Function to return the index of a chunk by its name.

Declaration
int IndexOf(ulong chunkID)
Parameters
Type Name Description
ulong chunkID

The ulong ID of the chunk.
Returns
Type Description
int

The index of the chunk with the specific chunkID, or -1 if not found.

Extension Methods