Search Results for

    Show / Hide Table of Contents

    Class TranslationMemoryIterator

    Base iterator class. Contains the common properties needed for iteration through a translation memory.

    Inheritance
    object
    TranslationMemoryIterator
    DuplicateIterator
    RegularIterator
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Sdl.LanguagePlatform.TranslationMemory
    Assembly: Sdl.LanguagePlatform.TranslationMemory.dll
    Syntax
    [DataContract]
    [KnownType(typeof(RegularIterator))]
    [KnownType(typeof(DuplicateIterator))]
    public abstract class TranslationMemoryIterator

    Constructors

    TranslationMemoryIterator()

    Initializes a new instance with default values (the max count is set to 100).

    Declaration
    protected TranslationMemoryIterator()

    TranslationMemoryIterator(int)

    Initializes a new instance with the specified values.

    Declaration
    protected TranslationMemoryIterator(int maxCount)
    Parameters
    Type Name Description
    int maxCount

    The maximum number of TUs to return in one iteration roundtrip

    Properties

    Filter

    Gets or sets the filter used by this iterator.

    Only translation units satisfying this filter will be returned.

    Declaration
    [DataMember]
    public FilterExpression Filter { get; set; }
    Property Value
    Type Description
    FilterExpression

    Forward

    Gets or sets whether this iterator is moving forward or backward to retrieve the next page of translation units.

    Declaration
    [DataMember]
    public bool Forward { get; set; }
    Property Value
    Type Description
    bool

    MaxCount

    Gets or sets the maximum number of translation units that this iterator will return to the caller in one step.

    Declaration
    [DataMember]
    public int MaxCount { get; set; }
    Property Value
    Type Description
    int

    MaxScan

    Gets or sets the maximum number of translation units that this iterator will retrieve from the TM in one step. If 0, the number will be unlimited. Note that while MaxCount limits the number of TUs returned to the caller, MaxScan limits the number of TUs retrieved from the storage. This facilitates cancellation and progress reporting in cases where the iterator's filter conditions require many (or all) TUs retrieved from the storage to fill the result set.

    Since TUs are retrieved from storage in batches of size MaxCount, the number of scanned TUs in one iteration may actually be larger than the MaxScan value.

    Declaration
    [DataMember]
    public int MaxScan { get; set; }
    Property Value
    Type Description
    int

    ProcessedTranslationUnits

    Gets or sets the number of translation units processed by this iterator since its creation.

    Declaration
    [DataMember]
    public int ProcessedTranslationUnits { get; set; }
    Property Value
    Type Description
    int

    ScannedTranslationUnits

    Gets or sets the number of translation units processed by this iterator in the last roundtrip.

    Declaration
    [DataMember]
    public int ScannedTranslationUnits { get; set; }
    Property Value
    Type Description
    int

    Methods

    Reset()

    Repositions the iterator at the beginning of the translation memory.

    Declaration
    public abstract void Reset()
    In this article
    • Constructors
      • TranslationMemoryIterator()
      • TranslationMemoryIterator(int)
    • Properties
      • Filter
      • Forward
      • MaxCount
      • MaxScan
      • ProcessedTranslationUnits
      • ScannedTranslationUnits
    • Methods
      • Reset()
    Back to top Generated by DocFX