name: Name of a SsimLibrary, Project, Scenario, Folder, or Chart

In syncrosim/rsyncrosim: The R Interface to 'SyncroSim'

Name of a SsimLibrary, Project, Scenario, Folder, or Chart

Description

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

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)

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

## S4 method for signature 'Chart'
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

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

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

Arguments

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

Value

A character string: the name of the SsimObject.

Examples

## Not run: 
# 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,
                         packages = "stsim")
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")
myFolder <- folder(myProject, folder = "New Folder")
myChart <- chart(myProject, chart = "New Chart")

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

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

## End(Not run)

syncrosim/rsyncrosim documentation built on Oct. 18, 2024, 1:29 a.m.