GXSchedule Class

GXSchedule component implements the GXSchedule interface, which handles scheduled reads and writes of values.

Members

All Members	Constructors	Methods	Properties	Events
Public Protected		Instance Static		Declared Inherited

Icon	Member	Description
	GXSchedule()()()	Initializes a new instance of the GXSchedule class
	Action	Action is the transaction to be performed, when schedule triggers.
	AvailableReadSpans	Determines available read span types.
	Categories	Categories are the target GXCategoryCollection of the transaction.
	Clear()()()	Clear clears all settings of the GXSchedule.
	Clone()()()	Creates a new object that is a copy of the current instance. (Inherited from GXObject.)
	ConnectionDelayTime	ConnectionDelayTime determines for how long a time (in ms) is waited, before next connection is made.
	ConnectionFailTryCount	How many times failed connection is tried to reconnect.
	ConnectionFailWaitTime	ConnectionFailWaitTime determines for how long a time (in ms) is waited, before next connection is made.
	ConnectionWaitTime	Determines how long a time (in ms) is waited for the connection to be established.
	Copy(Object)	The Copy method copies object content from the target object. (Inherited from GXObject.)
	DayOfMonth	DayOfMonth is used when RepeatMode is monthly. Determines the day of month, when the transaction is executed.
	DayOfWeek	DayOfWeek is used when RepeatMode is weekly. Determines weekday(s), when transaction is executed.
	DeviceGroups	DeviceGroups are the target GXDeviceGroupCollection of the transaction.
	DeviceList	DeviceList is the target GXDeviceList of the transaction.
	Devices	Devices are the target GXDeviceCollection of the transaction.
	Dispose(Boolean)	(Overrides GXObject.Dispose(Boolean).)
	Dispose()()()	(Inherited from GXObject.)
	EndTime	Time when schedule item stopped.
	Equals(Object)	Determines whether two objects are equal. (Overrides GXObject.Equals(Object).)
	ExcludedCategories	ExcludedCategories are the items, which are not read, even if they are set in target collections.
	ExcludedDeviceGroups	ExcludedDeviceGroups are the items, which are not read even if they are set in target collections.
	ExcludedDevices	ExcludedDevices are the items, which are not read even if they are set in target collections.
	ExcludedProperties	ExcludedProperties are items, which are not read, even if they are set in the target collections.
	ExcludedTables	ExcludedTables are the items, which are not read even if they are set in target collections.
	ExecuteFailedItemsOnly	ExecuteFailedItemsOnly gets failed items only if the schedule fails.
	FailedItems	FailedItems returns collection of items, whose read/write failed.
	FailTryCount	FailTryCount determines how many times devices are tried to read again if failed.
	FailWaitTime	FailWaitTime determines for how long a time (in ms) is waited before devices are tried to read again if failed.
	Finalize()()()	(Inherited from GXObject.)
	FindByParameter(String, Object)	Returns collection of objects that match search parameters. (Inherited from GXObject.)
	GetControls()()()	Returns a collection of controls that use this component. (Inherited from GXObject.)
	GetHashCode()()()	Serves as a hash function for a particular type. (Inherited from Object.)
	GetOcx()()()	Retrieves a reference to the underlying ActiveX control. (Inherited from GXObject.)
	GetType()()()	Gets the Type of the current instance. (Inherited from Object.)
	GXObjectType	Sender object type. Reserved for inner use. Do Not Use! (Inherited from GXObject.)
	ID	Object Identifier. (Inherited from GXObject.)
	Interval	Interval determines the time between schedule runs. For example, if the repeat mode is weekly and interval is 3, the schedule is triggered every three weeks.
	IsStarted	IsStarted is True, if the schedule is active.
	LastRunTime	LastRunTime method is reserved for inner use.
	MaxThreadCount	MaxThreadCount is the maximum number of worker threads per Schedule item.
	MemberwiseClone()()()	Creates a shallow copy of the current Object. (Inherited from Object.)
	Name	(Overrides GXObject.Name.)
	NextScheduledDate	NextScheduledDate returns the next scheduled date.
	OnScheduleItemStateChanged	OnScheduleItemStateChanged notifies that the state of the GXSchedule has changed.
	Parameters	Parameters is collection of GXParameterCollection, which are used as attached data storage items.
	Parent	Parent is the parent GXScheduleCollection collection of the GXSchedule.
	Properties	Properties are the target GXPropertyCollection of the transaction.
	ReadSpan	Used read span type.
	RepeatMode	RepeatMode determines the repeat mode of a GXSchedule.
	ResetRunCount()()()	Resets the run count.
	Run()()()	Run runs the schedule item once.
	RunCount	How many times the schedule is run.
	RunFailCount	How many times the schedule run has failed.
	ScheduledTransactions	The ScheduledTransactions is an array of all execution dates of the schedule item.
	ScheduleEndTime	ScheduleEndTime is the time, when the schedule is stopped.
	ScheduleStartTime	ScheduleStartTime is the time, when the schedule is started.
	Start()()()	Start activates the schedule and transaction is started when the schedule triggers.
	StartTime	Time when schedule item started.
	Status	Status is the current state of the schedule item.
	Stop()()()	Stop disables the schedule.
	Tables	Tables are the target GXTableCollection of the transaction.
	ToString()()()	ToString returns a string that represents the current object. (Inherited from GXObject.)
	TransactionCount	TransactionCount determines how many times transaction is made, before stopping the current run.
	TransactionEndTime	TransactionEndTime is the time, when transaction has stopped.
	TransactionStartTime	TransactionStartTime is the time, when transaction is started.
	UpdateInterval	UpdateInterval is the execution interval of the transaction in seconds.

Inheritance Hierarchy

Object
	GXObject
		GXSchedule