API Documentation

libCellML Namespace Reference

namespace libcellml

Typedefs

using ErrorPtr = std::shared_ptr<Error>

Type definition for shared error pointer.

using GeneratorPtr = std::shared_ptr<Generator>

Type definition for shared generator pointer.

using GeneratorProfilePtr = std::shared_ptr<GeneratorProfile>

Type definition for shared generator variable pointer.

using GeneratorVariablePtr = std::shared_ptr<GeneratorVariable>

Type definition for shared generator variable pointer.

using LoggerPtr = std::shared_ptr<Logger>

Type definition for shared parser pointer.

using ParserPtr = std::shared_ptr<Parser>

Type definition for shared parser pointer.

using PrinterPtr = std::shared_ptr<Printer>

Type definition for shared printer pointer.

using ValidatorPtr = std::shared_ptr<Validator>

Type definition for shared validator pointer.

using ComponentPtr = std::shared_ptr<Component>

Type definition for shared component pointer.

using ComponentEntityConstPtr = std::shared_ptr<const ComponentEntity>

Type definition for shared component entity const pointer.

using ComponentEntityPtr = std::shared_ptr<ComponentEntity>

Type definition for shared component entity pointer.

using EntityPtr = std::shared_ptr<Entity>

Type definition for shared entity pointer.

using ImportedEntityPtr = std::shared_ptr<ImportedEntity>

Type definition for shared imported entity pointer.

using ImportSourcePtr = std::shared_ptr<ImportSource>

Type definition for shared import source pointer.

using ModelPtr = std::shared_ptr<Model>

Type definition for shared model pointer.

using ResetPtr = std::shared_ptr<Reset>

Type definition for shared reset pointer.

using UnitsPtr = std::shared_ptr<Units>

Type definition for shared units pointer.

using VariablePtr = std::shared_ptr<Variable>

Type definition for shared variable pointer.

Enums

enum SpecificationRule

The SpecificationRule enum class.

Enum describing the specification rules that are used for validation.

Values:

UNDEFINED

DATA_REPR_IDENTIFIER_UNICODE

DATA_REPR_IDENTIFIER_LATIN_ALPHANUM

DATA_REPR_IDENTIFIER_AT_LEAST_ONE_ALPHANUM

DATA_REPR_IDENTIFIER_BEGIN_EURO_NUM

DATA_REPR_IDENTIFIER_IDENTICAL

DATA_REPR_NNEG_INT_BASE10

DATA_REPR_NNEG_INT_EURO_NUM

MODEL_ELEMENT

MODEL_NAME

MODEL_CHILD

MODEL_MORE_THAN_ONE_ENCAPSULATION

IMPORT_HREF

IMPORT_CHILD

IMPORT_CIRCULAR

IMPORT_UNITS_NAME

IMPORT_UNITS_REF

IMPORT_COMPONENT_NAME

IMPORT_COMPONENT_REF

UNITS_NAME

UNITS_NAME_UNIQUE

UNITS_STANDARD

UNITS_CHILD

UNIT_UNITS_REF

UNIT_DIGRAPH

UNIT_CIRCULAR_REF

UNIT_OPTIONAL_ATTRIBUTE

UNIT_PREFIX

UNIT_MULTIPLIER

UNIT_EXPONENT

COMPONENT_NAME

COMPONENT_CHILD

VARIABLE_NAME

VARIABLE_UNITS

VARIABLE_INTERFACE

VARIABLE_INITIAL_VALUE

RESET_CHILD

RESET_ORDER

RESET_VARIABLE_REFERENCE

RESET_TEST_VARIABLE_REFERENCE

RESET_TEST_VALUE

RESET_RESET_VALUE

MATH_MATHML

MATH_CHILD

MATH_CI_VARIABLE_REFERENCE

MATH_CN_UNITS_ATTRIBUTE

ENCAPSULATION_COMPONENT_REF

COMPONENT_REF_COMPONENT_ATTRIBUTE

COMPONENT_REF_CHILD

COMPONENT_REF_ENCAPSULATION

CONNECTION_COMPONENT1

CONNECTION_COMPONENT2

CONNECTION_UNIQUE_TRANSITIVE

CONNECTION_MAP_VARIABLES

MAP_VARIABLES_VARIABLE1

MAP_VARIABLES_VARIABLE2

MAP_VARIABLES_UNIQUE

Functions

unsigned int version()

Get the version number.

Returns the version of the library as a number.

Return

An unsigned int to represent the version.

std::string versionString()

Get the version string.

The version string is in the format x.y.z, where the “.”s are literal, and x,y and z represent counting numbers, in which case x is the major version, y the minor version, and z the patch level.

Return

A string to represent the version.

class Component : public libcellml::ComponentEntity, public libcellml::ImportedEntity, public std::enable_shared_from_this<Component>

#include <component.h>

The Component class.

The Component class is for representing a CellML Component.

class ComponentEntity : public libcellml::NamedEntity

#include <componententity.h>

The ComponentEntity class.

The interface class for managing Components.

Subclassed by libcellml::Component, libcellml::Model

class Entity

#include <entity.h>

The Entity class.

Base class for all libCellML core classes.

Subclassed by libcellml::ImportSource, libcellml::NamedEntity, libcellml::OrderedEntity

class Error

#include <error.h>

The Error class.

Base class for errors used with logger derived classes.

class Generator : public libcellml::Logger

#include <generator.h>

The Generator class.

The Generator class is for representing a CellML Generator.

class GeneratorProfile

#include <generatorprofile.h>

The GeneratorProfile class.

The GeneratorProfile class is for representing a CellML Generator Profile.

class GeneratorVariable

#include <generator.h>

The GeneratorVariable class.

The GeneratorVariable class is for representing a variable in the context of a CellML Generator, i.e. a constant, a computed constant or an algebraic variable.

class ImportedEntity

#include <importedentity.h>

The ImportedEntity class.

Base class for all importable libCellML classes.

Subclassed by libcellml::Component, libcellml::Units

class ImportSource : public libcellml::Entity

#include <importsource.h>

The ImportSource class.

The import source class is for defining a location at which a CellML model is expected to be obtainable (the source). The import source also acts as a handle to indicate that imported entities originate from the same instance of that imported source.

class Logger

#include <logger.h>

The Logger class.

Base class for all serialisable libCellML classes.

Subclassed by libcellml::Generator, libcellml::Parser, libcellml::Printer, libcellml::Validator

class Model : public libcellml::ComponentEntity, public std::enable_shared_from_this<Model>

#include <model.h>

The Model class.

The Model class is for representing a CellML Model.

class NamedEntity : public libcellml::Entity

#include <namedentity.h>

The NamedEntity class.

Base class for all nameable libCellML classes.

Subclassed by libcellml::ComponentEntity, libcellml::Units, libcellml::Variable

class OrderedEntity : public libcellml::Entity

#include <orderedentity.h>

The OrderedEntity class.

Base class for all nameable libCellML classes.

Subclassed by libcellml::Reset

class Parser : public libcellml::Logger

#include <parser.h>

The Parser class.

The Parser class is for representing a CellML Parser.

class Printer : public libcellml::Logger

#include <printer.h>

The Printer class.

The Printer class is for representing a CellML Printer.

class Reset : public libcellml::OrderedEntity

#include <reset.h>

The Reset class.

The Reset class is for describing a CellML reset.

class Units : public libcellml::NamedEntity, public libcellml::ImportedEntity

#include <units.h>

The Units class.

Class for Units.

class Validator : public libcellml::Logger

#include <validator.h>

The Validator class.

The Validator class is for representing a CellML Validator.

class Variable : public libcellml::NamedEntity, public std::enable_shared_from_this<Variable>

#include <variable.h>

The Variable class.

Class for each variable in libCellML.