SoFileSensor Class

SoFileSensor Class

Sensor that triggers a delegateeach time a file is changed.

Inheritance Hierarchy

SystemObject
  OIV.InventorSoNetBase
    OIV.Inventor.SensorsSoSensor
      OIV.Inventor.SensorsSoTimerQueueSensor
        OIV.Inventor.SensorsSoTimerSensor
          OIV.Inventor.SensorsSoFileSensor

Namespace: OIV.Inventor.Sensors
Assembly: OIV.Inventor (in OIV.Inventor.dll) Version: 9.9.13.0 (9.9.13.0)

Syntax

C++

Copy

public class SoFileSensor : SoTimerSensor

Public Class SoFileSensor
	Inherits SoTimerSensor

public ref class SoFileSensor : public SoTimerSensor

type SoFileSensor =  
    class
        inherit SoTimerSensor
    end

The SoFileSensor type exposes the following members.

Constructors

	Name	Description
	SoFileSensor	Default constructor.

Top

Methods

	Name	Description
	AddFile	Add file to be monitored.
	ClearFiles	Stop monitoring all previously registered files.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	GetBaseTime	Gets the base time. (Inherited from SoTimerSensor.)
	GetFilename	Return changed file name.
	GetHashCode	Overrides GetHashCode(). (Inherited from SoNetBase.)
	GetInterval	Gets the interval. (Inherited from SoTimerSensor.)
	GetTriggerTime	Returns the time at which this sensor is scheduled to be triggered. (Inherited from SoTimerQueueSensor.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsScheduled	Returns true if this sensor has been scheduled and is waiting in a sensor queue to be triggered. (Inherited from SoSensor.)
	RemoveFile	Remove file from monitored list.
	Schedule	(Inherited from SoSensor.)
	SetBaseTime	Sets the base time. (Inherited from SoTimerSensor.)
	SetInterval	Sets the interval. (Inherited from SoTimerSensor.)
	SetSensorCB(SoSensorSensorCB)	Obsolete. Use Action property instead Sets the delegate that is invoked when the sensor is triggered. The function must take two arguments - user-supplied data (of type object) and a reference to the sensor that is triggering the function (of type SoSensor). (Inherited from SoSensor.)
	SetSensorCB(SoSensorSensorUserDataCB, Object)	Obsolete. Use Action property instead (Inherited from SoSensor.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unschedule	(Inherited from SoSensor.)

Top

Properties

	Name	Description
	Action	(Inherited from SoSensor.)

Top

Remarks

File sensors trigger their delegatefunction when a watched file changes. Files are checked at the interval specified with SoTimerSensor.setInterval.

Reference

OIV.Inventor.Sensors Namespace

OIV.Inventor.SensorsSoOneShotSensor

OIV.Inventor.SensorsSoAlarmSensor

OIV.Inventor.SensorsSoTimerQueueSensor

OIV.InventorSbTime