TEquipmentModule is the a TINE server's equipment module class.
More...

Public Member Functions
int	AppendAlarmInfoTable (ref ADS ads)
	Inserts an alarm definition into the alarm definition table. More...

int	AppendAlarmWatchTable (string prp, string dev, Int32 siz, Int32 fmt, Int32 atyp, Int32 sev, Int32 sys, ref ALM_THRESHOLDS thr)
	Inserts a property to be monitored into the local alarm server's Watch Table. More...

int	AppendHistoryInformation (string prp, string dev, Int32 len, Int32 fmt, Int32 idx, ref HistorySpecification hspec)
	Inserts a local history element into the local history server. More...

int	CallPropertyInSeparateThread (string property, Boolean value)
	Determines whether the specified property is called in a separate handler thread or not. More...

void	ClearAlarm (Int32 devNr)
	Instructs the local alarm server table that the given alarm is to be cleared. More...

void	ClearAlarm (string devName)
	Instructs the local alarm server table that the given alarm is to be cleared. More...

unsafe ClnInfo	GetCallerInformation ()
	Returns a ClnInfo structure containing relevant information of the current caller of this equipment module. More...

Int32	GetDeviceNumber (string device)
	Returns the registered device number for the device name given. More...

Int32	GetDeviceNumber (string device, string property)
	Returns the registered device number for the device name and property given. More...

Int32	GetPropertyId (string property)
	Returns the registered property identification number for the property entered. More...

int	RegisterDeviceName (String devName, Int32 devNr)
	Assigns a device name to the specified device number. More...

int	RegisterPropertyAlias (string property, string alias)
	assigns an alias name to the specified propert More...

int	RegisterPropertyInformation (string property, TDataType dout, TDataType din, UInt16 acc, UInt16 atype, int rowLength, string dsc, int propId, string rdr)
	Assigns pertinent information for the specified property. More...

void	RemoveAlarm (string devName, UInt32 almCode)
	Instructs the local alarm server table that the given alarm is to be marked for removal. More...

int	RestorePropertyValues (string property, object values)
	Fills the given 'values' object with the last stored property values. The 'values' object passed should be large enough to contain the stored values for all devices (consecutively ordered). More...

int	SavePropertyValues (string property, string device, object values)
	Saves the values in the give 'values' object with the property and device provides. More...

Int32	ScheduleProperty (string property)
	Schedules the given property for immediate delivery to all attached clients. More...

Int32	ScheduleProperty (string property, Int32 scope)
	Schedules the given property for immediate delivery to all attached clients according scope specified. More...

int	SetAlarm (Int32 devNr, UInt32 almCode)
	Inserts an alarm into the local alarm server table. More...

int	SetAlarm (Int32 devNr, UInt32 almCode, object almData, byte almFlags)
	Inserts an alarm into the local alarm server table. More...

int	SetAlarm (Int32 devNr, UInt32 almCode, String tag)
	Inserts an alarm into the local alarm server table. More...

int	SetAlarm (Int32 devNr, UInt32 almCode, String tag, object almData, byte almFlags)
	Inserts an alarm into the local alarm server table. More...

int	SetAlarm (string devName, UInt32 almCode, object almData, byte almFlags)
	Inserts an alarm into the local alarm server table. More...

int	SetAlarm (string devName, UInt32 almCode, String tag, object almData, byte almFlags)
	Inserts an alarm into the local alarm server table. More...

void	SetCompletion (string statusString)
	Sets the error string to accompany the current server call More...

	TEquipmentModule (string exp, string eqm, Int32 ndev, CallHandler hndlr, FcnDispatch ini, FcnDispatch bkg, Int32 bkgInterval, FcnDispatch exi)
	Primary constructor for an equipment module object. More...

Properties
Boolean?	SchedulePropertyLazy `[get, set]`
	get/set the ScheduleProperty 'lazy' setting More...

Detailed Description

TEquipmentModule is the a TINE server's equipment module class.

An equipment module represents a device server. This is ideally a class which manages like instances of a set of devices. The equipment module is responsible for handling dispatch actions pertaining to registered properties ('READ' or 'WRITE' actions).

Constructor & Destructor Documentation

◆ TEquipmentModule()

tine.TEquipmentModule.TEquipmentModule	(	string	exp,
		string	eqm,
		Int32	ndev,
		CallHandler	hndlr,
		FcnDispatch	ini,
		FcnDispatch	bkg,
		Int32	bkgInterval,
		FcnDispatch	exi
	)

inline

Primary constructor for an equipment module object.

A FEC (front-end controller) process can contain more than one equipment module (which is exported as a device server or property server). However, a FEC process should contain at least one equipment module in order to be a useful element in the control system.

Parameters

exp	is the equipment module's exported device or property server name (maximum 32 characters). This name must be unique within a given context. If a 'null' parameter is passed, then the exported name must be given by an underlying configuration file such as 'export.csv' or 'fec.xml'
eqm	is the equipment module's internal 'local' name (maximum 6-characters). This name must be unique within the process only, and is used for internal de-referencing.
ndev	gives the maximum device capacity (maximum number of device instances supported by this device server.
hndlr	is the equipment module's dispatch call handler. This must be a function of the form: int CallHandler(string dev, string prp, TDataType dout, TDataType din, UInt16 acc, TEquipmentModule eqm);
ini	is an optional initialization routine for the equipment module. This must be a function of the form: void FcnDispatch();
bkg	is an optional background routine for the equipment module, which will be called at the given background task interval. This must be a function of the form: void FcnDispatch();
bkgInterval	is the background task interval in play if a background task is registered.
exi	is an optional background routine for the equipment module, which will be called at the given background task interval. This must be a function of the form: void FcnDispatch();

Example:

  myeqm = new TEquipmentModule("DotNetSine", "DNTEQM", 10, sineqm, sinini, sinbkg, 1000, sinexi);
 
 

Member Function Documentation

◆ AppendAlarmInfoTable()

int tine.TEquipmentModule.AppendAlarmInfoTable ( ref ADS ads )

inline

Inserts an alarm definition into the alarm definition table.

As an alternative to the 'local name'-alarms.csv configuration file, the front end server can make use of this API call in order to fill in the alarm definition table describing locally generated alarms. This is particularly useful for embedded platforms where there is no file system, or where a TINE server is used as a translation layer and needs to map a given alarm system onto the TINE alarm system.

Parameters

ads	is a pointer to an Alarm Definition Structure (ADS) containing the alarm table information which is to be appended to the alarm definition table.

Returns: 0 upon success, otherwise a TINE error code.

◆ AppendAlarmWatchTable()

int tine.TEquipmentModule.AppendAlarmWatchTable	(	string	prp,
		string	dev,
		Int32	siz,
		Int32	fmt,
		Int32	atyp,
		Int32	sev,
		Int32	sys,
		ref ALM_THRESHOLDS	thr
	)

inline

Inserts a property to be monitored into the local alarm server's Watch Table.

Certain alarms are to be set whenever the value of a property exceeds a defineable threshold. Such alarms can be managed automatically by the local alarm server if the alarm criteria are entered into the alarm watch table. This can be achieved by calling this routine (or supplying a startup configuration file almwatch.csv).

Parameters

prp	is the property which is to be called by the local alarm server.
dev	is the device name associated with the property to be called by the local alarm server.
siz	is the data array size to be called by the local alarm server.
fmt	is the TINE data format to be called by the local alarm server.
atyp	is the TINE data array type to be applied to the property called by the local alarm server.
sev	is the severity of the alarm issued when the data returned by the call exceed the given thresholds.
sys	is the alarm system identifier to be associated with the alarm.
thr	is an ALM_THRESHOLDS object specifying the threshold criteria for setting the alarm.

Returns: 0 upon success, otherwise a TINE error code.

◆ AppendHistoryInformation()

int tine.TEquipmentModule.AppendHistoryInformation	(	string	prp,
		string	dev,
		Int32	len,
		Int32	fmt,
		Int32	idx,
		ref HistorySpecification	hspec
	)

inline

Inserts a local history element into the local history server.

A server can instruct the local history server to keep a history of the given property by utilizing this call. The local history server will periodically call the property as specified according to the following input parameters. /remarks>

Parameters

prp	is the requested property for which a history is to be kept.
dev	is the device name to be associated with the property name supplied as the second parameter.
len	is the length of the local history call.
fmt	is the TINE format of the local history call.
idx	is the local history index to be identified with this local history element (Note: this must be unique with this server process and within the history data repository).
hspec	is a pointer to a HistorySpecification structure, where the relevant filtering criteria are given.

Returns: 0 upon success, otherwise a TINE error code.

Note: In lieu of calling AppendHistoryInformation(), it is recommended to make use of the startup configuration file 'history.csv', in which all local history critieria can be introduced. This has the advantage that no information is hard-coded. Indeed by introducing a 'history.csv' file one can immediately instruct a server to maintain local history information (even if the server is developed and maintained by someone else!).

Example:

      HistorySpecification hsp = new HistorySpecification();
      hsp.archiveRate = hsp.pollingRate = 1000;
      hsp.aTolerance = hsp.pTolerance = 0;
      hsp.depthLong = 0;
      hsp.depthShort = 600;
      myeqm.AppendHistoryInformation("Frequency", "SineGen0", 10, Formats.CF_FLOAT, 3, ref hsp);
 

◆ CallPropertyInSeparateThread()

int tine.TEquipmentModule.CallPropertyInSeparateThread	(	string	property,
		Boolean	value
	)

inline

Determines whether the specified property is called in a separate handler thread or not.

Parameters

property	the property which is to be called on a separate dispatch handler thread.
value	determines whether the property is called in a separate thread or not (default: false).

Returns: 0 if successful, otherwise a TINE completion code

◆ ClearAlarm() [1/2]

void tine.TEquipmentModule.ClearAlarm ( Int32 devNr )

inline

Instructs the local alarm server table that the given alarm is to be cleared.

A server can clear alarms for specific device by giving its device number. Note that all alarms for the device specified are cleared. Also note, that "clearing" an alarm means that its "clear" counter is incremented. It is not removed immediately from the local alarm list. For further information, please see the discussion of the local alarm server.

Parameters

devNr is the device number of the device for which all alarms is to be cleared.

◆ ClearAlarm() [2/2]

void tine.TEquipmentModule.ClearAlarm ( string devName )

inline

Instructs the local alarm server table that the given alarm is to be cleared.

A server can clear alarms for specific device by giving its device name. Note that all alarms for the device specified are cleared. Also note, that "clearing" an alarm means that its "clear" counter is incremented. It is not removed immediately from the local alarm list. For further information, please see the discussion of the local alarm server.

Parameters

devName is the registered device name of the device for which all alarms is to be cleared.

◆ GetCallerInformation()

unsafe ClnInfo tine.TEquipmentModule.GetCallerInformation ( )

inline

Returns a ClnInfo structure containing relevant information of the current caller of this equipment module.

If multiple callers are behind the current contract, then only the 'head' of the list is returned.

Returns: a ClnInfo structure containing relevant information of the current

Example:

    public Int32 sineqm(string dev, string prp, TDataType dout, TDataType din, UInt16 acc,TEquipmentModule eqm)
    {
      ClnInfo cln = eqm.GetCallerInformation();
      String txt = "device: "+dev+", property: "+prp+" => called by : " + cln.GetUserName() + " at " + cln.GetNetworkAddr();
      System.Diagnostics.Debug.WriteLine(txt);
      ...

◆ GetDeviceNumber() [1/2]

Int32 tine.TEquipmentModule.GetDeviceNumber ( string device )

inline

Returns the registered device number for the device name given.

Parameters

device is the device name whose assigned device number is desired. If the device name entered does not correspond to a registered device the value '-1' is returned.

Returns: The corresponding device number or '-1' on error.

◆ GetDeviceNumber() [2/2]

Int32 tine.TEquipmentModule.GetDeviceNumber	(	string	device,
		string	property
	)

inline

Returns the registered device number for the device name and property given.

A pure device server will maintain a list of registered devices, each of which may support any particular given property. In such cases the 'property' parameter is irrelevant, as any associated device number is independent of the property.

On the other hand, a 'property' server will treat properties as the more relevant identifier, whereby each property may support an independent set of 'device' names (or more probably 'keyword' names). In such cases the property name entered is of paramount importance in determining the registered device (or keyword) number.

Parameters

device	is the device name whose assigned device number is desired. If the device name entered does not correspond to a registered device the value '-1' is returned.
property	is the property whose device set is being queried.

Returns: The corresponding device number or '-1' on error.

Example:

  // relevant initialization snippet ...
  
  float[,] sinbuf = new float[NUM_DEVICES,NUM_VALUES];
  SineInfo[] sineInfoTable = new SineInfo[NUM_DEVICES];
    
  myeqm = new TEquipmentModule("DotNetSine", "DNTEQM", 10, sineqm, sinini, sinbkg, 1000, sinexi);
 
  TDataType dtout = new TDataType(8192,Formats.CF_FLOAT,null);
 
  myeqm.RegisterPropertyInformation("Sine", dtout, null, Access.CA_READ, ArrayType.AT_TRACE, 8192, "[-512:512 V]Sine Curve", PRP_SINE, "");
  dtout = new TDataType(10, Formats.CF_FLOAT, null);
 
  TDataType dtin = new TDataType(1, Formats.CF_FLOAT, null);
  myeqm.RegisterPropertyInformation("Amplitude", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[-512:512 V]Sine Curve Amplitude", PRP_AMPLITUDE, "");
  myeqm.RegisterPropertyInformation("Frequency", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[1:20 Hz]Sine Curve Frequency", PRP_FREQUENCY, "");
  myeqm.RegisterPropertyInformation("Phase", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:6.28]Sine curve Phase", PRP_PHASE, "");
  myeqm.RegisterPropertyInformation("Noise", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:50 V]Sine curve Noise", PRP_NOISE, "");
 
 
  // handling property requests ...
 
  public Int32 sineqm(string dev, string prp, TDataType dout, TDataType din, UInt16 acc,TEquipmentModule eqm)
  {
    float fval = 0;
    float[] mcarray = new float[NUM_DEVICES];
    int cc;
    int devnr = eqm.GetDeviceNumber(dev, prp);
    int prpid = eqm.GetPropertyId(prp); 
    switch (prpid)
    {
      case PRP_SINE:
        if ((acc & Access.CA_WRITE) != 0) return Errors.illegal_read_write;
        if ((cc = dout.PutData(sinbuf,devnr,NUM_VALUES,0)) != 0) return cc;
        return 0;
      case PRP_AMPLITUDE:
        if (din.GetDataArrayLength() > 0)
        if (din.GetDataArrayLength() > 0)
        { // input data => require write access
          if ((acc & Access.CA_WRITE) != Access.CA_WRITE) return Errors.illegal_read_write;
          if ((cc = din.GetData(ref fval)) != 0) return cc;
          if (fval < 1 || fval > 1000) return Errors.out_of_range;
          sineInfoTable[devnr].amplitude = fval;
        }
        if (dout.GetDataArrayLength() > 0)
        { // prepare multichannel array
          for (int i = 0; i < NUM_DEVICES; i++)
            mcarray[i] = sineInfoTable[i].amplitude;
          if ((cc = dout.PutData(mcarray,NUM_DEVICES,devnr)) != 0) return cc;
        }
        return 0;
      case PRP_FREQUENCY:
        // etc.

◆ GetPropertyId()

Int32 tine.TEquipmentModule.GetPropertyId ( string property )

inline

Returns the registered property identification number for the property entered.

Parameters

property is the property whose assigned property identification is desired

Returns: The property identication number of -1 on error.

◆ RegisterDeviceName()

int tine.TEquipmentModule.RegisterDeviceName	(	String	devName,
		Int32	devNr
	)

inline

Assigns a device name to the specified device number.

Many servers handle instances of a given device type, such as a set of vacuum pumps, beam position monitors, magnet power supply controllers, etc. It is frequently very efficient to code in terms of device numbers which might be an index into an array, but to specify modules in calls by their human-readable names. For such purposes a device name can be assigned to a number at initialization via a call to RegisterDeviceName() (alias: RegisterModuleName()). An alternative is to provide a startup database file 'devices.csv' containing a cross-reference for numbers and names. Internally, a hash table is maintained for fast lookups inside equipment module routines.

Parameters

devName	Up to 64 characters device name to be assigned
devNr	The device number associated with the device name specified.

Returns: 0 if successful, otherwise a TINE completion code

Example:

References tine.TKernel.RegisterDeviceName().

◆ RegisterPropertyAlias()

int tine.TEquipmentModule.RegisterPropertyAlias	(	string	property,
		string	alias
	)

inline

assigns an alias name to the specified propert

Parameters

property	is the property name in question
alias	is an alias which maps to the property in question

Returns: 0 if successful, otherwise the a TINE return code

◆ RegisterPropertyInformation()

int tine.TEquipmentModule.RegisterPropertyInformation	(	string	property,
		TDataType	dout,
		TDataType	din,
		UInt16	acc,
		UInt16	atype,
		int	rowLength,
		string	dsc,
		int	propId,
		string	rdr
	)

inline

Assigns pertinent information for the specified property.

Servers export their behavior through Properties, which can be thought of as 'properties' in the Object Oriented sense with Get and Set methods. That is, any read or write access for a given property will call into the associated equipment module and be handled there. The general behavior of the property (including descriptions) can be specified with this call. Properties can also be (and frequently are) registered via the presence of an 'exports.csv' startup database file. Note: Properties which are overloaded can and should be registered more than once with the appropriate characteristics supplied in the registration call.

Parameters

property	Property name in question (up to 32 characters, preferably 16 or less).
dout	Atemplate data object giving the default format size, and structure tag (if any) of the output data set to be returned by the server to the caller.
din	A template data object giving the default format size, and structure tag (if any) of the input data set to be supplied by the caller.
acc	the data 'access' (e.g. CA_READ or CA_WRITE) accepted by the server. This parameter can be used to coerce client-side links into using preferred link attributes. For example, by applying the CA_NETWORK flag (CA_READ\|CA_NETWORK) to the access, asynchronous NETWORK (i.g. multicast acquisition) will be enforced at the client side. Applying the CA_XREAD access flag will likewise allow exclusive READ access regarding the registered property (i.e. the same security rules applied to CA_WRITE will be in force for READ acquisitions, either permanently - no CA_READ flag, or temporarily in case of an applied access lock - if both CA_READ and CA_XREAD are applied). Applying the CA_SAVERESTORE flag will apply the internal save-and-restore logic to the registered property (restoring the last property settings upon server startup, and saving any changed property settings).
atype	Data 'array type' (AT_SCALAR, AT_SINGLE, etc.) associated with the returned data.
rowLength	if > 0 gives the row length of the returned array data. This is most relevant for double arrays, where the number of rows is then given by the output data size divided by the row length.
dsc	The 64-character description of what the property reads or writes.
propId	The property identifier to be associated with the property name returned in calls to GetPropertyId()
rdr	A redirection string, if the property is to be redirected to another server. Most properties are not redirected, and this parameter is usually NULL. If used, it will be parsed according to device server/device name (device property), where the 'device name' and 'device property' are optional. If 'device name' is not present, all devices will be redirected to the specified device server. If 'device property' is not present then the identical property name as registered will be redirected to the device server specified. If on the other hand, the device property is present in the string to be parsed, then the property registered will be redirected to the device server specified as well as to the device property specified.

Returns: The (positive) associated property identifier if successful, otherwise the negative of a TINE return code.

Example:

  myeqm = new TEquipmentModule("DotNetSine", "DNTEQM", 10, sineqm, sinini, sinbkg, 1000, sinexi);
 
  TDataType dtout = new TDataType(8192,Formats.CF_FLOAT,null);
 
  myeqm.RegisterPropertyInformation("Sine", dtout, null, Access.CA_READ, ArrayType.AT_TRACE, 8192, "[-512:512 V]Sine Curve", PRP_SINE, "");
  dtout = new TDataType(10, Formats.CF_FLOAT, null);
 
  TDataType dtin = new TDataType(1, Formats.CF_FLOAT, null);
  myeqm.RegisterPropertyInformation("Amplitude", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[-512:512 V]Sine Curve Amplitude", PRP_AMPLITUDE, "");
  myeqm.RegisterPropertyInformation("Frequency", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[1:20 Hz]Sine Curve Frequency", PRP_FREQUENCY, "");
  myeqm.RegisterPropertyInformation("Phase", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:6.28]Sine curve Phase", PRP_PHASE, "");
  myeqm.RegisterPropertyInformation("Noise", dtout, dtin, Access.CA_READ | Access.CA_WRITE, ArrayType.AT_CHANNEL, 10, "[0:50 V]Sine curve Noise", PRP_NOISE, "");

References tine.TKernel.RegisterPropertyInformation().

◆ RemoveAlarm()

void tine.TEquipmentModule.RemoveAlarm	(	string	devName,
		UInt32	almCode
	)

inline

Instructs the local alarm server table that the given alarm is to be marked for removal.

A server can remove alarms for specific device by giving its registered device name. Note that only the alarm specified for the device specified is removed. Also note, that "removing" an alarm means that termination bit will be set. It is subsequently marked for removal from the local alarm list. For further information, please see the discussion of the local alarm server.

Parameters

devName
almCode

◆ RestorePropertyValues()

int tine.TEquipmentModule.RestorePropertyValues	(	string	property,
		object	values
	)

inline

Fills the given 'values' object with the last stored property values. The 'values' object passed should be large enough to contain the stored values for all devices (consecutively ordered).

Parameters

property	the property for which the last stored values will be retrieved
values	an object large enough to contain all stored values

This is a do-it-yourself 'restore' routine. i.e. it is the caller's duty to somehow assign the values returned to the given property.

Returns: 0 if successful, otherwise a TINE completion code

◆ SavePropertyValues()

int tine.TEquipmentModule.SavePropertyValues	(	string	property,
		string	device,
		object	values
	)

inline

Saves the values in the give 'values' object with the property and device provides.

This is a do-it-yourself 'save' routine. If the associated property is a multi- channel array or other array variant or structure, then the 'device' parameter will ensure that the value are in fact stored in the appropriate spot in the appropriate file.

Parameters

property	the property for which the values will be saved
device	the device for which the values will be saved (if applicable)
values	an object containing the values to associate with the property and device given

Returns: 0 if successful, otherwise a TINE completion code

◆ ScheduleProperty() [1/2]

Int32 tine.TEquipmentModule.ScheduleProperty ( string property )

inline

Schedules the given property for immediate delivery to all attached clients.

When clients are attached to a particular property, they have specified a polling rate, which defines the maximum latency for receiving updates at the client side. This is usually fine. However, if a server knows that important data have changed and which properties depend on these data, it can signal the scheduler to call the given properties immediately and send the data to all attached callers, regardless of their registered polling rates. In this way, a server can signal an event to its attached clients. In this simple call, clients from all listening subsystems will be scheduled (i.e. the local history and alarm subsystem as well as any remote clients).

Parameters

property is (comma separated) list of properties which are to be scheduled.

Returns: 0 upon success or a tine error code

◆ ScheduleProperty() [2/2]

Int32 tine.TEquipmentModule.ScheduleProperty	(	string	property,
		Int32	scope
	)

inline

Schedules the given property for immediate delivery to all attached clients according scope specified.

When clients are attached to a particular property, they have specified a polling rate, which defines the maximum latency for receiving updates at the client side. This is usually fine. However, if a server knows that important data have changed and which properties depend on these data, it can signal the scheduler to call the given properties immediately and send the data to all attached callers, regardless of their registered polling rates. In this way, a server can signal an event to its attached clients. In this extended call, the caller can specify the 'scope' of the call : CA_NETWORK (all listening clients), CA_HIST (the local history subsystem) or CA_ALARM (the local alarm server).

Parameters

property	is (comma separated) list of properties which are to be scheduled.
scope	is any of CA_NETWORK, CA_HIST, or CA_ALARM ORed together.

Returns: 0 upon success or a TINE error code.

◆ SetAlarm() [1/6]

int tine.TEquipmentModule.SetAlarm	(	Int32	devNr,
		UInt32	almCode
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device number. For further information, please see the discussion of the local alarm server.

Parameters

devNr	is the device number of the device for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.

Returns

◆ SetAlarm() [2/6]

int tine.TEquipmentModule.SetAlarm	(	Int32	devNr,
		UInt32	almCode,
		object	almData,
		byte	almFlags
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device number. This methods also allows passing associated alarm data and specific alarm flags. For further information, please see the discussion of the local alarm server.

Parameters

devNr	is the device number of the device for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.
almData	is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm.
almFlags	is the optional set of alarm flags which is used in the alarm descriptor information.

Returns

◆ SetAlarm() [3/6]

int tine.TEquipmentModule.SetAlarm	(	Int32	devNr,
		UInt32	almCode,
		String	tag
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device number. For further information, please see the discussion of the local alarm server.

Parameters

devNr	is the device number of the device for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.
tag	is an optional alarm message tag which will override the static tag contained in the alarm definition

Returns

◆ SetAlarm() [4/6]

int tine.TEquipmentModule.SetAlarm	(	Int32	devNr,
		UInt32	almCode,
		String	tag,
		object	almData,
		byte	almFlags
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device number. This methods also allows passing associated alarm data and specific alarm flags. For further information, please see the discussion of the local alarm server.

Parameters

devNr	is the device number of the device for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.
tag	is an optional alarm message tag which will override the static tag contained in the alarm definition
almData	is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm.
almFlags	is the optional set of alarm flags which is used in the alarm descriptor information.

Returns

◆ SetAlarm() [5/6]

int tine.TEquipmentModule.SetAlarm	(	string	devName,
		UInt32	almCode,
		object	almData,
		byte	almFlags
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device name (as opposed to its device number). This methods also allows passing associated alarm data and specific alarm flags. For further information, please see the discussion of the local alarm server.

Parameters

devName	is the device name for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.
almData	is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm.
almFlags	is the optional set of alarm flags which is used in the alarm descriptor information.

Returns

◆ SetAlarm() [6/6]

int tine.TEquipmentModule.SetAlarm	(	string	devName,
		UInt32	almCode,
		String	tag,
		object	almData,
		byte	almFlags
	)

inline

Inserts an alarm into the local alarm server table.

A server can set an alarm for a specific device by giving its device name (as opposed to its device number). This methods also allows passing associated alarm data and specific alarm flags. For further information, please see the discussion of the local alarm server.

Parameters

devName	is the device name for which the alarm is to be set.
almCode	is the registered alarm code which defines the alarm.
tag	is an optional alarm message tag which will override the static tag contained in the alarm definition
almData	is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm.
almFlags	is the optional set of alarm flags which is used in the alarm descriptor information.

Returns

◆ SetCompletion()

void tine.TEquipmentModule.SetCompletion ( string statusString )

inline

Sets the error string to accompany the current server call

For user-defined errors codes (equal to or above 512) the accompanying error string should be defined by calling this routine prior to returning from the equipment module call. When system error codes such as 'illegal_format' are used, a call to SetEqmCompletion() is not necessary.

Parameters

statusString is the 96-character string which is to accompany the outgoing error code.

Property Documentation

◆ SchedulePropertyLazy

Boolean? tine.TEquipmentModule.SchedulePropertyLazy

getset

get/set the ScheduleProperty 'lazy' setting

The documentation for this class was generated from the following file:

tine.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TEquipmentModule()

Member Function Documentation

◆ AppendAlarmInfoTable()

◆ AppendAlarmWatchTable()

◆ AppendHistoryInformation()

◆ CallPropertyInSeparateThread()

◆ ClearAlarm() [1/2]

◆ ClearAlarm() [2/2]

◆ GetCallerInformation()

◆ GetDeviceNumber() [1/2]

◆ GetDeviceNumber() [2/2]

◆ GetPropertyId()

◆ RegisterDeviceName()

◆ RegisterPropertyAlias()

◆ RegisterPropertyInformation()

◆ RemoveAlarm()

◆ RestorePropertyValues()

◆ SavePropertyValues()

◆ ScheduleProperty() [1/2]

◆ ScheduleProperty() [2/2]

◆ SetAlarm() [1/6]

◆ SetAlarm() [2/6]

◆ SetAlarm() [3/6]

◆ SetAlarm() [4/6]

◆ SetAlarm() [5/6]

◆ SetAlarm() [6/6]

◆ SetCompletion()

Property Documentation

◆ SchedulePropertyLazy