Class AlloyField

Hierarchy

AlloyTypedSet
- AlloyField

Index

Constructors

constructor

Methods

Constructors

constructor

new AlloyField(id: string, types: AlloySignature[], tuples: AlloyTuple[], proxy?: AlloyProxy, varName?: string): AlloyField

Inherited from AlloyTypedSet.constructor
- Defined in AlloyField.ts:10
Create a new Alloy field.

Parameters
- id: string
  
  The field's unique ID
- types: AlloySignature[]
  
  An array of signatures defining the types of each column of the field
- tuples: AlloyTuple[]
  
  The tuples defined by the field
- Optional proxy: AlloyProxy
  
  If provided, a proxied signature will be created.
- Optional varName: string
  
  If provided, the variable name to assign to this field when proxied.
Returns AlloyField

Methods

clone

clone(signatures: AlloySignature[], proxy?: AlloyProxy): AlloyField

- Defined in AlloyField.ts:41
Create a clone of this field

Parameters
- signatures: AlloySignature[]
  
  An array of signatures. When creating the clone of this field, the types associated with each column are not cloned. Instead, provide an array of signatures and this method will find the corresponding types by signature ID in the array and use them to define types of the cloned field.
- Optional proxy: AlloyProxy
  
  If provided, a proxied clone will be returned.
Returns AlloyField

empty

empty(): boolean

Inherited from AlloyTypedSet.empty
- Defined in AlloySet.ts:23
Returns true if the set is empty, false if it is not.

Returns boolean

equals

equals(that: AlloySet): boolean

Inherited from AlloyTypedSet.equals
- Defined in AlloySet.ts:33
Returns true if this set is equivalent to the provided set, false otherwise.

Parameters
- that: AlloySet
  
  The set to compare to
Returns boolean

id

id(): string

- Defined in AlloyField.ts:70
Get the field ID.

Returns string

in

in(that: AlloySet): boolean

Inherited from AlloyTypedSet.in
- Defined in AlloySet.ts:43
Returns true if this set is a subset of the provided set, false otherwise.

Parameters
- that: AlloySet
  
  The set to compare to
Returns boolean

join

join(that: AlloySet): AlloySet

Inherited from AlloyTypedSet.join
- Defined in AlloySet.ts:57
Perform a join operation with another set. This operation is equivalent to the dot join operator in Alloy, in which this set is on the left side of the dot and that set is on the right side.

Parameters
- that: AlloySet
  
  The other set
Returns AlloySet

project

project(atoms: Map<AlloySignature, AlloyAtom>): void

Inherited from AlloyTypedSet.project
- Defined in AlloyTypedSet.ts:17
Parameters
- atoms: Map<AlloySignature, AlloyAtom>
Returns void

toString

toString(): string

Inherited from AlloyTypedSet.toString
- Defined in AlloySet.ts:84
Create a printable string representation of this set.

Returns string

tuples

tuples(): AlloyTuple[]

Inherited from AlloyTypedSet.tuples
- Defined in AlloySet.ts:93
Get an array of all tuples in this set.

Returns AlloyTuple[]

types

types(): AlloySignature[]

Inherited from AlloyTypedSet.types
- Defined in AlloyTypedSet.ts:38
Returns AlloySignature[]

Static fieldsFromXML

fieldsFromXML(instance: Element, sigIDs: Map<string, AlloySignature>, proxy?: AlloyProxy): AlloyField[]

- Defined in AlloyField.ts:84
Build all fields from an XML <instance> element. All fields are fully populated with tuples.

Parameters
- instance: Element
  
  The XML <instance> element
- sigIDs: Map<string, AlloySignature>
  
  A map of signature string IDs to signature objects
- Optional proxy: AlloyProxy
  
  If provided, all fields will be proxied.
Returns AlloyField[]