name: Name of a SsimLibrary, Project or Scenario

In rsyncrosim: The R Interface to 'SyncroSim'

Name of a SsimLibrary, Project or Scenario

Description

Retrieves or sets the name of a SsimLibrary, Project or Scenario.

Usage

name(ssimObject)

## S4 method for signature 'character'
name(ssimObject)

## S4 method for signature 'SsimLibrary'
name(ssimObject)

## S4 method for signature 'Scenario'
name(ssimObject)

## S4 method for signature 'Project'
name(ssimObject)

name(ssimObject) <- value

## S4 replacement method for signature 'character'
name(ssimObject) <- value

## S4 replacement method for signature 'SsimLibrary'
name(ssimObject) <- value

## S4 replacement method for signature 'Project'
name(ssimObject) <- value

## S4 replacement method for signature 'Scenario'
name(ssimObject) <- value

Arguments

ssimObject	Scenario, Project, or SsimLibrary object
value	character string of the new name

Value

A character string: the name of the SsimObject.

Examples

# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set up a SyncroSim Session, SsimLibrary, Project, and Scenario
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")

# Retrieve names of the SsimObjects
name(myLibrary)
name(myProject)
name(myScenario)

# Set the name of the SyncroSim Scenario
name(myScenario) <- "My Scenario Name"

rsyncrosim documentation built on Oct. 8, 2022, 9:06 a.m.