FileBlockReader Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
      FileAdaptersFileBlockReader

public class FileBlockReader : FacileActionAdapterBase

Public Class FileBlockReader
	Inherits FacileActionAdapterBase

public ref class FileBlockReader : public FacileActionAdapterBase

type FileBlockReader = 
    class
        inherit FacileActionAdapterBase
    end

FileAdapters.FileBlockReader = function();

Type.createClass(
	'FileAdapters.FileBlockReader',
	GSF.TimeSeries.Adapters.FacileActionAdapterBase);

View Source

	Name	Description
	FileBlockReader	Creates a new instance of the FileBlockReader class.

Top

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	BlockSize	Gets or sets the size of each block of data that is read from the file.
	BlockSizeAdjustment	Gets or sets the percentage of adjustment to be applied to the buffer size when throttling buffer blocks.
	ConnectionInfo	Gets connection info for adapter, if any. (Inherited from AdapterBase)
	ConnectionString	Gets or sets key/value pair connection information specific to this AdapterBase. (Inherited from AdapterBase)
	DataSource	Gets or sets DataSet based data source available to this AdapterBase. (Inherited from AdapterBase)
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	FallBackOnLocalClock	Gets or sets flag that determines whether to fall back on local clock time as real time when time is unreasonable. (Inherited from FacileActionAdapterBase)
	FilePattern	Gets or sets the pattern used to match file that appear in the watch folder.
	FramesPerSecond	Gets or sets the frames per second to be used by the FacileActionAdapterBase.
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	InitializationTimeout	Gets or sets maximum time system will wait during Start for initialization. (Inherited from AdapterBase)
	Initialized	Gets or sets flag indicating if the adapter has been initialized successfully. (Inherited from AdapterBase)
	InputMeasurementKeys	Gets or sets primary keys of input measurements the FileBlockReader expects, if any. (Overrides FacileActionAdapterBaseInputMeasurementKeys)
	InputSourceIDs	Gets or sets Source values used to filter input measurement keys. (Inherited from FacileActionAdapterBase)
	IsDisposed	Gets a flag that indicates whether the object has been disposed. (Inherited from AdapterBase)
	LagTime	Gets or sets the allowed past time deviation tolerance, in seconds (can be sub-second).
	LatestMeasurements	Gets reference to the collection of absolute latest received measurement values. (Inherited from FacileActionAdapterBase)
	LeadTime	Gets or sets the allowed future time deviation tolerance, in seconds (can be sub-second).
	Log	Log messages generated by an adapter. (Inherited from AdapterBase)
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from AdapterBase)
	OutputSourceIDs	Gets or sets Source values used to filter output measurements. (Inherited from FacileActionAdapterBase)
	ProcessedMeasurements	Gets the total number of measurements handled thus far by the AdapterBase. (Inherited from AdapterBase)
	ProcessingInterval	Gets or sets the desired processing interval, in milliseconds, for the adapter. (Inherited from AdapterBase)
	ProcessInterval	Gets or sets the amount of time, in seconds, between each publication of a block of data from the active file.
	ProcessIntervalAdjustment	Gets or sets the percentage of adjustment to be applied to the process interval when throttling buffer blocks.
	RealTime	Gets the most accurate time value that is available. If UseLocalClockAsRealTime = true, then this function will return UtcNow. Otherwise, this function will return the timestamp of the most recent measurement. (Inherited from FacileActionAdapterBase)
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from FacileActionAdapterBase)
	RequestedOutputMeasurementKeys	Gets or sets output measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from FacileActionAdapterBase)
	RespectInputDemands	Gets or sets flag indicating if action adapter should respect auto-start requests based on input demands. (Inherited from FacileActionAdapterBase)
	RespectOutputDemands	Gets or sets flag indicating if action adapter should respect auto-start requests based on output demands. (Inherited from FacileActionAdapterBase)
	RetransmissionStat	Gets or sets the statistic that defines the number of buffer block retransmissions in the system.
	RetransmissionThreshold	Gets or sets the percentage of buffer blocks that can be retransmitted during a reporting interval before the FileBlockReader begins throttling its buffer blocks.
	RunTime	Gets the total amount of time, in seconds, that the adapter has been active. (Inherited from AdapterBase)
	Settings	Gets settings DictionaryTKey, TValue parsed when ConnectionString was assigned. (Inherited from AdapterBase)
	StartTime	Gets the UTC time this AdapterBase was started. (Inherited from AdapterBase)
	StartTimeConstraint	Gets the start time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	Status	Returns the detailed status of the data input source. (Inherited from FacileActionAdapterBase)
	StopTime	Gets the UTC time this AdapterBase was stopped. (Inherited from AdapterBase)
	StopTimeConstraint	Gets the stop time temporal processing constraint defined by call to SetTemporalConstraint(String, String, String). (Inherited from AdapterBase)
	SupportsTemporalProcessing	Gets the flag indicating if this adapter supports temporal processing. (Overrides AdapterBaseSupportsTemporalProcessing)
	TrackLatestMeasurements	Gets or sets flag to start tracking the absolute latest received measurement values. (Inherited from FacileActionAdapterBase)
	UseLocalClockAsRealTime	Gets or sets flag that determines whether or not to use the local clock time as real time. (Inherited from FacileActionAdapterBase)
	WatchDirectory	Gets or sets the path to the directory to be watched for files.
	WatchInterval	Gets or sets the amount of time, in seconds, between each scan of the watch folder.

Top

	Name	Description
	ClearProcessedFileList	Empties the processed file list.
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the FileBlockReader object and optionally releases the managed resources. (Overrides AdapterBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Gets a short one-line status of this FileBlockReader. (Overrides AdapterBaseGetShortStatus(Int32))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	IncrementProcessedMeasurements	Safely increments the total processed measurements. (Inherited from AdapterBase)
	Initialize	Initializes FileBlockReader. (Overrides FacileActionAdapterBaseInitialize)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnDiscardingMeasurements	Raises the DiscardingMeasurements event. (Inherited from FacileActionAdapterBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	OnNewMeasurements	Raises the NewMeasurements event. (Inherited from FacileActionAdapterBase)
	OnOutputMeasurementsUpdated	Raises OutputMeasurementsUpdated event. (Inherited from AdapterBase)
	OnProcessException(Exception)	Obsolete. Raises the ProcessException event. (Inherited from AdapterBase)
	OnProcessException(MessageLevel, Exception, String, MessageFlags)	Raises the ProcessException event. (Inherited from AdapterBase)
	OnStatusMessage(String)	Obsolete. Raises the StatusMessage event. (Inherited from AdapterBase)
	OnStatusMessage(String, Object)	Obsolete. Raises the StatusMessage event with a formatted status message. (Inherited from AdapterBase)
	OnStatusMessage(MessageLevel, String, String, MessageFlags)	Raises the StatusMessage event and sends this data to the Logger. (Inherited from AdapterBase)
	OnUnpublishedSamples	Raises the UnpublishedSamples event. (Inherited from FacileActionAdapterBase)
	QueueMeasurementForProcessing	Queues a single measurement for processing. (Inherited from FacileActionAdapterBase)
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. (Overrides FacileActionAdapterBaseQueueMeasurementsForProcessing(IEnumerableIMeasurement))
	SetInitializedState	Manually sets the initialized state of the AdapterBase. (Inherited from AdapterBase)
	SetTemporalConstraint	Defines a temporal processing constraint for the adapter. (Inherited from AdapterBase)
	Start	Starts the FileBlockReader or restarts it if it is already running. (Overrides AdapterBaseStart)
	Stop	Stops the FileBlockReader. (Overrides AdapterBaseStop)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

	Name	Description
	ConfigurationChanged	Event is raised when adapter is aware of a configuration change. (Inherited from AdapterBase)
	DiscardingMeasurements	This event is raised if there are any measurements being discarded during the sorting process. (Inherited from FacileActionAdapterBase)
	Disposed	Event is raised when AdapterBase is disposed. (Inherited from AdapterBase)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated. (Inherited from AdapterBase)
	NewMeasurements	Provides new measurements from action adapter. (Inherited from FacileActionAdapterBase)
	OutputMeasurementsUpdated	Event is raised when OutputMeasurements are updated. (Inherited from AdapterBase)
	ProcessException	Event is raised when there is an exception encountered while processing. (Inherited from AdapterBase)
	StatusMessage	Provides status messages to consumer. (Inherited from AdapterBase)
	UnpublishedSamples	This event is raised by derived class, if needed, to track current number of unpublished seconds of data in the queue. (Inherited from FacileActionAdapterBase)

Top

	Name	Description
	DefaultBlockSize	Default value for BlockSize.
	DefaultBlockSizeAdjustment	Default value for BlockSizeAdjustment.
	DefaultFilePattern	Default value for FilePattern.
	DefaultProcessInterval	Default value for ProcessInterval.
	DefaultProcessIntervalAdjustment	Default value for ProcessIntervalAdjustment.
	DefaultRetransmissionThreshold	Default value for RetransmissionThreshold.
	DefaultWatchInterval	Default value for WatchInterval.

Top

Reference

FileAdapters Namespace