rsyncrosim (version 1.5.0)

ssimUpdate: Apply updates

Description

Apply updates to a SsimLibrary, or a Project or Scenario associated with a SsimLibrary.

Usage

ssimUpdate(ssimObject)
# S4 method for character
ssimUpdate(ssimObject)
# S4 method for SsimObject
ssimUpdate(ssimObject)

Value

Invisibly returns TRUE upon success (i.e.successful update) and FALSE upon failure.

Arguments

ssimObject

Session, Project, or SsimLibrary object. If NULL (default), session() will be used

Examples

if (FALSE) {
# Set the file path and name of the new SsimLibrary
myLibraryName <- file.path(tempdir(),"testlib")

# Set the SyncroSim Session, SsimLibrary, and Project
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession,
                         overwrite=TRUE)
myProject <- project(myLibrary, project = "My Project")

# Update Project
ssimUpdate(myProject)

# Create Scenario
myScenario <- scenario(myLibrary, scenario = "My Scenario")

# Update scenario
ssimUpdate(myScenario)
}