CsvExportAdapter Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersOutputAdapterBase
      CsvAdaptersCsvExportAdapter

public class CsvExportAdapter : OutputAdapterBase

Public Class CsvExportAdapter
	Inherits OutputAdapterBase

public ref class CsvExportAdapter : public OutputAdapterBase

type CsvExportAdapter = 
    class
        inherit OutputAdapterBase
    end

CsvAdapters.CsvExportAdapter = function();

Type.createClass(
	'CsvAdapters.CsvExportAdapter',
	GSF.TimeSeries.Adapters.OutputAdapterBase);

View Source

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

Top

	Name	Description
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	ConnectionAttemptInterval	Gets or sets the connection attempt interval, in milliseconds, for the data output adapter. (Inherited from OutputAdapterBase)
	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 OutputAdapterBase. (Inherited from OutputAdapterBase)
	DownsampleInterval	Gets or sets the downsampling interval, in seconds, set to zero for no downsampling.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	EnableTimeReasonabilityValidation	Gets or sets the flag that determines if timestamps should be validated against local clock for reasonability.
	ExportPath	Gets or sets the path to the directory where CSV exports are written.
	FileNameTemplate	Gets or sets the CSV export filename template. String format parameter 0 is current UTC time.
	FramesPerSecond	Gets or sets the number of frames per second for incoming data used to align timestamps when downsampling interval is greater than 0.0, set to zero to skip time alignment.
	HeaderLine	Gets or sets the default header line for the CSV exports, set to empty string for no header. Column order is fixed as timestamp, ID, and value.
	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 AdapterBase expects, if any. (Inherited from AdapterBase)
	InputSourceIDs	Gets or sets Source values used to filter input measurements. (Inherited from OutputAdapterBase)
	InternalProcessQueue	Allows derived class access to internal processing queue. (Inherited from OutputAdapterBase)
	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 against local clock for time reasonability validation, in seconds (can be sub-second).
	LeadTime	Gets or sets the allowed future time deviation tolerance against local clock for time reasonability validation, 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)
	MetadataRefreshOperation	Gets the operation that calls ExecuteMetadataRefresh. (Inherited from OutputAdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OffloadPath	Gets or sets the path to the directory where CSV exports are moved after a rollover.
	OutputIsForArchive	Gets the flag that determines if measurements sent to this CsvExportAdapter are destined for archival. (Overrides OutputAdapterBaseOutputIsForArchive)
	OutputMeasurements	Gets or sets output measurements that the AdapterBase will produce, if any. (Inherited from OutputAdapterBase)
	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 output adapter. (Inherited from OutputAdapterBase)
	RequestedInputMeasurementKeys	Gets or sets input measurement keys that are requested by other adapters based on what adapter says it can provide. (Inherited from OutputAdapterBase)
	RequeueOnException	Gets or sets whether or not to automatically place measurements back into the processing queue if an exception occurs while processing. Defaults to false. (Inherited from OutputAdapterBase)
	RolloverSchedule	Gets or sets the schedule, defined by cron syntax, to determine how often to roll over CSV files.
	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	Gets the status of this CsvExportAdapter. (Overrides OutputAdapterBaseStatus)
	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 OutputAdapterBase implementation supports temporal processing. (Inherited from OutputAdapterBase)
	TimestampFormat	Gets or sets the format of timestamps in the CSV exports.
	UseAsyncConnect	Gets flag that determines if the data output stream connects asynchronously. (Overrides OutputAdapterBaseUseAsyncConnect)

Top

	Name	Description
	AttemptConnection	Attempts to connect to data output stream. (Overrides OutputAdapterBaseAttemptConnection)
	AttemptDisconnection	Attempts to disconnect from data output stream. (Overrides OutputAdapterBaseAttemptDisconnection)
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the CsvExportAdapter object and optionally releases the managed resources. (Overrides OutputAdapterBaseDispose(Boolean))
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteMetadataRefresh	Executes the metadata refresh in a synchronous fashion. (Inherited from OutputAdapterBase)
	Finalize	Releases the unmanaged resources before the AdapterBase object is reclaimed by GC. (Inherited from AdapterBase)
	Flush	Blocks the current thread, if the OutputAdapterBase is connected, until all items in OutputAdapterBase queue are processed, and then stops processing. (Inherited from OutputAdapterBase)
	GetHashCode	Serves as a hash function for the current AdapterBase. (Inherited from AdapterBase)
	GetShortStatus	Gets a short one-line status of this CsvExportAdapter. (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 CsvExportAdapter. (Overrides OutputAdapterBaseInitialize)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	OffloadLingeringFiles	Offloads lingering files which were not offloaded due to errors or system failures.
	OnConfigurationChanged	Raises ConfigurationChanged event. (Inherited from AdapterBase)
	OnConnected	Called when data output source connection is established. (Inherited from OutputAdapterBase)
	OnDisconnected	Called when data input source is disconnected. (Inherited from OutputAdapterBase)
	OnInputMeasurementKeysUpdated	Raises InputMeasurementKeysUpdated event. (Inherited from AdapterBase)
	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)
	OnUnprocessedMeasurements	Raises the UnprocessedMeasurements event. (Inherited from OutputAdapterBase)
	ProcessMeasurements	Serializes measurements to data output stream. (Overrides OutputAdapterBaseProcessMeasurements(IMeasurement))
	QueueMeasurementForProcessing	Queues a single measurement for processing. Measurement is automatically filtered to the defined InputMeasurementKeys. (Inherited from OutputAdapterBase)
	QueueMeasurementsForProcessing	Queues a collection of measurements for processing. Measurements are automatically filtered to the defined InputMeasurementKeys. (Overrides OutputAdapterBaseQueueMeasurementsForProcessing(IEnumerableIMeasurement))
	RefreshMetadata	Initiates request for metadata refresh for OutputAdapterBase, if implemented. (Inherited from OutputAdapterBase)
	RemoveMeasurements	This removes a range of measurements from the internal measurement queue. (Inherited from OutputAdapterBase)
	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 this OutputAdapterBase and initiates connection cycle to data output stream. (Inherited from OutputAdapterBase)
	Stop	Stops this OutputAdapterBase and disconnects from data output stream. (Inherited from OutputAdapterBase)
	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)
	Disposed	Event is raised when AdapterBase is disposed. (Inherited from AdapterBase)
	InputMeasurementKeysUpdated	Event is raised when InputMeasurementKeys are updated. (Inherited from AdapterBase)
	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)
	UnprocessedMeasurements	Event is raised every five seconds allowing host to track total number of unprocessed measurements. (Inherited from OutputAdapterBase)

Top

	Name	Description
	DefaultDownsampleInterval	Default value for the DownsampleInterval property.
	DefaultEnableTimeReasonabilityValidation	Default value for the EnableTimeReasonabilityValidation property.
	DefaultFileNameTemplate	Default value for the FileNameTemplate property.
	DefaultFramesPerSecond	Default value for the FramesPerSecond property.
	DefaultHeaderLine	Default value for the HeaderLine property.
	DefaultLagTime	Default value for the LagTime property.
	DefaultLeadTime	Default value for the LeadTime property.
	DefaultRollverSchedule	Default value for the RolloverSchedule property.
	DefaultTimestampFormat	Default value for the TimestampFormat property.

Top

Reference

CsvAdapters Namespace