rds2cpp::EnvironmentIndex Struct Reference

Reference to an environment. More...

#include <RObject.hpp>

Inheritance diagram for rds2cpp::EnvironmentIndex:

Collaboration diagram for rds2cpp::EnvironmentIndex:

Public Member Functions
	EnvironmentIndex (SEXPType e=SEXPType::GLOBALENV_)
	EnvironmentIndex (size_t i)
SEXPType	type () const

Public Attributes
size_t	index
SEXPType	env_type

Detailed Description

Reference to an environment.

Constructor & Destructor Documentation

EnvironmentIndex() [1/2]

rds2cpp::EnvironmentIndex::EnvironmentIndex ( SEXPType  e = SEXPType::GLOBALENV_ )

inline

By default, this creates an EnvironmentIndex that refers to the global environment.

Parameters

e	Type of the environment.

EnvironmentIndex() [2/2]

rds2cpp::EnvironmentIndex::EnvironmentIndex ( size_t  i )

inline

This creates an EnvironmentIndex that refers to a non-global environment, i.e., is of type ENV.

Parameters

i	Value of the environment index.

Member Function Documentation

type()

SEXPType rds2cpp::EnvironmentIndex::type ( ) const

inlinevirtual

Type of environment. Most environments will be ENV but special environments can be constructed like GLOBALENV_.

Implements rds2cpp::RObject.

Member Data Documentation

env_type

SEXPType rds2cpp::EnvironmentIndex::env_type

Type of the environment, as returned by type(). This can be modified if it changes after construction.

index

size_t rds2cpp::EnvironmentIndex::index

Index into the environments vector of the RdsFile object. This is only used if type() returns ENV.

---

The documentation for this struct was generated from the following file:

• rds2cpp/RObject.hpp