attrData-class

Class "attrData"

A container class to manage generic attributes. Supports named attributes with default values with methods for vectorized access.

Keywords
classes
Objects from the Class

Objects can be created by calls of the form new("attrData", defaults). The defaults argument should be a named list containing the initial attribute names and default values.

Slots

data:
Where custom attribute data is stored
defaults:
A named list of known attribute names and defualt values.

Methods

attrDataItem<-
signature(self = "attrData", x = "character", attr = "character"): ...
attrDataItem
signature(self = "attrData", x = "character", attr = "missing"): ...
attrDataItem
signature(self = "attrData", x = "character", attr = "character"): ...
attrDefaults<-
signature(self = "attrData", attr = "character", value = "ANY"): ...
attrDefaults<-
signature(self = "attrData", attr = "missing", value = "list"): ...
attrDefaults
signature(self = "attrData", attr = "missing"): ...
attrDefaults
signature(self = "attrData", attr = "character"): ...
initialize
signature(.Object = "attrData"): ...
names
return the names of the stored attributes
names<-
set the names of the stored attributes
removeAttrDataItem
signature(self="attrData", x="character", value="NULL"): Remove the data associated with the key specified by x.

Aliases
  • attrData-class
  • attrDataItem<-,attrData,character,character-method
  • attrDataItem,attrData,character,missing-method
  • attrDataItem,attrData,character,character-method
  • attrDefaults<-,attrData,character,ANY-method
  • attrDefaults<-,attrData,missing,list-method
  • attrDefaults,attrData,missing-method
  • attrDefaults,attrData,character-method
  • initialize,attrData-method
  • names,attrData-method
  • names<-,attrData,character-method
  • removeAttrDataItem<-
  • removeAttrDataItem<-,attrData,character,NULL-method
Examples
defaultProps <- list(weight=1, color="blue", friends=c("Bob", "Alice"))
adat <- new("attrData", defaults=defaultProps)

## Get all defaults
attrDefaults(adat)

## Or get only a specific attribute
attrDefaults(adat, attr="color")

## Update default weight
attrDefaults(adat, attr="weight") <- 500

## Add new attribute
attrDefaults(adat, attr="length") <- 0

## Asking for the attributes of an element you haven't customized
## returns the defaults
attrDataItem(adat, x=c("n1", "n2"), attr="length")

## You can customize values
attrDataItem(adat, x=c("n1", "n2"), attr="length") <- 5

## What keys have been customized?
names(adat)

Documentation reproduced from package graph, version 1.50.0, License: Artistic-2.0

Community examples

Looks like there are no examples yet.