noisedestroyers/DP44
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
365ebdecbd94c65939f38bd270147e5dc6af3a75
DP44/DataPRO/Modules/LargeDataViewer/DTS.Utilities.xml
noisedestroyers bc3ac1d4c9 init
2026-04-17 14:55:32 -04:00

4844 lines
218 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<doc>
<assembly>
<name>DTS.Utilities</name>
</assembly>
<members>
<member name="T:DTS.Utilities.ActiveUpdateList`1">
<summary>
An extension of the standard <see cref="T:List"/> class that provides active notification to
registered callbacks whenever items are added to or removed from the list.
</summary>
<typeparam name="T">
The type of object contained in this list.
</typeparam>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.#ctor">
<summary>
Initialize an instance of this class.
</summary>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.#ctor(System.Int32)">
<summary>
Initialize an instance of this class.
</summary>
<param name="capacity">
The number of elements that the list can initially store.
</param>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>
Initialize an instance of this class.
</summary>
<param name="collection">
The collection whose elements are copied to the new list.
</param>
</member>
<member name="T:DTS.Utilities.ActiveUpdateList`1.EventArgs">
<summary>
The argument type passed to "on items added" and "on items removed" callbacks. It contains
a list of the items that have been added/removed.
</summary>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.EventArgs.#ctor">
<summary>
construct an empty collection of items
</summary>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.EventArgs.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>
construct a collection of items
</summary>
<param name="items">arguments to add</param>
</member>
<member name="T:DTS.Utilities.ActiveUpdateList`1.EventHandler">
<summary>
The type of the callbacks issued by this class.
</summary>
<param name="sender">
The <see cref="T:System.Object"/> responsible for generating this event.
</param>
<param name="args">
The <see cref="T:DTS.Utilities.ActiveUpdateList.EventArgs"/> for this event.
</param>
</member>
<member name="E:DTS.Utilities.ActiveUpdateList`1.OnItemsAdded">
<summary>
The event generated whenever items are added to this object's list.
</summary>
</member>
<member name="E:DTS.Utilities.ActiveUpdateList`1.OnItemsRemoved">
<summary>
The event generated whenever items are removed from this list.
</summary>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.Add(`0)">
<summary>
Adds an object to the end of the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<param name="item">
The item to be added to this list.
</param>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
<summary>
Adds the elements of the specified collection to the end of the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<param name="collection">
The collection to the added to this list.
</param>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.Clear">
<summary>
Removes all elements from the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})">
<summary>
Inserts the elements of a collection into the <see cref="T:DTS.Utilities.ActiveUpdateList"/> at the
specified index.
</summary>
<param name="index">
The zero-based index at which the new elements should be inserted.
</param>
<param name="collection">
The collection whose elements should be inserted into the T:DTS.Utilities.ActiveUpdateList.
The collection itself cannot be null, but it can contain elements that are
null, if type T is a reference type.
</param>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.Remove(`0)">
<summary>
Removes the first occurrence of a specific object from the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<param name="item">
The object to remove from the <see cref="T:System.Collections.Generic.List" />. The value
can be null for reference types.
</param>
<returns>
<see cref="T:System.Boolean"/> true if item is successfully removed; otherwise, false. This method also
returns false if item was not found in the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</returns>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.RemoveAll(System.Predicate{`0})">
<summary>
Removes the all the elements that match the conditions defined by the specified
predicate.
</summary>
<param name="match">
The <see cref="T:System.Predicate"/> delegate that defines the conditions of the elements
to remove.
</param>
<returns>
The number of elements removed from the <see cref="T:DTS.Utilities.ActiveUpdateList"/>
</returns>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.RemoveAt(System.Int32)">
<summary>
Removes the element at the specified index of the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<param name="index">
The zero-based index of the element to remove.
</param>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="M:DTS.Utilities.ActiveUpdateList`1.RemoveRange(System.Int32,System.Int32)">
<summary>
Removes a range of elements from the <see cref="T:DTS.Utilities.ActiveUpdateList"/>.
</summary>
<param name="index">
The zero-based starting index of the range of elements to remove.
</param>
<param name="count">
The number of elements to remove.
</param>
<exception cref="T:DTS.Utilities.ActiveUpdateList.Exception">
All exceptions generated by this method will be nested in one of these.
</exception>
</member>
<member name="T:DTS.Utilities.Logging.APILogger">
<summary>
this class encapsulating writing to the log
</summary>
</member>
<member name="T:DTS.Utilities.Logging.APILogger.Sink">
<summary>
a function capable of logging a message
</summary>
<param name="msg">message to log</param>
</member>
<member name="F:DTS.Utilities.Logging.APILogger.Writer">
<summary>
a consumer of log messages
</summary>
</member>
<member name="M:DTS.Utilities.Logging.APILogger.LogException(System.Exception)">
<summary>
log an exception
</summary>
<param name="ex">exception to be logged</param>
</member>
<member name="M:DTS.Utilities.Logging.APILogger.LogString(System.String)">
<summary>
logs a string
</summary>
<param name="str">string to be logged</param>
</member>
<member name="M:DTS.Utilities.Logging.APILogger.Log(System.Object[])">
<summary>
logs multiple parameters
</summary>
<param name="paramlist">
collection of parameters, can be exceptions, strings, or an object with tostring
</param>
</member>
<member name="T:DTS.Utilities.Logging.TextLogger">
<summary>
A class to implement a threaded log file.
Problems encountered by the writing thread will be reported thru the callback function.
The logger is re/started whenever it is assigned a new log filepath.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.CurrentLoggingCycle">
<summary>
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleHandle"/> associated with the current
active log file.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.EndCurrentWriteCycle">
<summary>
Shut down the current write cycle.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.StartNewWriteCycle(System.String)">
<summary>
Open a log file with the specified name and start processing log messages into it. If another
log file is currently active, it will be closed, flushed and disposed.
</summary>
<param name="logPathname">
The <see cref="T:System.String"/> pathname of the logfile to receive new log messages.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.MoveLogTo(System.String)">
<summary>
Change the name/location of the currently active log file without dropping any
incoming messages.
</summary>
<param name="newPathName">
The new path name <see cref="T:System.String"/> for the active log file.
</param>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.LogPathname">
<summary>
Get/set the <see cref="T:System.String"/> pathname of the currently active log file.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.LogFilename">
<summary>
Get the filename portion of the associated log's filename.
</summary>
</member>
<member name="T:DTS.Utilities.Logging.TextLogger.WriteCycleCallback">
<summary>
A callback type for write queue events.
</summary>
<param name="writeQueue">
The write queue's <see cref="T:System.String"/> queue.
</param>
</member>
<member name="T:DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler">
<summary>
A callback type to be invoked when exceptions occur in the text writer's threaded
writing method.
</summary>
<param name="ex"></param>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.OnWriteException">
<summary>
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler"/> that well be invoked
whenever the logger encounters an exceptional condition within the write cycle method.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.LogStartMessage">
<summary>
text written to the start of a log (such as application version, etc)
if null, no text is written
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.QueueWriteCycle(DTS.Utilities.Logging.TextLogger.WriteCycleHandle)">
<summary>
The write loop that processes queued log messages. It is run in its own thread.
</summary>
<param name="writeCycle">
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleHandle"/> associated with the
log file to receive processed log messages.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.#ctor(System.String,DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler)">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.Logging.TextLogger"/> class.
</summary>
<param name="logPathname">
The <see cref="T:System.String"/> pathname of the log file that will be generated by
this class.
</param>
<param name="onWriteException">
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler"/> to be invoked when
an exception occurs in the queue processing loop.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.#ctor(System.String,DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler,System.Int32)">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.Logging.TextLogger"/> class.
</summary>
<param name="logPathname">
The <see cref="T:System.String"/> pathname of the log file that will be generated by
this class.
</param>
<param name="onWriteException">
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler"/> to be invoked when
an exception occurs in the queue processing loop.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.LogMessage(System.String)">
<summary>
Write the specified string to the log file.
</summary>
<param name="message">
The text <see cref="T:System.String"/> to be written to the log file.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.Dispose">
<summary>
Process the remaining items in the queue and then release all resources.
</summary>
</member>
<member name="F:DTS.Utilities.Logging.TextLogger._maximumLogFileSizeBytes">
<summary>
The byte-size at which the log file should be archived.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.CheckForLargeLogFileAndRename(System.String)">
<summary>
Check the size of the specified file and if it exceeds the maximum log file size
then give it an archival name and open a new logfile for subsequent data. A
cut 'n paste transplant from the original TextLogger.
</summary>
<param name="FileName">
The new archival filename <see cref="T:System.String"/> for the log file if it exceeds the
maximum specified byte-size.
</param>
</member>
<member name="T:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException">
<summary>
Representation of a failed attempt to convert a "Large" interface data type to one of
the smaller data types in the "standard" interface.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException.#ctor">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException"/> class.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException.#ctor(System.String)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.Logging.TextLogger.LogPathnameNotInitializedException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.Logging.TextLogger.WriteCycleHandle">
<summary>
"Handle" containing the state information for a log message write session.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.FullLogFileName">
<summary>
The filename of the log file receiving the messages being supplied to this
write session.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.CycleTrigger">
<summary>
The <see cref="T:System.Threading.AutoResetEvent"/> whose "set" kicks off
a write cycle.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.CycleCompletionTrigger">
<summary>
The <see cref="T:System.Threading.AutoResetEvent"/> that is signaled when
a write cycle completes.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.OnWriteCycleException">
<summary>
The <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler"/> to be
invoked when the write cycle encounters an exception.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.TerminateCycleOnException">
<summary>
<see cref="T:System.Boolean"/> flag that controls whether or not the write cycle should
auto-terminate whenever it encounters an exception.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.TerminateWriteCycle">
<summary>
Get/set the <see cref="T:System.Boolean"/> flag that will terminate the associated write cycle when set to 'true'.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.WriteQueue">
<summary>
The actually queue of log message <see cref="T:System.String"/>s to be written to the active log file.
</summary>
</member>
<member name="P:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.OnWriteCycleTermination">
<summary>
Callback to be invoked when the write cycle has closed it's associated log file's
write handle for the last time.
</summary>
</member>
<member name="M:DTS.Utilities.Logging.TextLogger.WriteCycleHandle.#ctor(System.String,System.Collections.Generic.Queue{System.String},DTS.Utilities.Logging.TextLogger.WriteCycleCallback,DTS.Utilities.Logging.TextLogger.WriteCycleExceptionHandler,System.Boolean)">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.Logging.TextLogger.WriteCycleHandle"/> class.
</summary>
<param name="fullLogFileName">
The filename of the log file receiving the messages being supplied to this
write session.
</param>
<param name="writeQueue">
The actually queue of log message <see cref="T:System.String"/>s to be written to the active log file.
</param>
<param name="onWriteCycleTermination">
Callback to be invoked when the write cycle has closed it's associated log file's
write handle for the last time.
</param>
<param name="onWriteCycleException">
Callback to be invoked when the write cycle has closed it's associated log file's
write handle for the last time.
</param>
<param name="terminateCycleOnException">
<see cref="T:System.Boolean"/> flag that controls whether or not the write cycle should
auto-terminate whenever it encounters an exception.
</param>
</member>
<member name="T:DTS.Utilities.ArrayToString">
<summary>
encapsulates converting array or IEnumerables to a string
</summary>
</member>
<member name="P:DTS.Utilities.ArrayToString.Separater">
<summary>
separator between elements
</summary>
<remarks>This will change the separator for all callers</remarks>
</member>
<member name="P:DTS.Utilities.ArrayToString.LeftGroup">
<summary>
symbol for the start of a group
</summary>
<remarks>this will change the symbol for all callers</remarks>
</member>
<member name="P:DTS.Utilities.ArrayToString.RightGroup">
<summary>
symbol for the end of a group
</summary>
<remarks>this will change the symbol for all callers</remarks>
</member>
<member name="M:DTS.Utilities.ArrayToString.ArrayObjectToString(System.Object,System.String,System.String,System.String)">
<summary>
constructs a string out of an array.
IEnumerable classes are returned using .ToString()
if object is null, a string with null in angle brackets is returned
</summary>
<param name="arr">array to serialize to string</param>
<param name="LeftStr">symbol to put at the start of the string</param>
<param name="SepStr">symbol to use between elements</param>
<param name="RightStr">symbol to use at the end of the string</param>
<returns>string representation of array</returns>
</member>
<member name="M:DTS.Utilities.ArrayToString.ArrayObjectToString(System.Object)">
<summary>
returns a string representation of an array
</summary>
<param name="arr">array to serialize to string</param>
<returns>string representation of array</returns>
</member>
<member name="T:DTS.Utilities.AttributeCoder`3">
<summary>
Object for manipulating object-attached attributes and attribute values.
</summary>
<typeparam name="TargetType">
The type of <see cref="T:System.Object"/> the attributes we are concerned with are
are attached to.
</typeparam>
<typeparam name="AttributeType">
The type of attribute to be manipulated.
</typeparam>
<typeparam name="AttributeValueType">
The type of value contained by the attribute to be manipulated.
</typeparam>
<remarks>
This class was created to make it easier to "match" attributes and the data
types they're attached to in a somewhat generic manner. It is intended that
attribute coder classes that deal with specific attribute types be derived
from this one.
</remarks>
</member>
<member name="T:DTS.Utilities.AttributeCoder`3.AttributeValueExtractionMethod">
<summary>
Method that specifies how to access the value of a given "AttributeType".
</summary>
<param name="attribute">
The "AttributeType" attribute to have its value extracted.
</param>
<returns>
The "AttributeValueType" value of the specified attribute.
</returns>
</member>
<member name="T:DTS.Utilities.AttributeCoder`3.AttributeValueEqualityComparisonMethod">
<summary>
Method for determining the equality of two "AttributeValueType" values.
</summary>
<param name="value1">
A "AttributeValueType" to be equality-compared.
</param>
<param name="value2">
A "AttributeValueType" to be equality-compared.
</param>
<returns>
True if the two values are equal; false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.AttributeCoder`3.#ctor(DTS.Utilities.AttributeCoder{`0,`1,`2}.AttributeValueExtractionMethod,DTS.Utilities.AttributeCoder{`0,`1,`2}.AttributeValueEqualityComparisonMethod)">
<summary>
Initializes an instance of the AttributeCoder class.
</summary>
<param name="attributeValueExtractionMethod">
A <see cref="T:DTS.Utilities.AttributeCoder`3.AttributeValueExtractionMethod"/> that defines how "AttributeValueType"
values are to be extracted from "AttributeType" attributes.
</param>
<param name="attributeValueEqualityComparisonMethod">
Optional parameter for specifying a custom comparison method to override default
"AttributeValueType" equality determination. Pass null to use default
comparison.
</param>
</member>
<member name="M:DTS.Utilities.AttributeCoder`3.DecodeAttributeValue(`0)">
<summary>
Return the "AttributeValueType" of the "AttributeType" attribute
attached to the specified "TargetType".
</summary>
<param name="target">
The "TargetType" object whose "AttributeType" attribute is to be
evaluated.
</param>
<returns>
The "AttributeValueType" of the "AttributeType" attribute attached
to the specified "TargetType".
</returns>
</member>
<member name="M:DTS.Utilities.AttributeCoder`3.DecodeAttributeValues(`0)">
<summary>
Return the <see cref="T:List"/> of "AttributeValueType"s of the
"AttributeType" attached to the specified "TargetType".
</summary>
<param name="target">
The "TargetType" object whose "AttributeType" attribute is to be
evaluated.
</param>
<returns>
The "AttributeValueType" of the "AttributeType" attribute attached
to the specified "TargetType".
</returns>
</member>
<member name="M:DTS.Utilities.AttributeCoder`3.EncodeAttributeValue(`2)">
<summary>
Return the "TargetType" value that has the "AttributeType"
attribute with the specified "AttributeValueType" value attached
to it.
</summary>
<param name="attributeValue">
The value of the "AttributeType" attribute attached to the
"TargetType" target object we're looking for.
</param>
<returns>
The "TargetType" target object that has the "AttributeType"
attribute attached to it that has a "AttributeValueType" value of
attributeValue.
</returns>
</member>
<member name="M:DTS.Utilities.AttributeCoder`3.DehashAttributeValue(`2)">
<summary>
Return a list of "TargetType" values that have the
"AttributeType" attribute with the specified
"AttributeValueType" value attached to them.
</summary>
<param name="attributeValue">
The value of the "AttributeType" attribute attached to the
"TargetType" target object we're looking for.
</param>
<returns>
The <see cref="T:List"/> of "TargetType" target objects that has
the "AttributeType" attribute attached to it that has a
"AttributeValueType" value of attributeValue.
</returns>
</member>
<member name="T:DTS.Utilities.AttributeExtractor`1">
<summary>
Class to ease extracting custom attributes from their attached objects.
</summary>
<typeparam name="AttributeType"></typeparam>
</member>
<member name="M:DTS.Utilities.AttributeExtractor`1.ExtractAttachedAttributeFromObject(System.Object)">
<summary>
Extract an attribute of this class' declared type from the specified target.
</summary>
<param name="target">
The <see cref="T:System.Object"/> to which the sought attribute is attached.
</param>
<returns>
The attribute type specified upon AttributeExtractor creation.
</returns>
</member>
<member name="M:DTS.Utilities.AttributeExtractor`1.ExtractAttachedAttributesFromProperty(System.Object,System.String)">
<summary>
Extract a list of attached attributes from the specified property. An object and property name
must be supplied, for attempts to directly reference the property will result in get/set invocation.
</summary>
<param name="propertyContainer">
The <see cref="T:System.Object"/> that contains the property under query.
</param>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be queried.
</param>
<returns>
A <see cref="T:List"/> of attached attributes of the type specified during the creation
of this instance of AttributeExtractor.
</returns>
</member>
<member name="M:DTS.Utilities.AttributeExtractor`1.ExtractAttachedAttributeFromProperty(System.Object,System.String)">
<summary>
Extract an attached attributes from the specified property of the type declared during the
creation of this instance of AttributeExtractor. An object and property name must be supplied,
for attempts to directly reference the property will result in get/set invocation.
</summary>
<param name="propertyContainer">
The <see cref="T:System.Object"/> that contains the property under query.
</param>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be queried.
</param>
<returns>
An attribute of the type specified during the creation of this instance of AttributeExtractor,
if one is attached; null otherwise.
</returns>
</member>
<member name="T:DTS.Utilities.AverageShortValueOverTime">
<summary>
A class to represent the average value of a set of shorts over time.
</summary>
</member>
<member name="M:DTS.Utilities.AverageShortValueOverTime.#ctor(System.Double,System.Double,System.String)">
<summary>
Initialize an instance of the AverageShortValueOverTime class, assuming that no
averaging has been done yet.
</summary>
<param name="InitialTime">
The <see cref="T:System.Double"/> begin time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="sampleRate">
The <see cref="T:System.Double"/> sample rate of the items being averaged (using the time units
specifed by the "TimeUnitSymbol" property.
</param>
<param name="timeUnitSymbol">
The <see cref="T:System.String"/> time unit description for begin/end times and the sample rate.
</param>
</member>
<member name="M:DTS.Utilities.AverageShortValueOverTime.#ctor(System.Double,System.Double,System.Double,System.Int16,System.String)">
<summary>
Initialize an instance of the AverageShortValueOverTime class.
</summary>
<param name="beginTime">
The <see cref="T:System.Double"/> begin time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="endTime">
The <see cref="T:System.Double"/> end time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="sampleRate">
The <see cref="T:System.Double"/> sample rate of the items being averaged (using the time units
specifed by the "TimeUnitSymbol" property.
</param>
<param name="initialAverage">
The <see cref="T:System.Int16"/> pre-existing average to be appended to.
</param>
<param name="timeUnitSymbol">
The <see cref="T:System.String"/> time unit description for begin/end times and the sample rate.
</param>
</member>
<member name="M:DTS.Utilities.AverageShortValueOverTime.AppendValues(System.Collections.Generic.List{System.Int16})">
<summary>
Append the specified <see cref="T:List"/> of values to the running average.
</summary>
<param name="values">
The <see cref="T:List"/> of <see cref="T:System.Int16"/>s to be appended to the running average.
</param>
</member>
<member name="M:DTS.Utilities.AverageShortValueOverTime.AppendValues(System.Int16[])">
<summary>
Append the specified array of values to the running average.
</summary>
<param name="values">
The array of <see cref="T:System.Int16"/>s to be appended to the running average.
</param>
</member>
<member name="T:DTS.Utilities.AverageValueOverTime`1">
<summary>
A class to represent the average value of a dynamically specified set over time. This
class is intended to be used to keep a running average of sets of piecemeal-collected
data, and it is assumed that a subclass will implement the type-specific features of
this task.
</summary>
<typeparam name="T">
The type we're talking the average value over time of.
</typeparam>
</member>
<member name="M:DTS.Utilities.AverageValueOverTime`1.#ctor(System.Double,System.Double,`0,System.String)">
<summary>
Initialize an instance of the AverageValueOverTime class, assuming that no
averaging has been done yet.
</summary>
<param name="initialTime">
The <see cref="T:System.Double"/> begin time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="sampleRate">
The <see cref="T:System.Double"/> sample rate of the items being averaged (using the time units
specifed by the "TimeUnitSymbol" property.
</param>
<param name="initialAverage">
The "zero" value of our generic data type.
</param>
<param name="timeUnitSymbol">
The <see cref="T:System.String"/> time unit description for begin/end times and the sample rate.
</param>
</member>
<member name="M:DTS.Utilities.AverageValueOverTime`1.#ctor(System.Double,System.Double,System.Double,`0,System.String)">
<summary>
Initialize an instance of the AverageValueOverTime class.
</summary>
<param name="beginTime">
The <see cref="T:System.Double"/> begin time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="endTime">
The <see cref="T:System.Double"/> end time of the average (using the time units specified
by the "TimeUnitSymbol" property.
</param>
<param name="sampleRate">
The <see cref="T:System.Double"/> sample rate of the items being averaged (using the time units
specifed by the "TimeUnitSymbol" property.
</param>
<param name="initialAverage">
The initial average value to be appended to.
</param>
<param name="timeUnitSymbol">
The <see cref="T:System.String"/> time unit description for begin/end times and the sample rate.
</param>
</member>
<member name="P:DTS.Utilities.AverageValueOverTime`1.BeginTime">
<summary>
Beginning Time
</summary>
</member>
<member name="P:DTS.Utilities.AverageValueOverTime`1.EndTime">
<summary>
Ending Time
</summary>
</member>
<member name="P:DTS.Utilities.AverageValueOverTime`1.SampleRate">
<summary>
The sampling rate
</summary>
</member>
<member name="P:DTS.Utilities.AverageValueOverTime`1.TimeUnitSymbol">
<summary>
the time unit symbol
</summary>
</member>
<member name="P:DTS.Utilities.AverageValueOverTime`1.CurrentAverage">
<summary>
the current average
</summary>
</member>
<member name="M:DTS.Utilities.AverageValueOverTime`1.AppendValues(System.Collections.Generic.List{`0})">
<summary>
appends a list of values
</summary>
<param name="values">list of values</param>
<remarks>inheriting clases should know more about the nature of the data type
and averaging them over time.
</remarks>
</member>
<member name="M:DTS.Utilities.AverageValueOverTime`1.AppendValues(`0[])">
<summary>
appends an array of values
</summary>
<param name="values">array of values</param>
<remarks>inheriting clases should know more about the nature of the data type
and averaging them over time.
</remarks>
</member>
<member name="T:DTS.Utilities.ChannelFilter">
<summary>
Enumeration of all possible filters that may be applied to channel
data. These can be used as software filters in data review.
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Unfiltered">
<summary>
no filter is applied
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Class10">
<summary>
filter at 17Hz (Channel Frequency Class)
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Class60">
<summary>
filter at 100Hz (Channel Frequency Class)
3 dB limit Frequncy
stop damping -30 dB
sample frequency > 600Hz
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Class180">
<summary>
filter at 300Hz (Channel Frequency Class)
3 dB limit frequency
stop damping -30Db
sampling frequency > 1800Hz
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Class600">
<summary>
3Db limit frequency 1000Hz (channel frequency class)
stop damping -40Db
sampling frequency > 6 khz
</summary>
</member>
<member name="F:DTS.Utilities.ChannelFilter.Class1000">
<summary>
3dB limit frequency 1650Hz
stop damping -40dB
sampling frequency > 10khz
</summary>
</member>
<member name="T:DTS.Utilities.IsoDescriptionAttribute">
<summary>
Attribute for specifying the ISO code fragment description of the attached
field's representation. Intended to be applied to enumerations that
represent ISO-codeable elements.
</summary>
</member>
<member name="P:DTS.Utilities.IsoDescriptionAttribute.IsoDescription">
<summary>
Get the <see cref="T:System.String"/> that ISO-describes whatever this attribute
is attached to.
</summary>
</member>
<member name="M:DTS.Utilities.IsoDescriptionAttribute.#ctor(System.String)">
<summary>
Initializes an instance of the IsoDescriptionAttribute class.
</summary>
<param name="isoDescription">
The <see cref="T:System.String"/> that ISO-describes whatever this attribute
is attached to.
</param>
</member>
<member name="T:DTS.Utilities.IsoDescriptionAttributeCoder">
<summary>
Tool for manipulating <see cref="T:DTS.Utilities.ChannelFilter"/>-attached <see cref="T:DTS.Utilities.IsoDescriptionAttribute"/>s.
</summary>
</member>
<member name="M:DTS.Utilities.IsoDescriptionAttributeCoder.#ctor">
<summary>
Initializes an instance of the IsoDescriptionAttributeCoder class.
</summary>
</member>
<member name="T:DTS.Utilities.EnumerabilityAttribute">
<summary>
Attribute for specifying the "enumerability" of the attached
field's representation. Intended to be applied to enumerations that
contain valid, but special case elements that should never be automatically
enumerated.
</summary>
</member>
<member name="P:DTS.Utilities.EnumerabilityAttribute.IsEnumerable">
<summary>
Get the <see cref="T:System.Boolean"/> that describes enumerability.
</summary>
</member>
<member name="M:DTS.Utilities.EnumerabilityAttribute.#ctor(System.Boolean)">
<summary>
Initializes an instance of the EnumerablilityAttribute class.
</summary>
<param name="isEnumerable">
The <see cref="T:System.Boolean"/> that describes the attached object's enumerability.
</param>
</member>
<member name="T:DTS.Utilities.EnumerabilityAttributeCoder">
<summary>
Tool for manipulating <see cref="T:DTS.Utilities.ChannelFilter"/>-attached <see cref="T:DTS.Utilities.EnumerabilityAttribute"/>s.
</summary>
</member>
<member name="M:DTS.Utilities.EnumerabilityAttributeCoder.#ctor">
<summary>
Initializes an instance of the EnumerabilityAttributeCoder class.
</summary>
</member>
<member name="T:DTS.Utilities.CfcValueAttribute">
<summary>
Attribute for specifying the numeric value of the filter CFC.
</summary>
</member>
<member name="P:DTS.Utilities.CfcValueAttribute.CfcValue">
<summary>
Get the <see cref="T:System.Double"/> value of the CFC this attribute is attached to.
</summary>
</member>
<member name="M:DTS.Utilities.CfcValueAttribute.#ctor(System.Double)">
<summary>
Initializes an instance of the CfcValueAttribute class.
</summary>
<param name="cfcValue">
The <see cref="T:System.Double"/> value of the CFC this attribute is attached to.
</param>
</member>
<member name="T:DTS.Utilities.CfcValueAttributeCoder">
<summary>
Tool for manipulating <see cref="T:DTS.Utilities.ChannelFilter"/>-attached <see cref="T:DTS.Utilities.CfcValueAttribute"/>s.
</summary>
</member>
<member name="M:DTS.Utilities.CfcValueAttributeCoder.#ctor">
<summary>
Initializes an instance of the CfcValueAttributeCoder class.
</summary>
</member>
<member name="T:DTS.Utilities.CheckComboBoxItem">
<summary>
This class wraps the list items in the combo box
</summary>
</member>
<member name="M:DTS.Utilities.CheckComboBoxItem.#ctor(System.String,System.Boolean)">
<summary>
C'tor - creates a CheckComboBoxItem
</summary>
<param name="text">Label of the check box in the drop down list</param>
<param name="initialCheckState">Initial value for the check box (true=checked)</param>
</member>
<member name="P:DTS.Utilities.CheckComboBoxItem.CheckState">
<summary>
Get or set the check value (true=checked)
</summary>
</member>
<member name="P:DTS.Utilities.CheckComboBoxItem.Text">
<summary>
Gets the label of the check box
</summary>
</member>
<member name="P:DTS.Utilities.CheckComboBoxItem.Tag">
<summary>
User defined data
</summary>
</member>
<member name="M:DTS.Utilities.CheckComboBoxItem.ToString">
<summary>
This is used to keep the edit control portion of the combo box consistent
</summary>
<returns></returns>
</member>
<member name="T:DTS.Utilities.CheckComboBox">
<summary>
Inherits from ComboBox and handles DrawItem and SelectedIndexChanged events to create an
owner drawn combo box drop-down. The contents of the dropdown are rendered using the
CheckBoxRenderer class.
</summary>
</member>
<member name="M:DTS.Utilities.CheckComboBox.#ctor">
<summary>
C'tor
</summary>
</member>
<member name="M:DTS.Utilities.CheckComboBox.CheckComboBox_SelectedIndexChanged(System.Object,System.EventArgs)">
<summary>
Invoked when the selected index is changed on the dropdown. This sets the check state
of the CheckComboBoxItem and fires the public event CheckStateChanged using the
CheckComboBoxItem as the event sender.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:DTS.Utilities.CheckComboBox.CheckComboBox_DrawItem(System.Object,System.Windows.Forms.DrawItemEventArgs)">
<summary>
Invoked when the ComboBox has to render the drop-down items.
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="E:DTS.Utilities.CheckComboBox.CheckStateChanged">
<summary>
Fired when the user clicks a check box item in the drop-down list
</summary>
</member>
<member name="T:DTS.Utilities.AverageQueue">
<summary>
handles averaging over a queue of values (like in realtime mode)
</summary>
<remarks>thread safe</remarks>
</member>
<member name="M:DTS.Utilities.AverageQueue.#ctor(System.Int32)">
<summary>
constructs a queue that will maintain track of the average of the contents
</summary>
<param name="length">the length of the queue, when contents exceed size,
the first item is dequeued
</param>
</member>
<member name="M:DTS.Utilities.AverageQueue.Push(System.Double)">
<summary>
pushes a new value into the queue
</summary>
<param name="newValue">value to be pushed onto queue</param>
<returns>current average</returns>
</member>
<member name="M:DTS.Utilities.AverageQueue.GetAverage">
<summary>
returns current average
</summary>
<returns>current average</returns>
</member>
<member name="M:DTS.Utilities.AverageQueue.Reset">
<summary>
removes all entries in the queue.
</summary>
</member>
<member name="T:DTS.Utilities.Crc32">
<summary>
Performs 32-bit reversed cyclic redundancy checks.
</summary>
</member>
<member name="F:DTS.Utilities.Crc32.s_generator">
<summary>
Generator polynomial (modulo 2) for the reversed CRC32 algorithm.
</summary>
</member>
<member name="M:DTS.Utilities.Crc32.#ctor">
<summary>
Creates a new instance of the Crc32 class.
</summary>
</member>
<member name="M:DTS.Utilities.Crc32.Get``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Calculates the checksum of the byte stream.
</summary>
<param name="byteStream">The byte stream to calculate the checksum for.</param>
<returns>A 32-bit reversed checksum.</returns>
</member>
<member name="F:DTS.Utilities.Crc32.m_checksumTable">
<summary>
Contains a cache of calculated checksum chunks.
</summary>
</member>
<member name="M:DTS.Utilities.DataConditioning.GetAverageOverTimeEuData(System.Double[],System.Double,System.Double,System.Double,System.Double)">
<summary>
Gets Zered EU data given a time window to average
</summary>
<param name="euData"></param>
<param name="sampleRate"></param>
<param name="triggerSample"></param>
<param name="startTime"></param>
<param name="endTime"></param>
<returns></returns>
</member>
<member name="T:DTS.Utilities.DataWindowAverager">
<summary>
Time averaging data over a specific window
there can be pretrigger time and begin time can be used to compute the start
of the averaging window
</summary>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.#ctor(System.Double,System.Double,System.Double,System.Double,System.Int16)">
<summary>
Initialize an instance of this data window averager class.
</summary>
<param name="beginTimeSec">
Get the <see cref="T:System.Double"/> time value (sec) of the start of the averaging window.
</param>
<param name="endTimeSec">
Get the <see cref="T:System.Double"/> time value (sec) of the end of the averaging window.
</param>
<param name="preTriggerTimeSec">
Get the <see cref="T:System.Double"/> pre-trigger time (sec).
</param>
<param name="sampleRateHz">
Get the <see cref="T:System.Double"/> sample rate (Hz).
</param>
<param name="defaultValue">
Get the default <see cref="T:System.Int16"/> ADC value to be returned if the specified window
is invalid.
</param>
</member>
<member name="P:DTS.Utilities.DataWindowAverager.BeginTimeSec">
<summary>
Get the <see cref="T:System.Double"/> time value (sec) of the start of the averaging window.
</summary>
</member>
<member name="P:DTS.Utilities.DataWindowAverager.EndTimeSec">
<summary>
Get the <see cref="T:System.Double"/> time value (sec) of the end of the averaging window.
</summary>
</member>
<member name="P:DTS.Utilities.DataWindowAverager.PreTriggerTimeSec">
<summary>
Get the <see cref="T:System.Double"/> pre-trigger time (sec).
</summary>
</member>
<member name="P:DTS.Utilities.DataWindowAverager.SampleRateHz">
<summary>
Get the <see cref="T:System.Double"/> sample rate (Hz).
</summary>
</member>
<member name="P:DTS.Utilities.DataWindowAverager.DefaultValue">
<summary>
Get the default <see cref="T:System.Int16"/> ADC value to be returned if the specified window
is invalid.
</summary>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.DetermineWindowAverage(System.Int16[])">
<summary>
Compute the <see cref="T:System.Int16"/> average of the window represented by the current state
of this object over the specified window values.
</summary>
<param name="windowValues">
An array of <see cref="T:System.Int16"/> values to be window-averaged.
</param>
<returns>
The average of the specified value falling within this object's window.
</returns>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.DetermineWindowAverage(System.Double[])">
<summary>
Compute the <see cref="T:System.Int16"/> average of the window represented by the current state
of this object over the specified window values.
</summary>
<param name="windowValues">
An array of <see cref="T:System.Double"/> values to be window-averaged.
</param>
<returns>
The average of the specified value falling within this object's window.
</returns>
</member>
<member name="T:DTS.Utilities.DataWindowAverager.WindowDoesNotExistException">
<summary>
Representation of an attempt to average over a window that does not exist within
the specified dataset.
</summary>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.WindowDoesNotExistException.#ctor">
<summary>
Initialize an instance of the WindowDoesNotExistException class.
</summary>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.WindowDoesNotExistException.#ctor(System.String)">
<summary>
Initialize an instance of the WindowDoesNotExistException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message to be associated with this exception.
</param>
</member>
<member name="M:DTS.Utilities.DataWindowAverager.WindowDoesNotExistException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the WindowDoesNotExistException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message to be associated with this exception.
</param>
<param name="innerEx">
The <see cref="T:System.Exception"/> responsible for this exception inception.
</param>
</member>
<member name="T:DTS.Utilities.DescriptionAttributeCoder`1">
<summary>
Class for "matching" <see cref="T:System.ComponentModel.DescriptionAttribute"/>s and the "TargetType" data
type data type they're attached to.
</summary>
<typeparam name="TargetType">
The data type the attribute being encoded to/decoded from is attached to.
</typeparam>
<remarks>
Generally useful with enumeration target types in which each enumeration value
has a specific "DescriptionAttribute" assigned to it. This class essentially
allows one to "encode" the a specific description value into the enumeration
value it's attached to, as well as "decode" an enumeration into the description
that's attached to it. For example, if we create an enumeration type whose
values at some point need to be converted to string values (and back again),
we can simply attach DescriptionAttributes containing the string conversion
to each value in the enumeration definition and use the DescriptionAttributeCoder
to convert directly from one to the other without the need for any kind of
seperate lookup table.
</remarks>
</member>
<member name="M:DTS.Utilities.DescriptionAttributeCoder`1.#ctor">
<summary>
constructs a <see cref="T:DTS.Utilities.DescriptionAttributeCoder" /> object
</summary>
</member>
<member name="T:DTS.Utilities.DiskUtility">
<summary>
A collection of handy disk-related methods.
</summary>
</member>
<member name="M:DTS.Utilities.DiskUtility.GetHumanReadableBytes(System.UInt64)">
<summary>
just a helper function to translates bytes to a more readable string
</summary>
<param name="bytes"></param>
<returns></returns>
</member>
<member name="M:DTS.Utilities.DiskUtility.GetDiskFreeSpaceEx(System.String,System.UInt64@,System.UInt64@,System.UInt64@)">
<summary>
Get useful disk usage statistics.
</summary>
<param name="directoryName">
The <see cref="T:System.String"/> directory name to be queried for usage numbers.
</param>
<param name="freeBytesAvailable">
The <see cref="T:System.UInt64"/> number of free bytes available on the specified volume.
</param>
<param name="totalNumberOfBytes">
The <see cref="T:System.UInt64"/> total number of bytes available on the specified volume.
</param>
<param name="totalNumberOfFreeBytes">
The <see cref="T:System.UInt64"/> total number of free bytes available on the specified volume.
</param>
<returns>
<see cref="T:System.Int32"/> status code, determined by windows.
</returns>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.DoubleLargeArray">
<summary>
A <see cref="T:DTS.Utilities.IO.MemoryMap.LargeArray" /> of doubles
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.#ctor(System.UInt64)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.IO.MemoryMap.DoubleLargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.#ctor(System.UInt64,System.String,System.String)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.IO.MemoryMap.DoubleLargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
<param name="scratchFileDirectory">
The <see cref="T:System.String"/> name of the directory where this LargeArray will store the temporary
serializations of its items. If null, then the default location will be used.
</param>
<param name="scratchFilePrefix">
The <see cref="T:System.String"/> file name prefix under which this LargeArray will store temporary
serializations of its items. Initialized to DefaultFilePrefix's value at object
creation, unless an alternate is specified by the user. If null, then the default prefix
will be used.
</param>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.DatumSize">
<summary>
Get the <see cref="T:System.UInt32"/> size of the datum handled by this class.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.DatumClearValue">
<summary>
Get the "zero" value for this class' datum type.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.GetDatumAtIndex(System.UInt64)">
<summary>
Get the datum value at the specified index.
</summary>
<param name="index">
The <see cref="T:System.UInt64"/> index of the datum to be returned.
</param>
<returns>
The value of the <see cref="T:System.Double"/> datum at the specified index.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.SetDatumAtIndex(System.Double,System.UInt64)">
<summary>
Set the datum value at the specified index.
</summary>
<param name="datum">
The <see cref="T:System.Double"/> datum to be written to the specified index.
</param>
<param name="index">
The <see cref="T:System.UInt64"/> index at which the specified datum value will be written.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.Clone">
<summary>
Creates a new object that is a copy of the current instance.
</summary>
<returns>
A new <see cref="T:System.Object"/> that is a copy of the current instance.
</returns>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.DoubleLargeArray.Item(System.UInt64)">
<summary>
Get/set the value at the specified index.
</summary>
<param name="index">
The <see cref="T:System.UInt64"/> index of the datum to be referenced.
</param>
<returns>
The <see cref="T:System.Double"/> value of the datum at the specified index.
</returns>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.FileMapIOException">
<summary>Exception class thrown by the library</summary>
<remarks>
Represents an exception occured as a result of an
invalid IO operation on any of the File mapping classes
It wraps the error message and the underlying Win32 error
code that caused the error.
</remarks>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.FileMapIOException.Win32ErrorCode">
<summary>
the Win32 Error code describing the error.
http://msdn.microsoft.com/en-us/library/ms681381%28VS.85%29.aspx
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.FileMapIOException.Message">
<summary>
A description of the error.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.FileMapIOException.#ctor(System.Int32)">
<summary>
Construct a <see cref="T:DTS.Utilities.IO.MemoryMap.FileMapIOException"/>
</summary>
<param name="error">win32 error code describing error</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.FileMapIOException.#ctor(System.String)">
<summary>
Construct a <see cref="T:DTS.Utilities.IO.MemoryMap.FileMapIOException" />
</summary>
<param name="message">description of error</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.FileMapIOException.#ctor(System.String,System.Exception)">
<summary>
Construct a <see cref="T:DTS.Utilities.IO.MemoryMap.FileMapIOException" />
</summary>
<param name="message">description of error</param>
<param name="innerException">exception causing the error</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.FileMapViewArray">
<summary>
Allows a view of a memory mapped file
to be accessed via the index[] operator.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.FileMapViewArray.forceFlush">
<summary>
Clears all buffers for the stream and causes
any unbuffered data to be written to the
underlying device.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.FileMapViewArray.Item(System.Int64)">
<summary>
Returns a the byte at the requested index of the MemoryMap.
</summary>
<param name="index"></param>
<returns></returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.FileMapViewArray.#ctor(System.String,DTS.Utilities.IO.MemoryMap.MapAccess,DTS.Utilities.IO.MemoryMap.MapProtection,System.UInt64,System.Int64,System.Int32)">
<summary>
Master Constructor
This constructor allows for specifying privilages
for the stream and mapped file.
</summary>
<param name="fileName">File from which to create mapping</param>
<param name="access">Access level for the map view in memory. Must be consisten with the file mapping access.</param>
<param name="protection">Access level for the file mapping.</param>
<param name="fileMapSize">The size in bytes of the file mapping. Pass 0 to map the entire (existing and length>0) file.</param>
<param name="offset">Off set from start of mapped file to start the view.</param>
<param name="viewSize">The size of the view in memory. This is limited by physical system resources.</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1">
<summary>
A generic memory-mapped array.
</summary>
<typeparam name="T">
The type of object to be contained in this collection.
</typeparam>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.#ctor(System.UInt64)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.#ctor(System.UInt64,System.String,System.String)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
<param name="scratchFileDirectory">
The <see cref="T:System.String"/> name of the directory where this LargeArray will store the temporary
serializations of its items. If null, then the default location will be used.
</param>
<param name="scratchFilePrefix">
The <see cref="T:System.String"/> file name prefix under which this LargeArray will store temporary
serializations of its items. Initialized to DefaultFilePrefix's value at object
creation, unless an alternate is specified by the user. If null, then the default prefix
will be used.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Finalize">
<summary>
Finalizer. Can't find anyplace else to put this file removal and have it
work, since something in the mapping code is tenaciously holding onto it.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.NameLock">
<summary>
A shared <see cref="T:DTS.Utilities.LargeArray.NameGeneratorLock"/> object to be shared by all instances
of <see cref="T:DTS.Utilities.LargeArray"/> to ensure that no two try to use the same scratch filename.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.NextScratchFileNumberDesignation">
<summary>
Get the next unique <see cref="T:System.UInt64"/> scratch file number designation.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.DefaultScratchDirectory">
<summary>
The default <see cref="T:System.String"/> name of the directory where MegArrays will store the temporary
serializations of their items.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchDirectory">
<summary>
The <see cref="T:System.String"/> name of the directory where this LargeArray will store its temporary
serializations of its items. Initialized to DefaultScratchDirectory's value at object
creation, unless an alternate is specified by the user.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.DefaultFilePrefix">
<summary>
The default <see cref="T:System.String"/> prefix name for MegArrays temporary serializations.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.FilePrefix">
<summary>
The <see cref="T:System.String"/> file name prefix under which this LargeArray will store temporary
serializations of its items. Initialized to DefaultFilePrefix's value at object
creation, unless an alternate is specified by the user.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchFilename">
<summary>
Get the <see cref="T:System.String"/> filename that this <see cref="T:DTS.Utilities.LargeArray"/> will be
using for its memory-mapped serialization file.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.FullScratchFilename">
<summary>
Get the fully qualified <see cref="T:System.String"/> filename that this <see cref="T:DTS.Utilities.LargeArray"/>
will be using for its memory-mapped serialization file.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.GenerateNewScratchFilename">
<summary>
Generate a new unique <see cref="T:System.String"/> filename.
</summary>
<returns>
A unique <see cref="T:System.String"/> filename.
</returns>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Size">
<summary>
Get the maximum <see cref="T:System.UInt64"/> size of this <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.IsMemoryMapped">
<summary>
Get flag indicating whether or not this <see cref="T:DTS.Utilities.LargeArray"/> is
currently associated with a disk file.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.ViewSize">
<summary>
Get the <see cref="T:System.UInt32"/> view size used by our memory mapping mechanism.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.DatumSize">
<summary>
The <see cref="T:System.UInt32"/> size of the basic datum type stored by this object.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.DatumClearValue">
<summary>
The value to be substituted for all array values when "clear" is invoked.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.CreateScratchFile(System.UInt64,System.String,System.String)">
<summary>
Create the scratch file that will store this object's items.
</summary>
<param name="size">
The <see cref="T:System.UInt32"/> size of the scratch file to be created.
</param>
<param name="directory">
The <see cref="T:System.String"/> path of the directory to contain the newly-created scratch
file. It will be created if it does not already exist.
</param>
<param name="filename">
The <see cref="T:System.String"/> name of the file to be created.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the file has been successfully created, false otherwise.
</returns>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.ViewArray">
<summary>
Create a file map view array to associate this object with a file representation.
</summary>
<returns>
A <see cref="T:DTS.Utilities.IO.MemoryMap.FileMapViewArray"/> association with with object's data file.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.GetDatumAtIndex(System.UInt64)">
<summary>
Get the datum at the specified index.
</summary>
<param name="index">
The <see cref="T:System.UInt32"/> index of the datum sought.
</param>
<returns>
The datum of type T at the specified index of the memory mapped file.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.SetDatumAtIndex(`0,System.UInt64)">
<summary>
Set the specified index to the specified datum.
</summary>
<param name="datum">
The datum to be inserted at the specified index.
</param>
<param name="index">
The <see cref="T:System.UInt64"/> index of the specified datum's destination.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Dispose">
<summary>
Let go our our resources.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Count">
<summary>
Gets the <see cref="T:System.Int32"/> number of elements contained in the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.IsSynchronized">
<summary>
Gets a <see cref="T:System.Boolean"/> value indicating whether access to the <see cref="T:DTS.Utilities.LargeArray"/>
is synchronized (thread safe). Returns true if access to the <see cref="T:DTS.Utilities.LargeArray"/>
is synchronized (thread safe); otherwise, false.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.SyncRoot">
<summary>
Get an object that can be used to synchronize access to the System.Collections.ICollection.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.CopyTo(System.Array,System.Int32)">
<summary>
Copies the elements of the <see cref="T:DTS.Utilities.LargeArray"/> to a <see cref="T:System.Array"/>,
starting at a particular <see cref="T:System.Array"/> index. If the array is too small
(we're storing more than max int items) then an exception will be thrown.
</summary>
<param name="array">
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements
copied from System.Collections.ICollection. The <see cref="T:System.Array"/> must have zero-based
indexing.
</param>
<param name="index">
The zero-based <see cref="T:System.Int32"/> index inn the array at which copying begins.
</param>
<exception cref="T:System.ArgumentNullException">
The array is null.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is less than zero.
</exception>
<exception cref="T:System.ArgumentException">
The array is multidimensional OR...
the index is equal to or greater than the length of the array OR...
the number of elements in the source System.Collections.ICollection is greater than the available
space from index to the end of the destination array.
</exception>
<exception cref="T:System.ArgumentException">
The type of the source System.Collections.ICollection cannot be cast automatically
to the type of the destination array.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.GetEnumerator">
<summary>
Returns an enumerator that iterates through a collection.
</summary>
<returns>
An System.Collections.IEnumerator object that can be used to iterate through
the collection.
</returns>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.IsFixedSize">
<summary>
Gets a <see cref="T:System.Boolean"/> value indicating whether the <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
Returns true if it has a fixed size; otherwise, false.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.IsReadOnly">
<summary>
Get a <see cref="T:System.Boolean"/> value indicating whether or not this <see cref="T:DTS.Utilities.LargeArray"/>
object is read-only. Returns true if it is read-only; false otherwise.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Item(System.Int32)">
<summary>
Get/set the element at the specified <see cref="T:System.Int32"/> index.
</summary>
<param name="index">
The <see cref="T:System.Int32"/> zero-based index of the element to gat or sat.
</param>
<returns>
The element at the specified index.
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>.
</exception>
<exception cref="T:System.NotSupportedException">
The property is not set and the <see cref="T:DTS.Utilities.LargeArray"/> is read-only.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Add(System.Object)">
<summary>
Add an item to the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to add to the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<returns>
The <see cref="T:System.Int32"/> position into which the new element was inserted.
</returns>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
The <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Clear">
<summary>
Remove all items from the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Contains(System.Object)">
<summary>
Determines whether the <see cref="T:DTS.Utilities.LargeArray"/> contains a specific value.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to locate in the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the <see cref="T:System.Object"/> is found in the <see cref="T:DTS.Utilities.LargeArray"/>;
false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.IndexOf(System.Object)">
<summary>
Determine the index of a specific item in the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to be located in the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<returns>
the <see cref="T:System.Int32"/> index value if found in the list; -1 otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Insert(System.Int32,System.Object)">
<summary>
Insert an item into the <see cref="T:DTS.Utilities.LargeArray"/> at the specified index.
</summary>
<param name="index">
The zero-based <see cref="T:System.Int32"/> index at which the value should be inserted.
</param>
<param name="value">
The <see cref="T:System.Object"/> to insert into the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>
</exception>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
The <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Remove(System.Object)">
<summary>
Remove the first occurance of a specific object from the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to be removed from the <see cref="T:DTS.Utilities.LargeArray"/>
</param>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
the <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.RemoveAt(System.Int32)">
<summary>
Remove the <see cref="T:DTS.Utilities.LargeArray"/> item at the specified index.
</summary>
<param name="index">
The zero-based <see cref="T:System.Int32"/> index of the item to remove.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>.
</exception>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
the <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeCount">
<summary>
Gets the <see cref="T:System.UInt64"/> number of elements contained in the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeCopyTo(System.Array,System.UInt64)">
<summary>
Copies the elements of the <see cref="T:DTS.Utilities.LargeArray"/> to a <see cref="T:System.Array"/>,
starting at a particular <see cref="T:System.Array"/> index. If the array is too small
(we're storing more than max int items) then an exception will be thrown.
</summary>
<param name="array">
The one-dimensional <see cref="T:System.Array"/> that is the destination of the elements
copied from System.Collections.ICollection. The <see cref="T:System.Array"/> must have zero-based
indexing.
</param>
<param name="index">
The zero-based <see cref="T:System.UInt64"/> index inn the array at which copying begins.
</param>
<exception cref="T:System.ArgumentNullException">
The array is null.
</exception>
<exception cref="T:System.ArgumentException">
The array is multidimensional OR...
the index is equal to or greater than the length of the array OR...
the number of elements i nthe source System.Collections.ICollection is greater than the available
space from index to the end of the destination array.
</exception>
<exception cref="T:System.ArgumentException">
The type of the source System.Collections.ICollection cannot be cast automatically
to the type of the destination array.
</exception>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Item(System.UInt64)">
<summary>
Get/set the element at the specified <see cref="T:System.Int32"/> index.
</summary>
<param name="index">
The <see cref="T:System.UInt64"/> zero-based index of the element to gat or sat.
</param>
<returns>
The element at the specified index.
</returns>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>.
</exception>
<exception cref="T:System.NotSupportedException">
The property is not set and the <see cref="T:DTS.Utilities.LargeArray"/> is read-only.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeAdd(System.Object)">
<summary>
Add an item to the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to add to the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<returns>
The <see cref="T:System.UInt64"/> position into which the new element was inserted.
</returns>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
The <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeIndexOf(System.Object)">
<summary>
Determine the index of a specific item in the <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
<param name="value">
The <see cref="T:System.Object"/> to be located in the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<returns>
the <see cref="T:System.UInt64"/> index value if found in the list; null otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeInsert(System.UInt64,System.Object)">
<summary>
Insert an item into the <see cref="T:DTS.Utilities.LargeArray"/> at the specified index.
</summary>
<param name="index">
The zero-based <see cref="T:System.UInt64"/> index at which the value should be inserted.
</param>
<param name="value">
The <see cref="T:System.Object"/> to insert into the <see cref="T:DTS.Utilities.LargeArray"/>.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>
</exception>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
The <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeRemoveAt(System.UInt64)">
<summary>
Remove the <see cref="T:DTS.Utilities.LargeArray"/> item at the specified index.
</summary>
<param name="index">
The zero-based <see cref="T:System.UInt64"/> index of the item to remove.
</param>
<exception cref="T:System.ArgumentOutOfRangeException">
The index is not a valid index in the <see cref="T:DTS.Utilities.LargeArray"/>.
</exception>
<exception cref="T:System.NotSupportedException">
The <see cref="T:DTS.Utilities.LargeArray"/> is read-only OR...
the <see cref="T:DTS.Utilities.LargeArray"/> has a fixed size.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Clone">
<summary>
create a new object that is a copy of the current instance
</summary>
<returns>a new object of the same type with all objects duplicated or referenced</returns>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator">
<summary>
An enumerator class for <see cref="T:DTS.Utilities.LargeArray"/>.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.#ctor(DTS.Utilities.IO.MemoryMap.LargeArray{`0})">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.LargeArray.Enumerator"/> class.
</summary>
<param name="enumeratee">
The <see cref="T:DTS.Utilities.LargeArray"/> object to be operated upon by this instance.
</param>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.Enumeratee">
<summary>
Get the <see cref="T:DTS.Utilities.LargeArray"/> that his enumerator object is
acting upon.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.CurrentIndex">
<summary>
The <see cref="T:System.UInt64"/> index of the current item.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.Current">
<summary>
Get the current element in the collection.
</summary>
<exception cref="T:System.InvalidOperationException">
The enumerator is positioned before the first element of the collection or after the last element OR...
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.MoveNext">
<summary>
Advances the enumerator to the next element of the collection.
</summary>
<returns>
<see cref="T:System.Boolean"/> true if the enumerator was successfully advanced to the next
element; false if the enumerator has passed the end of the collection.
</returns>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.Enumerator.Reset">
<summary>
Sets the enumerator to its initial position, which is before the first element
in the collection.
</summary>
<exception cref="T:System.InvalidOperationException">
The collection was modified after the enumerator was created.
</exception>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeOverflowException">
<summary>
Representation of a failed attempt to convert a "Large" interface data type to one of
the smaller data types in the "standard" interface.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeOverflowException.#ctor">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.LargeOverflowException"/> class.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeOverflowException.#ctor(System.String)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.LargeOverflowException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.LargeOverflowException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.LargeOverflowException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1.MissingScratchFileException">
<summary>
Representation of erroneous missing <see cref="T:DTS.Utilities.LargeArray"/>
scratch file condition.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.MissingScratchFileException.#ctor">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.MissingScratchFileException"/> class.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.MissingScratchFileException.#ctor(System.String)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.MissingScratchFileException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.MissingScratchFileException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.MissingScratchFileException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1.NameGeneratorLock">
<summary>
A class intended to serve as a locking object for all MegArrays, so they don't
try to use the same seed number for generating their respective scratch files.
</summary>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchFileAlreadyExistsException">
<summary>
Representation of erroneous pre-existing <see cref="T:DTS.Utilities.LargeArray"/>
scratch file condition.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchFileAlreadyExistsException.#ctor">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.ScratchFileAlreadyExistsException"/> class.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchFileAlreadyExistsException.#ctor(System.String)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.ScratchFileAlreadyExistsException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.LargeArray`1.ScratchFileAlreadyExistsException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
<see cref="T:DTS.Utilities.LargeArray.ScratchFileAlreadyExistsException"/> class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.MapProtection">
<summary>
Specifies page protection for the mapped file
These correspond to the PAGE_XXX set of flags
passed to CreateFileMapping()
</summary>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.MapViewStream">
<summary>
Allows you to read/write from/to
a view of a memory mapped file.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.#ctor(System.IntPtr,System.Int64,DTS.Utilities.IO.MemoryMap.MapProtection)">
<summary>
Constructor used internally by MemoryMappedFile.
</summary>
<param name="baseAddress">base address where the view starts</param>
<param name="length">Length of view, in bytes</param>
<param name="protection"></param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Finalize">
<summary>
finalizer for MapViewStream.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Flush">
<summary>
causes any buffered data to be written to the stream and clears the buffer
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Read(System.Byte[],System.Int32,System.Int32)">
<summary>
reads a sequence of bytes from the current stream and advances the position in the stream by the number
of bytes read
</summary>
<param name="buffer">array of bytes, will contain the bytes read from the stream offset by
"offset"</param>
<param name="offset">the offset from the start of buffer to store read data</param>
<param name="count">the maximum number of bytes to read</param>
<returns>the number of bytes read into the buffer
Arguement Exception if count is greater than buffer after offset is removed
ObjectDisposedException if stream is not open
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Write(System.Byte[],System.Int32,System.Int32)">
<summary>
writes specified number of bytes to the stream starting at an offset
</summary>
<param name="buffer">array containing the bytes to be written</param>
<param name="offset">the offset from the start of buffer to start reading from</param>
<param name="count">maximum number of bytes to write</param>
<remarks>
throws ObjectDisposedException if the stream is no longer open
throws FileMapIOException if the stream cannot be written to
throws ArgumentException if count is greater than buffer length after removing offset
</remarks>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Seek(System.Int64,System.IO.SeekOrigin)">
<summary>
move to a specified position in the stream
</summary>
<param name="offset">a byte offset relative to the origin parameter</param>
<param name="origin"><see cref="T:System.IO.SeekOrigin" /> position to seek relative to
(current, beginning, end)
</param>
<returns>new position in the stream</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.SetLength(System.Int64)">
<summary>
not supported
sets the length of the current stream
</summary>
<param name="value"></param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Close">
<summary>
Close the current stream and release any resources
</summary>
<remarks>generally close isn't overriden?</remarks>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MapViewStream.Dispose(System.Boolean)">
<summary>
release unmanaged resources
</summary>
<param name="disposing"></param>
<remarks>virtual void Dispose functions can be dangerous
as overriding it in an inherited class might mean you miss
the base class Dispose
</remarks>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.MapAccess">
<summary>
Specifies access for the mapped file.
These correspond to the FILE_MAP_XXX
constants used by MapViewOfFile[Ex]()
</summary>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.MemoryMappedFile">
<summary>Wrapper class around the Win32 MMF APIs</summary>
<remarks>
Allows you to easily use memory mapped files on
.NET applications.
Currently, not all functionality provided by
the Win32 system is avaliable. Things that are not
supported include:
<list>
<item>You can't specify security descriptors</item>
<item>You can't build the memory mapped file
on top of a System.IO.File already opened</item>
</list>
The class is currently MarshalByRefObject, but I would
be careful about possible interactions!
</remarks>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.#ctor">
<summary>
Default constructor
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Finalize">
<summary>
Finalizer
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Create(DTS.Utilities.IO.MemoryMap.MapProtection,System.Int64,System.String)">
<summary>
Create an unnamed map object with no file backing
</summary>
<param name="protection">desired access to the
mapping object</param>
<param name="maxSize">maximum size of filemap object</param>
<param name="name">name of file mapping object</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Create(DTS.Utilities.IO.MemoryMap.MapProtection,System.Int64)">
<summary>
Create an named map object with no file backing
</summary>
<param name="protection">desired access to the
mapping object</param>
<param name="maxSize">maximum size of filemap object</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Create(System.String,DTS.Utilities.IO.MemoryMap.MapProtection)">
<summary>
Create an unnamed map object with a maximum size
equal to that of the file
</summary>
<param name="fileName">name of backing file</param>
<param name="protection">desired access to the
mapping object</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Create(System.String,DTS.Utilities.IO.MemoryMap.MapProtection,System.Int64)">
<summary>
Create an unnamed map object
</summary>
<param name="fileName">name of backing file</param>
<param name="protection">desired access to the
mapping object</param>
<param name="maxSize">maximum size of filemap
object, or -1 for size of file</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Create(System.String,DTS.Utilities.IO.MemoryMap.MapProtection,System.Int64,System.String)">
<summary>
Create a named map object
</summary>
<param name="fileName">name of backing file, or null
for a pagefile-backed map</param>
<param name="protection">desired access to the mapping
object</param>
<param name="maxSize">maximum size of filemap object, or 0
for size of file</param>
<param name="name">name of file mapping object</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Open(DTS.Utilities.IO.MemoryMap.MapAccess,System.String)">
<summary>
Open an existing named File Mapping object
</summary>
<param name="access">desired access to the map</param>
<param name="name">name of object</param>
<returns>The memory mapped file instance</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.Close">
<summary>
Close this File Mapping object
From here on, You can't do anything with it
but the open views remain valid.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.MemoryMappedFile.MapView(DTS.Utilities.IO.MemoryMap.MapAccess,System.Int64,System.Int32)">
<summary>
Map a view of the file mapping object
This returns a stream, giving you easy access to the memory,
as you can use StreamReaders and StreamWriters on top of it
</summary>
<param name="access">desired access to the view</param>
<param name="offset">offset of the file mapping object to
start view at</param>
<param name="size">size of the view</param>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.ShortLargeArray">
<summary>
a <see cref="T:DTS.Utilities.IO.MemoryMap.LargeArray" /> of
<see cref="T:System.Int16" />
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.ShortLargeArray.#ctor(System.UInt64)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.IO.MemoryMap.ShortLargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.ShortLargeArray.#ctor(System.UInt64,System.String,System.String)">
<summary>
Initialize an instance of a <see cref="T:DTS.Utilities.IO.MemoryMap.ShortLargeArray"/>.
</summary>
<param name="size">
The <see cref="T:System.UInt64"/> size of the collection.
</param>
<param name="scratchFileDirectory">
The <see cref="T:System.String"/> name of the directory where this LargeArray will store the temporary
serializations of its items. If null, then the default location will be used.
</param>
<param name="scratchFilePrefix">
The <see cref="T:System.String"/> file name prefix under which this LargeArray will store temporary
serializations of its items. Initialized to DefaultFilePrefix's value at object
creation, unless an alternate is specified by the user. If null, then the default prefix
will be used.
</param>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.ShortLargeArray.DatumSize">
<summary>
Get the <see cref="T:System.UInt32"/> size of the datum handled by this class.
</summary>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.ShortLargeArray.DatumClearValue">
<summary>
Get the "zero" value for this class' datum type.
</summary>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.ShortLargeArray.GetDatumAtIndex(System.UInt64)">
<summary>
Get the datum value at the specified index.
</summary>
<param name="index">
The <see cref="T:System.UInt64"/> index of the datum to be returned.
</param>
<returns>
The value of the <see cref="T:System.Int16"/> datum at the specified index.
</returns>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.ShortLargeArray.SetDatumAtIndex(System.Int16,System.UInt64)">
<summary>
Set the datum value at the specified index.
</summary>
<param name="datum">
The <see cref="T:System.Int16"/> datum to be written to the specified index.
</param>
<param name="index">
The <see cref="T:System.UInt64"/> index at which the specified datum value will be written.
</param>
</member>
<member name="M:DTS.Utilities.IO.MemoryMap.ShortLargeArray.Clone">
<summary>
Creates a new object that is a copy of the current instance.
</summary>
<returns>
A new <see cref="T:System.Object"/> that is a copy of the current instance.
</returns>
</member>
<member name="P:DTS.Utilities.IO.MemoryMap.ShortLargeArray.Item(System.UInt64)">
<summary>
Get/set the value at the specified index.
</summary>
<param name="index">
The <see cref="T:System.UInt64"/> index of the datum to be referenced.
</param>
<returns>
The <see cref="T:System.Int16"/> value of the datum at the specified index.
</returns>
</member>
<member name="T:DTS.Utilities.IO.MemoryMap.Win32MapApis">
<summary>Win32 APIs used by the library</summary>
<remarks>
Defines the PInvoke functions we use
to access the FileMapping Win32 APIs
</remarks>
</member>
<member name="M:DTS.Utilities.DTSChecksum.GetCRC16(System.Byte[],System.UInt16)">
<summary>
Computes the 16-bit CRC of the n passed in data bytes. N should be
even(if it is not, the last byte will not get included in the
computation). The initial_crc is the value to seed the computation
from - normally it will be set to 0.
</summary>
<param name="data">the unsigned character buffer of which to compute the CRC16 </param>
<param name="initial_crc">the CRC16 value to seed the computation with</param>
<returns>the updated CRC16 starting with initial_crc and computed over n data bytes</returns>
</member>
<member name="M:DTS.Utilities.DTSChecksum.CalculateCRCCCITT(System.Byte[],System.UInt16)">
Computes the 16-bit CRC of the n passed in data bytes. CCITT implementation
N should be
even (if it is not, the last byte will not get included in the
computation). The initial_crc is the value to seed the computation
from - normally it will be set to 0.
@param data the unsigned character buffer of which to compute the CRC16
@param n the number of bytes in data (must be even!)
@param initial_crc the CRC16 value to seed the computation with
@return the updated CRC16 starting with initial_crc and computed over
n data bytes
</member>
<member name="M:DTS.Utilities.DTSChecksum.GetMD5(System.Byte[])">
<summary>
Gets the MD5 hash of a byte array
</summary>
<param name="data"></param>
<returns></returns>
</member>
<member name="T:DTS.Utilities.EnumDropDown`1.EnumListEntry">
<summary>
This is the class which actually holds the entrys in the list
</summary>
</member>
<member name="P:DTS.Utilities.EnumDropDown`1.SelectedEntry">
<summary>
Get or Set the selection as an EnumListEntry (can be null).
</summary>
</member>
<member name="P:DTS.Utilities.EnumDropDown`1.SelectedEnum">
<summary>
Get or Set the selection as the enum itself (can NOT be null)!
</summary>
</member>
<member name="T:DTS.Utilities.Exceptional">
<summary>
"Ultimate" base class for all DTS classes that expect to throw exceptions.
Deriving classes from this class allows exceptions to be trapped based on
the class type that threw them.
</summary>
<remarks>
Sample usage:
public class A : Exceptional
{
public void ScrewItUp( )
{
private bool error = true;
if ( error ) throw new A.Exception( "Class A-specific screwup." );
}
}
...
try
{
A.ScrewItUp( );
B.ScrewItUp( );
C.ScrewItUp( );
}
catch ( A.Exception ex )
{
// Can pick A's exceptions out of a crowd, or not and just treat it
// polymorphically as a System.Exception.
}
</remarks>
</member>
<member name="T:DTS.Utilities.Exceptional.Exception">
<summary>
Initialize an instance of the DerivedClass.Exception class.
</summary>
</member>
<member name="M:DTS.Utilities.Exceptional.Exception.#ctor">
<summary>
create a <see cref="T:DTS.Utilities.Exceptional.Exception" /> object
</summary>
</member>
<member name="M:DTS.Utilities.Exceptional.Exception.#ctor(System.String)">
<summary>
create a <see cref="T:DTS.Utilities.Exceptional.Exception" /> object
</summary>
<param name="msg">a message that describes the error</param>
</member>
<member name="M:DTS.Utilities.Exceptional.Exception.#ctor(System.String,System.Exception)">
<summary>
create a <see cref="T:DTS.Utilities.Exceptional.Exception" /> object
</summary>
<param name="msg">a message that describes the error</param>
<param name="innerEx">The exception that is the cause of the current exception.</param>
</member>
<member name="T:DTS.Utilities.Exceptional.UserException">
<summary>
Initialize an instance of the DerivedClass.UserException class.
</summary>
</member>
<member name="M:DTS.Utilities.Exceptional.UserException.#ctor(System.String)">
<summary>
create a user Exception with a description of the event
</summary>
<param name="msg">description of error</param>
</member>
<member name="M:DTS.Utilities.Exceptional.GenerateLogMessageFromExceptionTree(System.Exception)">
<summary>
Walk the nested exception tree and generate a single string from their messages.
</summary>
<param name="ex">
The parent <see cref="T:System.Exception"/>.
</param>
<returns>
The <see cref="T:System.String"/> concatenation of the exception tree's messages.
</returns>
</member>
<member name="M:DTS.Utilities.Exceptional.GenerateLogMessageFromExceptionTree(System.Exception,System.Boolean)">
<summary>
Walk the nested exception tree and generate a single string from their messages.
</summary>
<param name="ex">
The parent <see cref="T:System.Exception"/>.
</param>
<param name="addNewlines">
<see cref="T:System.Boolean"/> true to insert a newline between each exception's message,
false to insert a delimiter between each instead.
</param>
<returns>
The <see cref="T:System.String"/> concatenation of the exception tree's messages.
</returns>
</member>
<member name="M:DTS.Utilities.Exceptional.GenerateMessageFromExceptionTree(System.Exception)">
<summary>
Legacy wrapper for walking the nested exception tree and generating a single string from their messages
</summary>
<param name="ex">
The parent <see cref="T:System.Exception"/>.
</param>
<returns>
The <see cref="T:System.String"/> concatenation of the exception tree's messages.
</returns>
</member>
<member name="M:DTS.Utilities.Exceptional.GenerateMessageFromExceptionTree(System.Exception,System.Boolean,System.Boolean,System.Boolean)">
<summary>
Walk the nested exception tree and generate a single string from their messages.
</summary>
<param name="ex">
The parent <see cref="T:System.Exception"/>.
</param>
<param name="addNewlines">
<see cref="T:System.Boolean"/> true to insert a newline between each exception's message,
false to insert a delimiter between each instead.
</param>
<param name="makeSentence">
<see cref="T:System.Boolean"/> true to append "because" after each exception message in
string and end deepest message with a period, false to leave messages raw.
</param>
<returns>
The <see cref="T:System.String"/> concatenation of the exception tree's messages.
</returns>
</member>
<member name="M:DTS.Utilities.Exceptional.ExtractFirstExceptionOfTypeFromExceptionTree``1(System.Exception)">
<summary>
Extract the first exception of the specified class type from the specified
exception's exception tree.
</summary>
<typeparam name="ExceptionType">
The type of System.Exception-derived class to be extracted.
</typeparam>
<param name="ex">
The <see cref="T:System.Exception"/>-derived class to have its exception tree
searched.
</param>
<returns>
The first nested innner exception of type ExceptionType; null otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.Exceptional.ExceptionTreeContainsUserException(System.Exception)">
<summary>
Determine whether or not the specified exception's exception tree contains
a UserException-derived exception.
</summary>
<param name="ex">
The <see cref="T:System.Exception"/>-derived class to have its exception tree
searched.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the specified exception tree contains a
UserException-type exception; false otherwise.
</returns>
</member>
<member name="T:DTS.Utilities.ExceptionalDictionary`2">
<summary>
Represents a collection of keys and values, with its own exception type.
</summary>
<typeparam name="TKey">
The type of the keys in the dictionary.
</typeparam>
<typeparam name="TValue">
The type of the values in the dictionary.
</typeparam>
<remarks>
Sample usage:
public class A : ExceptionalDictionary &lt;int, int&gt;
{
public void ScrewItUp( )
{
private bool error = true;
if ( error ) throw new A.Exception( "Class A-specific screwup." );
}
}
...
try
{
A.ScrewItUp( );
B.ScrewItUp( );
C.ScrewItUp( );
}
catch ( A.Exception ex )
{
// Can pick A's exceptions out of a crowd, or not and just treat it
// polymorphically as a System.Exception.
}
</remarks>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class that is empty, has the default initial capacity, and uses the default quality
comparer for the key type.
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Int32)">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class that is empty, has the specified initial capacity, and uses the default quality
comparer for the key type.
</summary>
<param name="capacity">
The initial number of elements that the DTS.Utilities.ExceptionalDictionary
can contain.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class that is empty, has the default initial capacity, and uses the specified quality
comparer for the key type.
</summary>
<param name="comparer">
The T:System.Collections.Generic.IEqualityComparer implementation to use when comparaing
keys, or null to use the default T:System.Collections.Generic.IEqualityComparer for the
type of the key.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1})">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class initialized to the settings and contents of the specified
System.Collections.Generic.IDictionary-sporting object.
</summary>
<param name="dictionary">
The System.Collections.Generic.IDictionary whose elements are copied
to the new DTS.Utilities.ExceptionalDictionary.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class that is empty, has the specified initial capacity, and uses the specified quality
comparer for the key type.
</summary>
<param name="capacity">
The initial number of elements that the DTS.Utilities.ExceptionalDictionary
can contain.
</param>
<param name="comparer">
The T:System.Collections.Generic.IEqualityComparer implementation to use when comparing
keys, or null to use the default T:System.Collections.Generic.IEqualityComparer for the
type of the key.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class with the specified serialization information and context.
</summary>
<param name="info">
A System.Runtime.Serialization.SerializationInfo object containing the information
required to serialize the DTS.Utilities.ExceptionalDictionary.
</param>
<param name="context">
A System.Runtime.Serialization.StreamingContext structure containing the source and
destination of the serialized stream associated with the
DTS.UtilitiesExceptionalDictionary.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1},System.Collections.Generic.IEqualityComparer{`0})">
<summary>
Initializes a new instance of the DTS.Utilities.ExceptionalDictionary
class with the specified dictionary key/value pairs and the specified comparer implementation.
</summary>
<param name="dictionary">
The System.Collections.Generic.IDictionary whose elements are copied to the new
DTS.Utilities.ExceptionalDictionary.
</param>
<param name="comparer">
The T:System.Collections.Generic.IEqualityComparer implementation to use when comparing keys, or null to use the default
T:System.Collections.Generic.IEqualityComparer for the type of the key.
</param>
</member>
<member name="T:DTS.Utilities.ExceptionalDictionary`2.Exception">
<summary>
A representation of the DerivedClass.Exception class.
</summary>
</member>
<member name="T:DTS.Utilities.ExceptionalForm">
<summary>
A Windows-style Form with it's own exception type.
</summary>
<remarks>
Sample usage:
public class A : ExceptionalForm
{
public void ScrewItUp( )
{
private bool error = true;
if ( error ) throw new A.Exception( "Class A-specific screwup." );
}
}
...
try
{
A.ScrewItUp( );
B.ScrewItUp( );
C.ScrewItUp( );
}
catch ( A.Exception ex )
{
// Can pick A's exceptions out of a crowd, or not and just treat it
// polymorphically as a System.Exception.
}
</remarks>
</member>
<member name="M:DTS.Utilities.ExceptionalForm.#ctor">
<summary>
Initialize an instance of the DTS.Utilities.ExceptionForm class.
</summary>
</member>
<member name="T:DTS.Utilities.ExceptionalForm.Exception">
<summary>
A representation of the DerivedClass.Exception class.
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalForm.Exception.#ctor">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalForm.Exception" />
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalForm.Exception.#ctor(System.String)">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalForm.Exception" /> with
a description
</summary>
<param name="msg">Description of error</param>
</member>
<member name="M:DTS.Utilities.ExceptionalForm.Exception.#ctor(System.String,System.Exception)">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalForm.Exception" /> with
a description and a reference to the exception causing the error
</summary>
<param name="msg">Description of error</param>
<param name="innerEx">exception causing the error</param>
</member>
<member name="T:DTS.Utilities.ExceptionalList`1">
<summary>
A version of <see cref="T:List"/> that provides its own exception type.
</summary>
<typeparam name="T">
The type of object contained by this list.
</typeparam>
<remarks>
Sample usage:
public class A : ExceptionalList &lt;int&gt;
{
public void ScrewItUp( )
{
private bool error = true;
if ( error ) throw new A.Exception( "Class A-specific screwup." );
}
}
...
try
{
A.ScrewItUp( );
B.ScrewItUp( );
C.ScrewItUp( );
}
catch ( A.Exception ex )
{
// Can pick A's exceptions out of a crowd, or not and just treat it
// polymorphically as a System.Exception.
}
</remarks>
</member>
<member name="M:DTS.Utilities.ExceptionalList`1.#ctor">
<summary>
Initialize an instance of the ExceptionalList class.
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalList`1.#ctor(System.Int32)">
<summary>
Initialize an instance of the ExceptionalList class.
</summary>
<param name="capacity">
The number of elements that the list can initially store.
</param>
</member>
<member name="M:DTS.Utilities.ExceptionalList`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
<summary>
Initialize an instance of the ExceptionalList class.
</summary>
<param name="collection">
The collection whose elements are copied to the new list.
</param>
</member>
<member name="T:DTS.Utilities.ExceptionalList`1.Exception">
<summary>
A representation of the DerivedClass.Exception class.
</summary>
</member>
<member name="T:DTS.Utilities.ExceptionalUserControl">
<summary>
A version of <see cref="T:System.Windows.Forms.UserControl"/> that provides its own exception type.
</summary>
<remarks>
Sample usage:
public class A : ExceptionalUserControl
{
public void ScrewItUp( )
{
private bool error = true;
if ( error ) throw new A.Exception( "Class A-specific screwup." );
}
}
...
try
{
A.ScrewItUp( );
B.ScrewItUp( );
C.ScrewItUp( );
}
catch ( A.Exception ex )
{
// Can pick A's exceptions out of a crowd, or not and just treat it
// polymorphically as a System.Exception.
}
</remarks>
</member>
<member name="M:DTS.Utilities.ExceptionalUserControl.#ctor">
<summary>
Initialize an instance of the DTS.Utilities.ExceptionalUserControl class.
</summary>
</member>
<member name="T:DTS.Utilities.ExceptionalUserControl.Exception">
<summary>
A representation of the DerivedClass.Exception class.
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalUserControl.Exception.#ctor">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalUserControl.Exception" />
</summary>
</member>
<member name="M:DTS.Utilities.ExceptionalUserControl.Exception.#ctor(System.String)">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalUserControl.Exception" /> with a description
</summary>
<param name="msg">Description of error</param>
</member>
<member name="M:DTS.Utilities.ExceptionalUserControl.Exception.#ctor(System.String,System.Exception)">
<summary>
create a <see cref="T:DTS.Utilities.ExceptionalUserControl.Exception" /> with a description
and a reference to the exception causing the error
</summary>
<param name="msg">Description of error</param>
<param name="innerEx">exception causing error</param>
</member>
<member name="T:DTS.Utilities.FileIOApiDeclarations">
<summary>
win32 I/O declarations
</summary>
</member>
<member name="T:DTS.Utilities.SaeJ211.FilterUtility">
<summary>
Utility for filtering data according to the NHTSA implementation of the
SAE J211 standard.
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.CalibrationFactor">
<summary>
Get/set the calibration scaling factor to be applied to data, post-filtering.
Useful for "last minute" scaling or inversion. Defaults to "1.0".
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.SampleRate">
<summary>
Get/set the sampling rate (samples/sec) of the data to be filtered. This
property must be set by user before the data can be filtered.
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.Cfc">
<summary>
Get/set SAE Channel Filter Class to be applied to data. This property must
be set by user before the data can be filtered.
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.AdHocFrequency">
<summary>
Get/set the <see cref="T:System.Double"/> ad hoc frequency of this filter.
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.ZeroBaseline">
<summary>
Get/set the zero baseline flag. Defaults to "false".
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.PadSize">
<summary>
Get/set the size (in sec) of the padding added to the beginning and ending of
the data before filtering to "squelch out" startup spikes. A negative value
will cause pad to default to 5% of data size.
</summary>
</member>
<member name="T:DTS.Utilities.SaeJ211.FilterUtility.DataPaddingType">
<summary>
Types of pre/post-padding data population available.
</summary>
</member>
<member name="F:DTS.Utilities.SaeJ211.FilterUtility.DataPaddingType.FirstAndLast">
<summary>
Create data padding by repeatedly copying value of first and last samples.
</summary>
</member>
<member name="F:DTS.Utilities.SaeJ211.FilterUtility.DataPaddingType.Mirror">
<summary>
Create data padding by mirroring data at beginning and end of data vector.
</summary>
</member>
<member name="F:DTS.Utilities.SaeJ211.FilterUtility.DataPaddingType.Zero">
<summary>
Pad the data with zeros
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.DataPadding">
<summary>
Get/set the type of data padding appended/prepended to the data prior to
being subjected to the filtering algorithm.
</summary>
</member>
<member name="P:DTS.Utilities.SaeJ211.FilterUtility.Type">
<summary>
Get the string that describes the type of filtering performed by this object.
</summary>
</member>
<member name="M:DTS.Utilities.SaeJ211.FilterUtility.#ctor">
<summary>
Initialize an instance of the SaeJ211FilterUtility class.
</summary>
</member>
<member name="M:DTS.Utilities.SaeJ211.FilterUtility.FrequencyToCfc(System.Double)">
<summary>
Convert the specified frequency to an equivalent CFC value. Note that the
"Big 4" CFC values get slightly special treatment.
</summary>
<param name="frequency">
The <see cref="T:System.Double"/> frequency to be converted.
</param>
<returns>
The <see cref="T:System.Double"/> CFC equivalent of the specified frequency.
</returns>
</member>
<member name="M:DTS.Utilities.SaeJ211.FilterUtility.ApplyFilter(System.Double[],DTS.Utilities.SaeJ211.FilterUtility.InvalidDataDelegate)">
<summary>
Apply the SAE J211 filter algorithm (4-pole, phaseless, lo-pass) to the specified
data using to the current FilterTool properties.
</summary>
<param name="data">
An array of <see cref="T:System.Double"/>s containing the raw data to be filtered.
</param>
<returns>
An array of <see cref="T:System.Double"/>s containing the filtered data.
</returns>
</member>
<member name="T:DTS.Utilities.FirmwareVersionToLong">
<summary>
produces a long value given a firmware version in string representation
</summary>
</member>
<member name="M:DTS.Utilities.FirmwareVersionToLong.Query(System.String)">
<summary>
Produces a long value given a firmware version represented as a string
</summary>
<param name="version">firmware version</param>
<returns>firmware version as a long</returns>
</member>
<member name="T:DTS.Utilities.HexEncoding">
<summary>
Summary description for HexEncoding.
</summary>
<remarks>This class has only static methods and appears to never be instantiated,
so I'm marking it static as well
there are built in classes for encoding and converting hex as well, but the behavior
here may deviate slightly
</remarks>
</member>
<member name="M:DTS.Utilities.HexEncoding.GetByteCount(System.String)">
<summary>
returns the number of bytes needed to represent hex string
</summary>
<param name="hexString">hex string to calculate</param>
<returns>number of bytes</returns>
<remarks>doesn't count non hex characters
odd number of characters, last character is discarded
</remarks>
</member>
<member name="M:DTS.Utilities.HexEncoding.GetBytes(System.String,System.Int32@)">
<summary>
Creates a byte array from the hexadecimal string. Each two characters are combined
to create one byte. First two hexadecimal characters become first byte in returned array.
Non-hexadecimal characters are ignored.
</summary>
<param name="hexString">string to convert to byte array</param>
<param name="discarded">number of characters in string ignored</param>
<returns>byte array, in the same left-to-right order as the hexString</returns>
</member>
<member name="M:DTS.Utilities.HexEncoding.ToString(System.Byte[])">
<summary>
returns a string representation out of byte array
</summary>
<param name="bytes">an array of hex characters packed 2 per byte</param>
<returns>string representation of hex characters in byte array, no spaces between bytes</returns>
</member>
<member name="M:DTS.Utilities.HexEncoding.InHexFormat(System.String)">
<summary>
Determines if given string is in proper hexadecimal string format
</summary>
<param name="hexString">string representing sequence of hex digits, no spaces</param>
<returns>true if all characters are hex digits, false otherwise</returns>
</member>
<member name="M:DTS.Utilities.HexEncoding.IsHexDigit(System.Char)">
<summary>
Returns true is c is a hexadecimal digit (A-F, a-f, 0-9)
</summary>
<param name="c">Character to test</param>
<returns>true if hex digit, false if not</returns>
</member>
<member name="M:DTS.Utilities.HexEncoding.HexToByte(System.String)">
<summary>
Converts 1 or 2 character string into equivalant byte value
</summary>
<param name="hex">1 or 2 character string</param>
<returns>byte</returns>
</member>
<member name="T:DTS.Utilities.Math.DoubleListOperation">
<summary>
Representation of a mathematical operation to be performed
on <see cref="T:System.Double"/> System.Collections.Generic.IList data.
</summary>
</member>
<member name="M:DTS.Utilities.Math.DoubleListOperation.#ctor(System.Collections.Generic.IList{System.Double})">
<summary>
Initialize an instance of the ChannelOperation class. As a matter of
style, a domain is required for object creation.
</summary>
<param name="domain">
A System.Collections.Generic.IList of <see cref="T:System.Double"/>s to be
integrated.
</param>
</member>
<member name="T:DTS.Utilities.Math.Iso.Differentiation">
<summary>
Representation of the ISO-based differentiation
System.Collections.Generic.IList of <see cref="T:System.Double"/>
-based operation.
</summary>
</member>
<member name="P:DTS.Utilities.Math.Iso.Differentiation.SampleRate">
<summary>
Get/set the <see cref="T:System.Double"/> time resolution of this differentiation.
Should probably be the length of one "sample" of digital data seeing as
we're trying to approximate a continuous domain.
</summary>
</member>
<member name="M:DTS.Utilities.Math.Iso.Differentiation.#ctor(System.Collections.Generic.IList{System.Double})">
<summary>
Initialize an instance of the Differentiation class.
</summary>
<param name="domain">
The System.Collection.Generic.IList of <see cref="T:System.Double"/>s
domain for this operation.
</param>
</member>
<member name="M:DTS.Utilities.Math.Iso.Differentiation.#ctor(System.Collections.Generic.IList{System.Double},System.Double)">
<summary>
Initialize an instance of the Iso.ChannelDifferentiation class.
</summary>
<param name="domain">
The System.Collections.Generic.IList of <see cref="T:System.Double"/>s
domain for this operation.
</param>
<param name="sampleRate">
The <see cref="T:System.Double"/> sample rate of the data to be differentiated.
</param>
</member>
<member name="P:DTS.Utilities.Math.Iso.Differentiation.Range">
<summary>
Get the result of the operation on the
System.Collections.Generic.IList of <see cref="T:System.Double"/>s
domain representation.
</summary>
</member>
<member name="T:DTS.Utilities.Math.Nhtsa.Differentiation">
<summary>
Representation of a NHTSA-based differentiation channel operation.
</summary>
</member>
<member name="P:DTS.Utilities.Math.Nhtsa.Differentiation.SampleRate">
<summary>
Get/set the sample rate for this data to be differentiated.
</summary>
</member>
<member name="M:DTS.Utilities.Math.Nhtsa.Differentiation.#ctor(System.Collections.Generic.IList{System.Double})">
<summary>
Initialize an instance of the ChannelDifferentiation class.
</summary>
<param name="domain">
The System.Collections.Generic.IList of <see cref="T:System.Double"/> domain for
this operation.
</param>
</member>
<member name="M:DTS.Utilities.Math.Nhtsa.Differentiation.#ctor(System.Collections.Generic.IList{System.Double},System.Int32)">
<summary>
Initialize an instance of the Iso.ChannelDifferentiation class.
</summary>
<param name="domain">
The System.Collections.Generic.IList of <see cref="T:System.Double"/> domain for
this operation.
</param>
<param name="sampleRate">
The <see cref="T:System.Int32"/> sample rate of the channel to be differentiated.
</param>
</member>
<member name="P:DTS.Utilities.Math.Nhtsa.Differentiation.Range">
<summary>
Get the System.Collections.Generic.IList of <see cref="T:System.Double"/> result of
the operation on the target domain.
</summary>
</member>
<member name="T:DTS.Utilities.Math.Nhtsa.Integration">
<summary>
Representation of NHTSA-based integration channel operation.
</summary>
</member>
<member name="P:DTS.Utilities.Math.Nhtsa.Integration.SampleRate">
<summary>
Get/set the <see cref="T:System.Double"/> sample rate for this data to be integrated.
</summary>
</member>
<member name="M:DTS.Utilities.Math.Nhtsa.Integration.#ctor(System.Collections.Generic.IList{System.Double})">
<summary>
Initialize an instance of the Integration class.
</summary>
<param name="domain">
The System.Collections.Generic.IList of <see cref="T:System.Double"/>s
domain for this operation.
</param>
</member>
<member name="M:DTS.Utilities.Math.Nhtsa.Integration.#ctor(System.Collections.Generic.IList{System.Double},System.Int32)">
<summary>
Initialize an instance of the Iso.ChannelIntegration class.
</summary>
<param name="domain">
The System.Collections.Generic.IList of <see cref="T:System.Double"/>s
domain for this operation.
</param>
<param name="sampleRate">
The <see cref="T:System.Int32"/> sample rate of the channel to be integrated.
</param>
</member>
<member name="P:DTS.Utilities.Math.Nhtsa.Integration.Range">
<summary>
Get the System.Collections.Generic.IList of <see cref="T:System.Double"/>s result of
the operation on the channel.
</summary>
</member>
<member name="T:DTS.Utilities.Math.Operation`2">
<summary>
Representation of a generic operation that maps a domain to a range.
</summary>
<typeparam name="DomainType">
The input data type.
</typeparam>
<typeparam name="RangeType">
The output data type.
</typeparam>
</member>
<member name="P:DTS.Utilities.Math.Operation`2.Domain">
<summary>
Get/set the domain of the differentiation.
</summary>
</member>
<member name="P:DTS.Utilities.Math.Operation`2.Range">
<summary>
Get the result of the operation.
</summary>
</member>
<member name="M:DTS.Utilities.Math.Operation`2.#ctor(`0)">
<summary>
Initialize an instance of the Math.Operation class. As a matter of style,
a domain is required for object creation.
</summary>
<param name="domain">
The "DomainType" domain of this mathematical operation.
</param>
</member>
<member name="T:DTS.Utilities.NaturalStringComparer">
<summary>
this is a class for doing natural string compares like in explorer (using the explorer function)
http://msdn.microsoft.com/en-us/library/bb759947%28VS.85%29.aspx
</summary>
<remarks>requires XP or greater</remarks>
</member>
<member name="M:DTS.Utilities.NaturalStringComparer.Compare(System.String,System.String)">
<summary>
do a natural string compare between two strings
</summary>
<param name="x">left string to compare</param>
<param name="y">right string to compare</param>
<returns>-1 if natural order of x is less than y, +1 if x is after y, 0 if they are equal</returns>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty">
<summary>
A class to implement self-checking, on-error-auto-syntax-building
power of 2 int properties.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty.IsValidValue(System.Int32)">
<summary>
Determine whether or not the specified value is valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be validity checked.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the value is valid; false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty.IsPowerOf2(System.Int32)">
<summary>
Determine whether or not the specified value is a power of two.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be power of 2-checked.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the value is a power of 2, false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty.GetInvalidValueDescription(System.Int32)">
<summary>
Generate a user-readable explanation as to why the specified value is
not valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be described.
</param>
<returns>
A <see cref="T:System.String"/> description explaining why the specified value
is not valid for this property.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty.#ctor(System.Int32)">
<summary>
Initialize an instance of a power of two int property.
</summary>
<param name="initialValue">
The initialize <see cref="T:System.Int32"/> value of the int property.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.PowerOfTwoIntProperty.#ctor">
<summary>
Initialize an instance of a power of two int property.
</summary>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.Property`1">
<summary>
A class to implement self-checking, on-error-auto-syntax-building properties.
</summary>
<typeparam name="Type">
The property type.
</typeparam>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.Property`1.ConstructionException">
<summary>
A class representation for property construction exceptions.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.ConstructionException.#ctor">
<summary>
Initialize an instance of the Property.ConstructionException class.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.ConstructionException.#ctor(System.String)">
<summary>
Initialize an instance of the Property.ConstructionException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.ConstructionException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the Property.ConstructionException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.Property`1.Value">
<summary>
value of the property
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.IsValidValue(`0)">
<summary>
Determine whether or not the specified value is valid for this property.
</summary>
<param name="value">
The value to be validity checked.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the value is valid; false otherwise.
</returns>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.Property`1.IsInitialized">
<summary>
Get <see cref="T:System.Boolean"/> initialization status for this property.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.UnInitialize">
<summary>
"Deinitialize" this property.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.GetInvalidValueDescription(`0)">
<summary>
Generate a user-readable explanation as to why the specified value is
not valid for this property.
</summary>
<param name="value">
The value to be described.
</param>
<returns>
A <see cref="T:System.String"/> description explaining why the specified value
is not valid for this property.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.#ctor(System.String,`0,System.Boolean)">
<summary>
Initialize an instance of the Property class.
</summary>
<param name="name">
The name of the property this implementation is standing in for, so that
error messages will be more informative. If a null name is passed,
</param>
<param name="initialValue">
The initial value of the property. Can be read if the property is almost
marked as "initialized".
</param>
<param name="isInitialized">
A <see cref="T:System.Boolean"/> switch that determines whether or not the property
is to be considered initialized immediately after instantiation.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.#ctor(`0,System.Boolean)">
<summary>
Initialize an instance of the Property class.
</summary>
<param name="initialValue">
The initial value of the property. Can be read if the property is almost
marked as "initialized".
</param>
<param name="isInitialized">
A <see cref="T:System.Boolean"/> switch that determines whether or not the property
is to be considered initialized immediately after instantiation.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.ToString">
<summary>
Generate user-readable string for this object.
</summary>
<returns>
A <see cref="T:System.String"/> representing the current state of the object.
</returns>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.Property`1.InvalidValueException">
<summary>
A class representation for invalid property value exceptions.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.InvalidValueException.#ctor">
<summary>
Initialize an instance of the Property.InvalidValueException class.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.InvalidValueException.#ctor(System.String)">
<summary>
Initialize an instance of the Property.InvalidValueException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.InvalidValueException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the Property.InvalidValueException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.Property`1.NotInitializedException">
<summary>
A class representation for property value not initialized exceptions.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.NotInitializedException.#ctor">
<summary>
Initialize an instance of the Property.NotInitializedException class.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.NotInitializedException.#ctor(System.String)">
<summary>
Initialize an instance of the Property.NotInitializedException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.Property`1.NotInitializedException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the Property.NotInitializedException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty">
<summary>
A class to implement self-checking, on-error-auto-syntax-building
range-restricted int properties.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.IsValidValue(System.Double)">
<summary>
Determine whether or not the specified value is valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Double"/> value to be validity checked.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the value is valid; false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.GetInvalidValueDescription(System.Int32)">
<summary>
Generate a user-readable explanation as to why the specified value is
not valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be described.
</param>
<returns>
A <see cref="T:System.String"/> description explaining why the specified value
is not valid for this property.
</returns>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.MinimumValue">
<summary>
The minimum <see cref="T:System.Double"/> value permitted in this property.
</summary>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.MaximumValue">
<summary>
The maximum <see cref="T:System.Double"/> value permitted in this property.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.#ctor(System.Double,System.Double,System.Double,System.Boolean)">
<summary>
Initialize an instance of a range-restricted integer property.
</summary>
<param name="minimumValue">
The minimum <see cref="T:System.Int32"/> value permitted in this property.
</param>
<param name="maximumValue">
The maximum <see cref="T:System.Int32"/> value permitted in this property.
</param>
<param name="initialValue">
The initial <see cref="T:System.Int32"/> value of this property.
</param>
<param name="isInitialized">
<see cref="T:System.Boolean"/> true if this property is to be considered
initialized after construction, false otherwise.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.#ctor(System.Double,System.Double)">
<summary>
Initialize an instance of a range-restricted integer property.
</summary>
<param name="minimumValue">
The minimum <see cref="T:System.Double"/> value permitted in this property.
</param>
<param name="maximumValue">
The maximum <see cref="T:System.Double"/> value permitted in this property.
</param>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.InvalidRangeException">
<summary>
A class representation for range-restricted integer property
range exceptions.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.InvalidRangeException.#ctor">
<summary>
Initialize an instance of the
RangeRestrictedDoubleProperty.InvalidRangeException class.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.InvalidRangeException.#ctor(System.String)">
<summary>
Initialize an instance of the
RangeRestrictedDoubleProperty.InvalidRangeException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedDoubleProperty.InvalidRangeException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
RangeRestrictedDoubleProperty.InvalidRangeException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty">
<summary>
A class to implement self-checking, on-error-auto-syntax-building
range-restricted int properties.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.IsValidValue(System.Int32)">
<summary>
Determine whether or not the specified value is valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be validity checked.
</param>
<returns>
<see cref="T:System.Boolean"/> true if the value is valid; false otherwise.
</returns>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.GetInvalidValueDescription(System.Int32)">
<summary>
Generate a user-readable explanation as to why the specified value is
not valid for this property.
</summary>
<param name="value">
The <see cref="T:System.Int32"/> value to be described.
</param>
<returns>
A <see cref="T:System.String"/> description explaining why the specified value
is not valid for this property.
</returns>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.MinimumValue">
<summary>
The minimum <see cref="T:System.Int32"/> value permitted in this property.
</summary>
</member>
<member name="P:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.MaximumValue">
<summary>
The maximum <see cref="T:System.Int32"/> value permitted in this property.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.#ctor(System.Int32,System.Int32,System.Int32,System.Boolean)">
<summary>
Initialize an instance of a range-restricted integer property.
</summary>
<param name="minimumValue">
The minimum <see cref="T:System.Int32"/> value permitted in this property.
</param>
<param name="maximumValue">
The maximum <see cref="T:System.Int32"/> value permitted in this property.
</param>
<param name="initialValue">
The initial <see cref="T:System.Int32"/> value of this property.
</param>
<param name="isInitialized">
<see cref="T:System.Boolean"/> true if this property is to be considered
initialized after construction, false otherwise.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.#ctor(System.Int32,System.Int32)">
<summary>
Initialize an instance of a range-restricted integer property.
</summary>
<param name="minimumValue">
The minimum <see cref="T:System.Int32"/> value permitted in this property.
</param>
<param name="maximumValue">
The maximum <see cref="T:System.Int32"/> value permitted in this property.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.#ctor(System.Int32)">
<summary>
Initialize an instance of a range-restricted integer property.
</summary>
<param name="initialValue">
This initial <see cref="T:System.Int32"/> value of the property.
</param>
</member>
<member name="T:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.InvalidRangeException">
<summary>
A class representation for range-restricted integer property
range exceptions.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.InvalidRangeException.#ctor">
<summary>
Initialize an instance of the
RangeRestrictedIntProperty.InvalidRangeException class.
</summary>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.InvalidRangeException.#ctor(System.String)">
<summary>
Initialize an instance of the
RangeRestrictedIntProperty.InvalidRangeException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
</member>
<member name="M:DTS.Utilities.DotNetProgrammingConstructs.RangeRestrictedIntProperty.InvalidRangeException.#ctor(System.String,System.Exception)">
<summary>
Initialize an instance of the
RangeRestrictedIntProperty.InvalidRangeException class.
</summary>
<param name="msg">
The <see cref="T:System.String"/> message describing this exception instance.
</param>
<param name="innerEx">
The inner <see cref="T:System.Exception"/> behind this enclosing
exception instance.
</param>
</member>
<member name="T:DTS.Utilities.Properties.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_DateTime_Format">
<summary>
Looks up a localized string similar to yyyy-MM-dd HH:mm:ss.fff.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_ExceptionFormatter_ExceptionOfTypeOccurredString">
<summary>
Looks up a localized string similar to {0}An {1}exception of type: {2} occurred.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_ExceptionFormatter_InnerIndicationString">
<summary>
Looks up a localized string similar to inner .
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_ExceptionFormatter_NonInnerIndicationString">
<summary>
Looks up a localized string similar to .
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_ExceptionMessageDisplayString">
<summary>
Looks up a localized string similar to {0}Message: {1}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_LevelSeperatorString">
<summary>
Looks up a localized string similar to === .
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_LogEntrySeperatorString">
<summary>
Looks up a localized string similar to ========================================.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_LogException_NullWriterDelegateString">
<summary>
Looks up a localized string similar to APILogger.LogException: Writer delegate is null.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_ModuleNameDisplayString">
<summary>
Looks up a localized string similar to {0}Module: {1}, Name: {2}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_NullWriterDelegateString">
<summary>
Looks up a localized string similar to APILogger.LogString: Writer delegate is null.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.APILogging_StackTraceDisplayString">
<summary>
Looks up a localized string similar to {0}StackTrace: {1}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_AttributeCoder_NullAttributeValueExtractionMethodReferenceString">
<summary>
Looks up a localized string similar to cannot use null attribute value extraction method reference.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_DecodeAttributeExceptionString">
<summary>
Looks up a localized string similar to encountered problem decoding attribute value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_DecodeAttributesExceptionString">
<summary>
Looks up a localized string similar to encountered problem decoding attribute values.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_DehashAttributeValue_DehashAttributeValueExceptionString">
<summary>
Looks up a localized string similar to encountered problem dehashing attribute value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_DehashAttributeValue_UnableToMatchAttributeValueWithTargetString">
<summary>
Looks up a localized string similar to unable to match attribute value with an actual target type.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_EncodeAttributeExceptionString">
<summary>
Looks up a localized string similar to encountered problem encoding attribute value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_NoTypeAttributesFoundOnTargetString">
<summary>
Looks up a localized string similar to no attributes of specified type found on designated target.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.AttributeCoder_UnableToFindTargetTypeMappingString">
<summary>
Looks up a localized string similar to unable to find unique target type mapping for the specified attribute value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Exceptional_GenerateMessageFromExceptionTree_BecauseString">
<summary>
Looks up a localized string similar to because.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Exceptional_GenerateMessageFromExceptionTree_EndsWithFormatString">
<summary>
Looks up a localized string similar to {0}{1}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Exceptional_GenerateMessageFromExceptionTree_ErrorTextTerminatorString">
<summary>
Looks up a localized string similar to ..
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Exceptional_GenerateMessageFromExceptionTree_MessageFormatString">
<summary>
Looks up a localized string similar to {0}{1}{2}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Generic_EncounteredProblemConstructingClassString">
<summary>
Looks up a localized string similar to encountered problem constructing {0}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Generic_NullIndicatorString">
<summary>
Looks up a localized string similar to &lt;null&gt;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.PowerOfTwoProperty_GetInvalidValueDescription_ProposedValueIsNotPowerOf2String">
<summary>
Looks up a localized string similar to proposed value &quot;{0}&quot; is not a power of two.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.PowerOfTwoProperty_GetInvalidValueDescription_UnableToGetDescriptionString">
<summary>
Looks up a localized string similar to encountered problem getting invalid value description.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.PowerOfTwoProperty_IsPowerOf2_UnableToDeterminePowerOf2nessString">
<summary>
Looks up a localized string similar to encountered problem determining whether or not &quot;{0}&quot; is a power of two.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.PowerOfTwoProperty_IsValidValue_UnableToDetermineValidityString">
<summary>
Looks up a localized string similar to encountered problem determing power of two-validity of &quot;{0} &quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Property_GetInvalidValueDescription_CouldNotSetToValueString">
<summary>
Looks up a localized string similar to property {0}cannot be set to {1}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Property_GetInvalidValueDescription_GetDescriptionFailedString">
<summary>
Looks up a localized string similar to encountered problem generating invalid valid description.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Property_Value_CouldNotGetValueString">
<summary>
Looks up a localized string similar to encountered problem getting property {0}value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Property_Value_CouldNotSetValueString">
<summary>
Looks up a localized string similar to encountered problem setting property {0}value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.Property_Value_NotInitializedString">
<summary>
Looks up a localized string similar to property has not been initialized.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_GetInvalidValueDescription_GetDescriptionFailedString">
<summary>
Looks up a localized string similar to encountered problem generating invalid value description for value &quot;{0}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_GetInvalidValueDescription_MaximumDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is greater than the maximum allowable value of &quot;{1}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_GetInvalidValueDescription_MinimumDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is less than the minimum allowable value of &quot;{1}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_GetInvalidValueDescription_ValidValueDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is valid.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_IsValidValue_UnableToDetermineValidityString">
<summary>
Looks up a localized string similar to encountered problem determing range-restricted validity of &quot;{0}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_MaximumValue_GetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem getting maximum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_MaximumValue_SetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem setting maximum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_MinimumValue_GetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem getting minimum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_MinimumValue_SetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem setting minimum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedDoubleProperty_MinMustBeLessThanMaxString">
<summary>
Looks up a localized string similar to minimum value ({0}) must be less than or equal to maximum value ({1}).
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_GetInvalidValueDescription_GetDescriptionFailedString">
<summary>
Looks up a localized string similar to encountered problem generating invalid value description for value &quot;{0}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_GetInvalidValueDescription_MaximumDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is greater than the maximum allowable value of &quot;{1}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_GetInvalidValueDescription_MinimumDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is less than the minimum allowable value of &quot;{1}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_GetInvalidValueDescription_ValidValueDescriptionString">
<summary>
Looks up a localized string similar to the specified value &quot;{0}&quot; is valid.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_IsValidValue_UnableToDetermineValidityString">
<summary>
Looks up a localized string similar to encountered problem determing range-restricted validity of &quot;{0}&quot;.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_MaximumValue_GetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem getting maximum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_MaximumValue_SetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem setting maximum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_MinimumValue_GetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem getting minimum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_MinimumValue_SetValueFailedString">
<summary>
Looks up a localized string similar to encountered problem setting minimum range value.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.RangeRestrictedIntProperty_MinMustBeLessThanMaxString">
<summary>
Looks up a localized string similar to minimum value ({0}) must be less than or equal to maximum value ({1}).
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_AddMessage_LoggerNotRunningString">
<summary>
Looks up a localized string similar to TextLogger.AddMessage: Logger is not running, call Start first.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Dispose_WriteThreadExitFailureString">
<summary>
Looks up a localized string similar to TextLogger.dtor: Writing thread didn&apos;t go to Exited state, it&apos;s in {0}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Dispose_WriteThreadResponseTimeoutString">
<summary>
Looks up a localized string similar to TextLogger.dtor: Writing thread didn&apos;t respond in time.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Start_LoggerAlreadyRunningString">
<summary>
Looks up a localized string similar to TextLogger.AddMessage: Logger is already running, call Stop first.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Start_NullEmptyFilenameString">
<summary>
Looks up a localized string similar to TextLogger.Start: filename can&apos;t be null or blank.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Start_NullEmptyFolderString">
<summary>
Looks up a localized string similar to TextLogger.Start: folder can&apos;t be null or blank.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Start_WriteThreadResponseTimeoutString">
<summary>
Looks up a localized string similar to TextLogger.Start: Writing thread didn&apos;t respond in time.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Start_WriteThreadStartFailureString">
<summary>
Looks up a localized string similar to TextLogger.Start: Writing thread didn&apos;t go to Started state, it&apos;s in {0}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Stop_LoggerNotRunningString">
<summary>
Looks up a localized string similar to TextLogger.Stop: Logger is not running, call Start first.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Stop_WriteThreadResponseTimeoutString">
<summary>
Looks up a localized string similar to TextLogger.Stop: Writing thread didn&apos;t respond in time.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Stop_WriteThreadStopFailureString">
<summary>
Looks up a localized string similar to TextLogger.Stop: Writing thread didn&apos;t go to Stopped state, it&apos;s in {0}.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_TextLogger_EnqueueWriterFailureString">
<summary>
Looks up a localized string similar to TextLogger: Can&apos;t enqueue Writer.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_TextLogger_NullCallbackString">
<summary>
Looks up a localized string similar to TextLogger: Callback can&apos;t be null.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_TextLogger_WriteThreadStartTimeoutString">
<summary>
Looks up a localized string similar to TextLogger.ctor: Writing thread didn&apos;t start in time.
</summary>
</member>
<member name="P:DTS.Utilities.Properties.Resources.TextLogger_Writer_InvalidCommandString">
<summary>
Looks up a localized string similar to TextLogger.Writer: invalid command {0}.
</summary>
</member>
<member name="T:DTS.Utilities.ScrollingMessageBox">
<summary>
Crude form for displaying modal yes/no dialog queries.
</summary>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.#ctor(System.String,System.String)">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.ScrollingMessageBox"/> class.
</summary>
<param name="message">
The message <see cref="T:System.String"/> to be displayed in the dialog's scroll-enabled
text field. Note that it does not recognize "\n" as newline; rather use
Environmenet.Newline.
</param>
<param name="caption">
The caption <see cref="T:System.String"/> for the dialog.
</param>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.#ctor(System.String,System.String,System.Drawing.Icon)">
<summary>
Initialize an instance of the <see cref="T:DTS.Utilities.ScrollingMessageBox"/> class.
</summary>
<param name="message">
The message <see cref="T:System.String"/> to be displayed in the dialog's scroll-enabled
text field. Note that it does not recognize "\n" as newline; rather use
Environmenet.Newline.
</param>
<param name="caption">
The caption <see cref="T:System.String"/> for the dialog.
</param>
<param name="ico">icon</param> for the dialog
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.ScrollingMessageBox_KeyDown(System.Object,System.Windows.Forms.KeyEventArgs)">
<summary>
handle the key down for yes and no
note - this isn't i18N'd, so the keycodes might need to change whenever we do change this
from just "yes", "no"
</summary>
<param name="sender"></param>
<param name="e"></param>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.YesButton_Click(System.Object,System.EventArgs)">
<summary>
Handler for YesButton click events.
</summary>
<param name="sender">
The <see cref="T:System.Object"/> responsible for generating this event.
</param>
<param name="e">
The <see cref="T:System.EventArgs"/> for this event.
</param>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.NoButton_Click(System.Object,System.EventArgs)">
<summary>
Handler for NoButton click events.
</summary>
<param name="sender">
The <see cref="T:System.Object"/> responsible for generating this event.
</param>
<param name="e">
The <see cref="T:System.EventArgs"/> for this event.
</param>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.YesButtonClick">
<summary>
do yes
</summary>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.NoButtonClick">
<summary>
do no
</summary>
</member>
<member name="F:DTS.Utilities.ScrollingMessageBox.components">
<summary>
Required designer variable.
</summary>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.Dispose(System.Boolean)">
<summary>
Clean up any resources being used.
</summary>
<param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
</member>
<member name="M:DTS.Utilities.ScrollingMessageBox.InitializeComponent">
<summary>
Required method for Designer support - do not modify
the contents of this method with the code editor.
</summary>
</member>
<member name="M:DTS.Utilities.SignalToNoiseRatio.CalculateSNR(System.Collections.Generic.IEnumerable{System.Double},System.Double)">
<summary>
Calculates Noise given a full scale peak-to-peak
</summary>
<param name="values">Data set</param>
<param name="fullScalePP">The full scale peak-to-peak of the data set; 65536.0 by default for ADC data</param>
<returns></returns>
</member>
<member name="M:DTS.Utilities.UpdateNotifyingList`1.#ctor">
<summary>
Initialize an instance of the UpdateNotifyingList class.
</summary>
</member>
<member name="P:DTS.Utilities.UpdateNotifyingList`1.Items">
<summary>
Get/set the notification-bound items in this list.
</summary>
</member>
<member name="T:DTS.Utilities.UpdateNotifyingList`1.OnUpdateCallback">
<summary>
Callback method to be invoked whenever the notifying list is updated.
</summary>
<param name="updatedContents">
The updated contents of the notifying list.
</param>
</member>
<member name="E:DTS.Utilities.UpdateNotifyingList`1.OnUpdate">
<summary>
Subscribers to be notified whenever this list is changed.
</summary>
</member>
<member name="T:DTS.Utilities.WaitWithCondition">
<summary>
this is a class to simplify waiting for a resource
it can wait for a specified period and also check another signal or condition
</summary>
</member>
<member name="F:DTS.Utilities.WaitWithCondition.EachWaitMilliSec">
<summary>
the max time to wait in any spin cycle
</summary>
<remarks>this should probably be private and never modified as it will affect all
waitwithcondition instances.
if a wait condition is created with a 1000 millisecond wait period, and the EachWaitMilliSec
was 20, we would wait for 50 cycles of 20ms before our final timeout
</remarks>
</member>
<member name="T:DTS.Utilities.WaitWithCondition.Condition">
<summary>
optional function to check while waiting for handle to return.
</summary>
<returns>bool if condition has been met, false otherwise</returns>
</member>
<member name="T:DTS.Utilities.WaitWithCondition.ConditionMetException">
<summary>
this exception is used to indicate a condition was met to the calling code
</summary>
</member>
<member name="M:DTS.Utilities.WaitWithCondition.Wait(System.Threading.WaitHandle,System.Int32,DTS.Utilities.WaitWithCondition.Condition)">
<summary>
wait for a resource to be available
</summary>
<param name="handle"><see cref="T:System.Threading.WaitHandle" /> object to wait on</param>
<param name="toMilliSec">max amount of time in milliseconds to wait
use <see cref="F:System.Threading.Timeout.Infinite" /> to wait for the max amount of time
allowed.
</param>
<param name="condition">an additional condition to check. Can be null.
if condition is met before resource is available a <see cref="T:DTS.Utilities.WaitWithCondition.ConditionMetException" />
is thrown.
</param>
<returns>true indicates the <see cref="T:System.Threading.WaitHandle" /> object has returned within
the requested time period, false otherwise
</returns>
</member>
<member name="T:DTS.Utilities.Xml.PropertyAttributeDecoder`1">
<summary>
A tool for decoding XmlSerializationTag
</summary>
<typeparam name="T">
The type of the property container, class-constrained.
</typeparam>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.#ctor(`0)">
<summary>
Initialize an instance of the DTS.Utilities.Xml.PropertyAttributeDecoder class.
</summary>
<param name="propertyContainer">
The <see cref="T:System.Object"/> containing the properties to be decoded.
</param>
</member>
<member name="P:DTS.Utilities.Xml.PropertyAttributeDecoder`1.PropertyContainer">
<summary>
Get the object containing the properties to be decoded by this class instance.
</summary>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.ExtractBoolProperty(System.String,System.Xml.XmlReader)">
<summary>
Extract the specified boolean attribute property value from the decoder's
bound object.
</summary>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be extracted.
</param>
<param name="reader">
The <see cref="T:System.Xml.XmlReader"/> the property value is to be decoded from.
</param>
<returns>
The specified <see cref="T:System.Boolean"/> value.
</returns>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.ExtractIntProperty(System.String,System.Xml.XmlReader)">
<summary>
Extract the specified int attribute property value from the decoder's
bound object.
</summary>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be extracted.
</param>
<param name="reader">
The <see cref="T:System.Xml.XmlReader"/> the property value is to be decoded from.
</param>
<returns>
The specified <see cref="T:System.Int32"/> value.
</returns>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.ExtractDoubleProperty(System.String,System.Xml.XmlReader)">
<summary>
Extract the specified double attribute property value from the decoder's
bound object.
</summary>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be extracted.
</param>
<param name="reader">
The <see cref="T:System.Xml.XmlReader"/> the property value is to be decoded from.
</param>
<returns>
The specified <see cref="T:System.Double"/> value.
</returns>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.ExtractStringProperty(System.String,System.Xml.XmlReader)">
<summary>
Extract the specified string attribute property value from the decoder's
bound object.
</summary>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be extracted.
</param>
<param name="reader">
The <see cref="T:System.Xml.XmlReader"/> the property value is to be decoded from.
</param>
<returns>
The specified <see cref="T:System.String"/> value.
</returns>
</member>
<member name="M:DTS.Utilities.Xml.PropertyAttributeDecoder`1.ExtractEnumProperty(System.String,System.Type,System.Xml.XmlReader)">
<summary>
Extract the specified enum attribute property value from the decoder's
bound object.
</summary>
<param name="propertyName">
The <see cref="T:System.String"/> name of the property to be extracted.
</param>
<param name="reader">
The <see cref="T:System.Xml.XmlReader"/> the property value is to be decoded from.
</param>
<param name="enumType">the Enumeration that the enum value belongs to</param>
<returns>
The specified enum value.
</returns>
</member>
<member name="T:DTS.Utilities.Xml.XmlSerializationTagAttribute">
<summary>
Attribute for specifying the XML serialization tag for the attached
object member entity.
</summary>
</member>
<member name="P:DTS.Utilities.Xml.XmlSerializationTagAttribute.Value">
<summary>
Get the <see cref="T:System.String"/> value of this tag attribute.
</summary>
</member>
<member name="P:DTS.Utilities.Xml.XmlSerializationTagAttribute.Order">
<summary>
Get the <see cref="T:System.Int32"/> order of the tag attribute. This will be used in sorting
the like-tag attributes attached to the same object.
</summary>
</member>
<member name="M:DTS.Utilities.Xml.XmlSerializationTagAttribute.#ctor(System.String)">
<summary>
Initialize an instance of the XmlSerializationTagAttribute class.
</summary>
<param name="value">
The <see cref="T:System.String"/> value of this attribute.
</param>
</member>
<member name="M:DTS.Utilities.Xml.XmlSerializationTagAttribute.#ctor(System.String,System.Int32)">
<summary>
Initialize an instance of the XmlSerializationTagAttribute class.
</summary>
<param name="value">
The <see cref="T:System.String"/> value of this attribute.
</param>
<param name="order">
The <see cref="T:System.Int32"/> order of this attribute. This will be used in sorting
the like-tag attributes attached to the same object.
</param>
</member>
<member name="M:DTS.Utilities.Xml.XmlSerializationTagAttribute.CompareTo(DTS.Utilities.Xml.XmlSerializationTagAttribute)">
<summary>
Compare this object to the one specified.
</summary>
<param name="that">The <see cref="T:DTS.Utilities.Xml.XmlSerializationTagAttribute"/>
tag to compare to</param>
<returns></returns>
</member>
</members>
</doc>
Reference in New Issue View Git Blame Copy Permalink