• NAME
• METHODS
  • open()
  • close()
  • load()
  • save()
  • delete

NAME

DataContainer::File Class to interface a DataContainer with a file. Placeholder and is to be overridden.

METHODS

open()

Open connection to DataContainer-file.

Accepts one parameter, "name" to specify the name of the file to open.

The method checks the mode()-method to find out which mode the DataContainer might be in.

Returns 1 upon success, 0 upon failure.

See documentation of the DataContainer-class for more information on this method.

close()

Attempts to close the DataContainer if possible.

Accepts no input.

Returns 1 upon success, 0 upon failure.

load()

Loads data into the DataContainer.

Optional parameter of "name" might be given. SCALAR. Optional. If specified overrides the parameter set by the constructor.

Returns 1 upon success, 0 upon failure. Please check the error()-method upon failure.

save()

Attempt to save data into the DataContainer.

Optional parameter "name" which specified where to store the file? If not specified, defaults to what was specified to the new()-constructor.

Returns 1 upon success, 0 upon failfure. Please check the error()-method upon any failure for more information.

delete

Removing data from the DataContainer.

Optional parameter "name" might be specified. SCALAR. Sets the name of the DataContainer. Only has meaning to the inheriting class, and in this case it refers to the file-name.

Returns 1 upon success, 0 upon failure. Please check the error()-method for more information upon failure.