[OPUS]

ÿ -


Availability:

This class is available for the OPUS Blackboard API. The initial OPUS 2.0 release is described here

Constructors:

Methods:

Description

Example

none


::low_store_check - Check disk space available against requirements

Synopsis


Returns

true - if insufficient disk space exists to continue false - if sufficient disk space exists to continue or exit IOWAIT

Exceptions Thrown

none

Description

Compares the available disk space on the device occupied by the file name argument against the minimum blocks value, if the process is not in IOWAIT, or against the resume block value, if the process is in IOWAIT.

Example

  
    none
  


::file_action_exec - Execute the FILE_ACTION specified by a File_entry Field

Synopsis


Returns

true - if process executed false - if process executed but returned a status other than success

Exceptions Thrown

none

Description

Completion of File_event processing optionally includes spawning a subprocess to execute a specified command. OPUS executes such a FILE_ACTION through a Command on the Command Blackboard; this function performs the actual subprocess spawning, and returns a boolean value depending on the end state of the subprocess.

Example

  
    none
  


::file_exists - Verify that the indicated file exists.

Synopsis


Returns

true - if it exists false - if it does not exist

Exceptions Thrown

none

Description

Attempts to do a stat on the file object.

Example

  
    none
  


::test_command - A test Command function used by the Command Blackboard's test driver.

Synopsis


Returns

true

Exceptions Thrown

none

Description

This function always returns true.

Example

  
    none