RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/AST/Entity

Entity

com.reactific.riddl.language.AST.Entity
case class Entity(loc: At, id: Identifier, options: Seq[EntityOption], states: Seq[State], types: Seq[Type], constants: Seq[Constant], handlers: Seq[Handler], functions: Seq[Function], invariants: Seq[Invariant], inlets: Seq[Inlet], outlets: Seq[Outlet], includes: Seq[Include[EntityDefinition]], authors: Seq[AuthorRef], terms: Seq[Term], brief: Option[LiteralString], description: Option[Description]) extends Processor[EntityOption, EntityDefinition], ContextDefinition

Definition of an Entity

Value parameters

brief

A brief description (one sentence) for use in documentation

description

Optional description of the entity

functions

Utility functions defined for the entity

handlers

A set of event handlers

id

The name of the entity

invariants

Invariant properties of the entity

loc

The location in the input

options

The options for the entity

states

The state values of the entity

types

Type definitions useful internally to the entity definition

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait WithTypes
trait WithTerms
trait WithAuthors
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def isEmpty: Boolean

determine if this node is empty or not.

determine if this node is empty or not. Non-containers are always empty

Attributes

Definition Classes

Inherited methods

def asVital[OPT <: OptionValue, DEF <: Definition]: VitalDefinition[OPT, DEF]

Attributes

Inherited from:
Definition
def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
def descriptionValue: String

Attributes

Inherited from:
DescribedValue
override def format: String

Format the node to a string

Format the node to a string

Attributes

Definition Classes
Inherited from:
WithOptions
def getOptionValue[OPT <: EntityOption : ClassTag]: Option[Seq[LiteralString]]

Attributes

Inherited from:
WithOptions
override def hasAuthors: Boolean

Attributes

Definition Classes
Inherited from:
WithAuthors
def hasBriefDescription: Boolean

Attributes

Inherited from:
BrieflyDescribedValue
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasDescription: Boolean

Attributes

Inherited from:
DescribedValue
def hasOption[OPT <: EntityOption : ClassTag]: Boolean

Attributes

Inherited from:
WithOptions
override def hasOptions: Boolean

Attributes

Definition Classes
Inherited from:
WithOptions
def hasTerms: Boolean

Attributes

Inherited from:
WithTerms
override def hasTypes: Boolean

Attributes

Definition Classes
Inherited from:
WithTypes
def identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
def isAppRelated: Boolean

Attributes

Inherited from:
Definition
override def isContainer: Boolean

Determine if this node is a container or not

Determine if this node is a container or not

Attributes

Definition Classes
Inherited from:
Container
override def isDefinition: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
override def isVital: Boolean

Attributes

Definition Classes
Inherited from:
VitalDefinition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolveNameTo(name: String): Option[Definition]

Attributes

Inherited from:
Definition

Concrete fields

lazy override val contents: Seq[EntityDefinition]
final val kind: String

Implicits

Inherited implicits

implicit def bool2int(b: Boolean): Int

Implicit conversion of boolean to Int for easier computation of statistics below

Implicit conversion of boolean to Int for easier computation of statistics below

Value parameters

b

The boolean to convert to an Int

Attributes

Returns
Inherited from:
VitalDefinition
Generated with