coral
A C++ library for distributed co-simulation
Public Member Functions | List of all members
coral::model::VariableDescription Class Reference

A description of a single variable. More...

#include "coral/model.hpp"

Public Member Functions

coral::model::VariableID ID () const
 An identifier which uniquely refers to this variable in the context of a single slave type. More...
 
const std::stringName () const
 A human-readable name for the variable. More...
 
coral::model::DataType DataType () const
 The variable's data type.
 
coral::model::Causality Causality () const
 The variable's causality.
 
coral::model::Variability Variability () const
 The variable's variability.
 

Detailed Description

A description of a single variable.

Member Function Documentation

coral::model::VariableID coral::model::VariableDescription::ID ( ) const

An identifier which uniquely refers to this variable in the context of a single slave type.

Variable IDs are not unique across slave types.

const std::string& coral::model::VariableDescription::Name ( ) const

A human-readable name for the variable.

The name is unique in the context of a single slave type.


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