Function

com.reactific.riddl.language.AST.Function

A function definition which can be part of a bounded context or an entity.

Value parameters

authors

References to the authors that helped write this function

brief

A brief description (one sentence) for use in documentation

description

An optional description of the function.

functions

The set of function definitions for use in the function

id

The identifier that names the function

includes

Inclusion of other files to complete this function definition

input

An optional type expression that names and types the fields of the input of the function

loc

The location of the function definition

options

The options for this function that might affect how it behaves

output

An optional type expression that names and types the fields of the output of the function

statements

The set of statements that define the behavior of this function

terms

The definition of glossary terms related to this function

types

The set of type definitions for use in the function

Attributes

Graph
Supertypes

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

Attributes

Inherited from:
BrieflyDescribedValue

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

Attributes

Inherited from:
WithOptions
override def hasAuthors: Boolean

Attributes

Definition Classes
Inherited from:
WithAuthors

Attributes

Inherited from:
BrieflyDescribedValue
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition

Attributes

Inherited from:
DescribedValue

Attributes

Inherited from:
WithOptions
override def hasOptions: Boolean

Attributes

Definition Classes
Inherited from:
WithOptions

Attributes

Inherited from:
WithTerms
override def hasTypes: Boolean

Attributes

Definition Classes
Inherited from:
WithTypes

Attributes

Inherited from:
Definition

Attributes

Inherited from:
Definition

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

Attributes

Inherited from:
Definition

Attributes

Inherited from:
Container
override def isVital: Boolean

Attributes

Definition Classes
Inherited from:
VitalDefinition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product

Attributes

Inherited from:
Definition

Concrete fields

lazy override val contents: Seq[FunctionDefinition]
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