ProcessLauncher Class

SystemObject
  GSF.TimeSeries.AdaptersAdapterBase
    GSF.TimeSeries.AdaptersFacileActionAdapterBase
      FileAdaptersProcessLauncher

public class ProcessLauncher : FacileActionAdapterBase

Public Class ProcessLauncher
	Inherits FacileActionAdapterBase

public ref class ProcessLauncher : public FacileActionAdapterBase

type ProcessLauncher = 
    class
        inherit FacileActionAdapterBase
    end

FileAdapters.ProcessLauncher = function();

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

View Source

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

Top

	Name	Description
	Arguments	Gets or sets any command line arguments to use when launching the process.
	AutoStart	Gets or sets flag indicating if adapter should automatically start or otherwise connect on demand. (Inherited from AdapterBase)
	ChildProcessQueryTimeout	Gets or sets the maximum processing time allowed, in milliseconds, for querying for available associated child processes.
	ChildProcessTarget	Gets or sets the name of the child process to target for additional monitoring and termination when adapter is disposed.
	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)
	CreateNoWindow	Gets or sets flag that determines if a new window should be created when launching the process.
	DataSource	Gets or sets DataSet based data source available to this AdapterBase. (Inherited from AdapterBase)
	Domain	Gets or sets the user domain to use when creating an authentication context before launching the process.
	Enabled	Gets or sets enabled state of this AdapterBase. (Inherited from AdapterBase)
	EnvironmentalVariables	Gets or sets any needed environmental variables that should be set or updated before launching the process.
	ErrorDialog	Gets or sets flag that determines if an error dialog should be displayed if the process cannot be launched.
	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)
	FileName	Gets or sets the path and filename of executable to launch as a new process.
	ForceKillOnDispose	Gets or sets flag that determines if launched process should be forcibly terminated when adapter is disposed.
	FramesPerSecond	Property hidden - not used by ProcessLauncher.
	ID	Gets or sets numeric ID associated with this AdapterBase. (Inherited from AdapterBase)
	InitialInputFileName	Gets or sets filename that contains text to use as standard input into process after it has been launched.
	InitialInputProcessingDelay	Gets or sets the processing delay, in milliseconds, before text defined in the InitialInputFileName is sent to the launched process.
	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	Property hidden - not used by ProcessLauncher.
	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	Property hidden - not used by ProcessLauncher.
	LatestMeasurements	Gets reference to the collection of absolute latest received measurement values. (Inherited from FacileActionAdapterBase)
	LeadTime	Property hidden - not used by ProcessLauncher.
	LoadUserProfile	Gets or sets flag that determines if Windows user profile should be loaded from the registry before launching the process.
	Log	Log messages generated by an adapter. (Inherited from AdapterBase)
	LogMessageLevelExpression	Gets or sets regular expression used to find log message level when redirected output is processed as formatted log messages.
	LogMessageLevelMappings	Gets or sets log level mappings to use when redirected output is processed as formatted log messages.
	LogMessageTextExpression	Gets or sets regular expression used to find log message text when redirected output is processed as formatted log messages.
	MeasurementReportingInterval	Gets or sets the measurement reporting interval. (Inherited from AdapterBase)
	Name	Gets or sets the name of this AdapterBase. (Inherited from AdapterBase)
	OutputMeasurements	Property hidden - not used by ProcessLauncher.
	OutputSourceIDs	Gets or sets Source values used to filter output measurements. (Inherited from FacileActionAdapterBase)
	Password	Gets or sets the user password to use when creating an authentication context before launching the process.
	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)
	ProcessOutputAsLogMessages	Gets or sets flag that determines if redirected output should be attempted to be parsed as formatted log messages, e.g.: lvl=info msg="log message".
	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)
	RedirectErrorToHostEnvironment	Gets or sets flag that determines if process standard error output should be redirected to the hosting environment.
	RedirectOutputToHostEnvironment	Gets or sets flag that determines if process standard output should be redirected to the hosting environment.
	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)
	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)
	ShowChildProcesses	Gets or sets flag that determines if child processes should be shown during initialization for configuration purposes.
	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. (Overrides FacileActionAdapterBaseStatus)
	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)
	TrackProcessStatistics	Gets or sets flag that determines if statistics should be tracked for launched process.
	UseLocalClockAsRealTime	Gets or sets flag that determines whether or not to use the local clock time as real time. (Inherited from FacileActionAdapterBase)
	UserName	Gets or sets the user name to use when creating an authentication context before launching the process.
	UtilizationUpdateInterval	Gets or sets the interval over which to calculate lunched process utilization.
	WindowStyle	Gets or sets window style to use when launching the process if creating a window.
	WorkingDirectory	Gets or sets working directory to use when launching the process.

Top

	Name	Description
	Dispose	Releases all the resources used by the AdapterBase object. (Inherited from AdapterBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the ProcessLauncher 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 AdapterBase. (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 ProcessLauncher. (Overrides FacileActionAdapterBaseInitialize)
	Input	Sends specified value as input to launched process, new line will be automatically appended to text.
	Kill	Stops the launched process and and associated child processes.
	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. (Inherited from FacileActionAdapterBase)
	Refresh	Clears any cached information associated with the launched process.
	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 AdapterBase or restarts it if it is already running. (Inherited from AdapterBase)
	Stop	Stops the AdapterBase. (Inherited from AdapterBase)
	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
	DefaultArguments	Default value for the Arguments property.
	DefaultChildProcessQueryTimeout	Default value for the ChildProcessQueryTimeout property.
	DefaultChildProcessTarget	Default value for the ChildProcessTarget property.
	DefaultCreateNoWindow	Default value for the CreateNoWindow property.
	DefaultDomain	Default value for the Domain property.
	DefaultEnvironmentalVariables	Default value for the EnvironmentalVariables property.
	DefaultErrorDialog	Default value for the ErrorDialog property.
	DefaultForceKillOnDispose	Default value for the ForceKillOnDispose property.
	DefaultInitialInputFileName	Default value for the InitialInputFileName property.
	DefaultInitialInputProcessingDelay	Default value for the InitialInputProcessingDelay property.
	DefaultLoadUserProfile	Default value for the LoadUserProfile property.
	DefaultLogMessageLevelExpression	Default value for the LogMessageLevelExpression property.
	DefaultLogMessageLevelMappings	Default value for the LogMessageLevelMappings property.
	DefaultLogMessageTextExpression	Default value for the LogMessageTextExpression property.
	DefaultPassword	Default value for the Password property.
	DefaultProcessOutputAsLogMessages	Default value for the ProcessOutputAsLogMessages property.
	DefaultRedirectErrorToHostEnvironment	Default value for the RedirectErrorToHostEnvironment property.
	DefaultRedirectOutputToHostEnvironment	Default value for the RedirectOutputToHostEnvironment property.
	DefaultShowChildProcesses	Default value for the ShowChildProcesses property.
	DefaultSupportsTemporalProcessing	Default value for the SupportsTemporalProcessing property.
	DefaultTrackProcessStatistics	Default value for the TrackProcessStatistics property.
	DefaultUserName	Default value for the UserName property.
	DefaultWindowStyle	Default value for the WindowStyle property.
	DefaultWorkingDirectory	Default value for the WorkingDirectory property.

Top

Unless credentials are provided to create an authentication context, rights of any launched executable will be limited to those available to time-series host.

Reference

FileAdapters Namespace