RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/com.reactific.riddl.language.ast/Definitions/Application

Application

com.reactific.riddl.language.ast.Definitions.Application
case class Application(loc: At, id: Identifier, options: Seq[ApplicationOption], types: Seq[Type], constants: Seq[Constant], groups: Seq[Group], handlers: Seq[Handler], inlets: Seq[Inlet], outlets: Seq[Outlet], functions: Seq[Function], authors: Seq[AuthorRef], terms: Seq[Term], includes: Seq[Include[ApplicationDefinition]], brief: Option[LiteralString], description: Option[Description]) extends Processor[ApplicationOption, ApplicationDefinition], DomainDefinition

An application from which a person, robot, or other active agent (the user) will obtain information, or to which that user will provided information.

Value parameters

authors

Author definitions for the application, for attribution of application components.

brief

A brief description of the application

description

A longer description of the application.

groups

A list of group definitions needed by the application

handlers

The handlers for this application to process incoming messages

id

The unique identifier for the application

includes

Included source code

inlets

Message inlets for the application

loc

The location of the application in the source

options

The options for the application

outlets

Message outlets for the application

terms

Definitions of terms useful in comprehending the application's purpose

types

Types that are needed for the communication with the user

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 kind: String

Attributes

Definition Classes

Inherited methods

def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
def completeness: (Int, Int)

Compute the completeness of this definition.

Compute the completeness of this definition. Vital definitions should have options, terms, and authors but includes are optional. Incompleteness is signalled by child definitions that are empty.

Attributes

Returns

A numerator and denominator for percent complete

Inherited from:
VitalDefinition
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 <: ApplicationOption : ClassTag]: Option[Seq[LiteralString]]

Attributes

Inherited from:
WithOptions
override def hasAuthors: Boolean

Attributes

Definition Classes
Inherited from:
WithAuthors
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasOption[OPT <: ApplicationOption : 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
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
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 from:
WithOptions
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
override def isVital: Boolean

Attributes

Definition Classes
Inherited from:
VitalDefinition
def maturity: Int

Compute the 'maturity' of a definition.

Compute the 'maturity' of a definition. Maturity is a score with no maximum but with scoring rules that target 100 points per definition. Maturity is broken down this way:

  • has a description - up to 50 points depending on # of non empty lines

  • has a brief description - 5 points

  • has options specified - 5 points

  • has terms defined -

  • has an author in or above the definition - 5 points \-

  • definition specific things: 0.65

Attributes

Returns
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[ApplicationDefinition]

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