Class FinSegments

A container that holds an ordered sequence of FinSegment instances.

Inheritance

System.Object

FinSegments

Implements

System.Collections.IEnumerable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Subsembly.FinTS

Assembly: Subsembly.FinTS.Core.dll

Syntax

public class FinSegments : IEnumerable

Constructors

FinSegments()

Declaration

public FinSegments()

Properties

Count

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Item[Int32]

Default indexer that provides convenient access to the FinSegment instances of this container.

Declaration

public FinSegment this[int i] { get; }

Parameters

Type	Name	Description
System.Int32	i

Property Value

Type	Description
FinSegment

Methods

Add(FinSegment)

Declaration

public void Add(FinSegment aSegment)

Parameters

Type	Name	Description
FinSegment	aSegment

Clear()

Declaration

public void Clear()

FindSegment(String, Int32)

Finds the segment with the given segment type and an also given maximum acceptable segment version.

Declaration

public FinSegment FindSegment(string sSegmentType, int nMaxSegmentVersion)

Parameters

Type	Name	Description
System.String	sSegmentType	The segment type of the segment that is sought. This must not be null. The segment type is always matched exactly.
System.Int32	nMaxSegmentVersion	Maximum acceptable segment version that is sought. If this is zero, then the very first occurence of sSegmentType is returned, regardless of its version number. If this is System.Int32.MaxValue, then the segment with the given type and the highest version number in the collection is returned. In any other case, the first segment with a matching sSegmentType and the highest version number that is less or equal than nMaxSegmentVersion is returned.

Returns

Type	Description
FinSegment	If an acceptable segment was found, then its reference is returned. If not, then null is returned. The version number of the segment that was actually found can be checked through the Version property of the returned FinSegment.

Exceptions

Type	Condition
System.ArgumentNullException	null was passed for the sSegmentType parameter.
System.ArgumentOutOfRangeException	A negative nMaxSegmentVersion value was passed.

GetEnumerator()

Provides enumerator over the FinSegment instances that are stored in this container.

Declaration

public IEnumerator GetEnumerator()

Returns

Type	Description
System.Collections.IEnumerator	IEnumrator implementation that enumerates the data elements in this container.

GetSegment(Int32)

Declaration

public FinSegment GetSegment(int i)

Parameters

Type	Name	Description
System.Int32	i

Returns

Type	Description
FinSegment

Read(Stream, Boolean)

Declaration

public static FinSegments Read(Stream aStream, bool fSkipWhitespace)

Parameters

Type	Name	Description
System.IO.Stream	aStream
System.Boolean	fSkipWhitespace

Returns

Type	Description
FinSegments

Remove(FinSegment)

Declaration

public void Remove(FinSegment aSegment)

Parameters

Type	Name	Description
FinSegment	aSegment

Write(Stream, Boolean)

Declaration

public void Write(Stream aStream, bool fAddWhitespace)

Parameters

Type	Name	Description
System.IO.Stream	aStream
System.Boolean	fAddWhitespace

Implements

System.Collections.IEnumerable