first meta- – ISA\\Elements\Containment\Spacials

Parent

Containment

Data
Spacials
Information This assembly is where all the primitive elements implementing a Container – Contained relationship are defined for containment being spacial (aka in memory).
Assembly data
Edition
Version 1
Country None.
Language None.
Number 1
Dependencies None.
Inhibit all invariants False.
Ideas.
Diagram

Spacials (Containment) Assembly

Classes
Array
Information An array of Type T. 

The Array Element is the way maximum multiplicity greater than 1 is implemented for individual Type (fields) in Objects. This always true for Element implementers are free to use other data structure.
Field
A Sbytes containing the Value items.
Attributes
Indexed access to an item.
Length: Natural The number of items.
Properties
The type on the items contained by the Array.
Capacity: Natural* The current maximum number of items in the array. If the capacity is exceeded then the internal buffer is reallocated following a growing policy and the first items are copied.
Constructors
Build an empty array of a given capacity for a given type T.
Build an array from a given initialization string of items of a given type T.
Queries
Get an to browse thru items one by one (implements the Traversable ).
Read a part of an array an returns a sub-array.
Commands
Insert one Value
Insert one or more Values
Replace by a Value
Replace by one or more Values
Remove(Start index: Natural*, End index: Natural* [0..1] = Start index) Remove a part of the Values
Clear() Remove all the Values
Pack() Pack the Values in order for the length to be equals to the capacity.
Destructor
Delete() Decrements references count on all the objects contained by the array, and then delete the array.
Array
Browser
Information A Browser can be used to step through collection of spacial items such as lists and arrays. Spacial items means that the number of items is known and that the time to go thru is bounded by its number of items (Length).
Field
 The collection of the iterated items.
Index : Natural The current position index in the Browser.
Properties
Sorted : Boolean ◈ True if the items are browsed in an ordered manner.
Length: Natural The number of items.
Constructor
The base constructor
Command
Move the browser internal index of 1 step forward and return the item.

The “has next“check is a precondition on this command. It is performed before calling the body of this command. Precondition violation results in throwing an Exception having the circumstance Precondition.
It is also callable by the user program before invoking the Get next command.  Here a Boolean will be returned.
Browser
Contained
Information A Contained is an abstract generic Element which have a payload, and that is within a Container.
Contained
Container
Information A Container is an abstract generic Element which contains Contained.
Property
The Abstract data type of the contained payload.
Container
Link
Information A Link is a Value having neighborhoods.
Attributes
Forward : Link [0..1)] ▣
 The neighborhood on the forward direction.
Backward : Link [0..1)] ▣
 The neighborhood on the backward direction.
Constructor
Base constructor
Link
Linked list
Information A list of Links. This structure is flat since the Links are just juxtaposed one by one.

A Link is never accessible from the outside in order to ensure consistency. Sorting is under user responsibility.
Field
The first in the string of links.
The last in the string of links.
Properties
The type on the items contained by the linked list.
Length: Natural The number of items.
Attributes
Access to an individual item.
Constructor
Create an empty linked list.
Build a linked list from a given initialization string of items of type T.
Query
Get an to browse thru items one by one (implements the  Traversable interface)
Commands
Insert one Value
Remove(Index: Natural*) Remove one Value at an index.
Remove(Position: Position) Remove one Value at a position.
Remove the first occurrence of a Value.
Clear() Remove all the Values
Destructor
Delete Decrements references count on all the objects contained by the list, and then delete the list.
Linked list
Ordered value
Information An Ordered value is Value having a full order relationship.
Constructor
The base constructor.
Queries
The order comparison operators.
Invariant
T must implements the Ordered interface
The parametric Type T must implements the  order comparison operators to which the comparison are delegated to
Ordered value
Pair
Information A pair of key-value is a set of two linked data items: a key, which is a unique identifier for some item of data, and the value, which is the data that is identified.
Field
Key : Key
 The key in the key/value pair.
Note kind Explanation
Text It can seems curious to rely on a sub Assembly containing the Key element type.  This is due to several considerations.
  1. The ISA bootstrap have justified circular dependencies (see LL Assembly).
  2. A Key is a Single that is some where just an handler for . So everywhere a Key appears a could be used, but using a Key allows to have a direct textual representation for the key without needing  obscure hash coding or binary. This allows humans to control the key name without any cost at runtime.
Property
Key : Key ▣
 The key in the key/value pair.  The key is conspired to have a full ordered relationship, even if in the use case it is not the case.

While affected at construction time the Key cannot be modified in order to prevent positioning alteration in a Table.
Constructor
Base constructor.
Queries
The order comparison operators applied on the key. These queries are only relevant if the key is computed in a way that warranties a fully ordered relationship.
Pair
Parameter
Information A Parameter element is the representation at run time of a Parameter defined in the (See metaclass Parameter). It provides a support to make software flexible either thru configuration of by settings being changeable at run time.
Field
The list of the Statement (values) for this parameter.
Attributes
Require an assembly reload: Boolean = False ◈ Specifies if an update of this parameter require the Assembly to be reloaded for the new value to be taken into account.
Access to the Statements.
Property
Definition: ISA\\Metamodel\Types\Parameter ◈ The parameter defined in the this parameter element is representing.
Queries
Getting a value of the parameter.
Get an to browse thru items one by one (implements the Traversable interface).
Constructor
The base constructor.
Parameter
Parameters
Information A container of Parameter providing a flexible and featured parameters management.
Field
The parameters in an associative table. The pair key is a hash code of the Parameter definition parameters literal.
Properties
The type here is variable since each parameter have a specific one. So the only common shared type of parameters is Type.
Length: Natural The number of parameters.
Keys: Key [0..∞] The keys of the contained pairs.
Attribute
Access to an individual parameter.
Constructor
Parameters(Assembly : Assembly, Kind : Parameter kind)
Build Parameters element from the Assembly definition
Query
Get an to browse thru parameter one by one (implements the Traversable interface).
Get a Parameter element by its literal name with all its Statement.
Get the current Statement element of a Parameter element by its literal name for a given .
Destructor
Delete() Decrements references count on all the objects contained by the parameters table, and then delete the parameters.
Parameters
Sbytes
Information An array of . This mean a contiguous list of in the addressing space, typically in the memory.

This Type can be used in several ways and typically as a buffer. It provided the basic support for fields of Elements having a maximum multiplicity greater that 1.

The first position of the contiguous list is reserved to support the sizes: the 32 first bits are used for capacity and the 32 endian ones are for length.

The capacity count the number of rooms the buffer has. And the length count the number of used rooms at the beginning of the buffer.
Formulas:
  • Capacity property = capacity 
  • Length attribute = length 
Field
$ The internal buffer. The minimum size is 2, because the first room is for the sizes and a that a buffer with a capacity less that 1 room do not make sence.
Property
Capacity The maximum number of available rooms. This property cannot be changed.
Attribute
Length The count of used rooms. The buffer user must update this attribute accurately.
Item(Index: Natural*)
 Access to an individual item.
Constructor
Sbytes (Initial capacity, Initializer)
 Build a Sbytes with an Initial capacity. If provided the Initializer is copied to the newly created Sbytes, therefore the Initial capacity must be superior or equals of these of the Initializer.
Query
Read(Start index: Natural*, End index: Natural*)
 Read a part of the Sbytes as a new Sbytes.
Command
Insert(Sbyte: Sbyte, Index: Natural*)
 Insert one SByte
Insert(Sbytes: Sbytes, Index: Natural*)
 Insert one SBytes
Replace(Sbyte: Sbyte, Index: Natural*)
 Replace by a SByte
Replace(Sbytes: Sbytes, Startindex: Natural*)
 Replace by a SBytes
Remove(Startindex: Natural*, Endindex: Natural*)
 Remove a part of the SBytes
Pack() Pack the SBytes in order for the length to be equals to the capacity.
Sbytes
Sorted array
Information A sorted array of Type T. 

The Sorted array Element is the way maximum multiplicity greater than 1 is implemented for individual Type (fields) having an Ordered constraint.
Field
A Sbytes containing the Ordered value items.
Attributes
Length: Natural The number of items.
Properties
Indexed access to an item.
The type on the items contained by the Array.
Capacity: Natural* The current maximum number of items in the array. If the capacity is exceeded then the internal buffer is reallocated following a growing policy and the first items are copied.
Constructors
Build an empty array of a given capacity for a given type T.
Build an array from a given initialization string of type T an sort it.
Build a sorted array from an array of a given type T an sort it.
Queries
Get an to browse thru items one by one (implements the Traversable interface).
Read a part of an array an returns a sub-array.
Commands
Add one Value
Remove one Value
Remove(Start index: Natural*, End index: Natural* [0..1] = Start index) Remove a part of the Values
Clear() Remove all the Values
Pack() Pack the Values in order for the length to be equals to the capacity.
Destructor
Delete() Decrements references count on all the objects contained by the array, and then delete the array.
Sorted array
Spacial container
Information A container of items in the space (memory, storage).
Spacial container
Statement
Information A Statement is a establishing a parameter. A parameter being either for configuration or setting purpose, and also of nature technical, or business.
Attributes
Applicability: Temporal interval [0..1] ◈ The temporal period this statement applies.
: String [0..1] ◈ Specify the on which the statement only applies. Can be anything managed by the program, like an Organization id for .
Constructor
The base constructor.
Statement
Table
Information An associative table of Pair.

The Table Element is the way maximum multiplicity greater than 1 is implemented for Pair.
Field
A Sbytes containing the Pair items.
Properties
The type on the items contained by the Table.
Length: Natural
 The number of items.
Keys: Key [0..∞]
 The keys of the contained pairs.
The contained pairs.
Attribute

Item

 Access to an individual item.
Constructors
Build an empty table of a given capacity for a given type T.
Build an array from a given initialization string of items of a given type T.
Query
Get an object to browse thru items one by one (implements the Traversable interface).
Commands
Add a Pair. If a Pair is already present for this Key it is replaced.
Add a Pair by computing a Key using the Hash code property of the Value. If a Pair is already present for this Key it is replaced.
Remove (Key: Key) Remove the Pair having this Key.
Clear() Remove all the Pairs.
Destructor
Delete() Decrements references count on all the objects contained by the table, and then delete the table.
Table
Traversable
Information An interface for a Type with  items that can be browsed one after by one.
Query
Get an object to browse thru items one by one.
The Direction specifies if the traversal is done for the first to the last (Forward – This is the default) or from the last to the first (Backward).
Traversable
Value
Information This element support the Valuable concept on a Type that can is parametric .
Field
Value : Sbyte
 The value or a pointer to it depending of the parametric Type.
Attribute
The read write access to the value of the T Type.
Constructor
The base constructor
Notes
Kind Explanation
Text The Value is not a Single because it is extendable not limited to a sole single and value. It is also has a parametric Type, since Single descendants have a fixed built-in Type.
Value
Assemblies

None

Version and status

Version Date Description Status
V1R1 02-Jul-19 Initial. Candidate

 

Related posts:

  1. Relationships Assembly
  2. Containment Assembly
  3. Identity Assembly
  4. Temporals (Containment) Assembly
  5. Elements Assembly
Tags: Addressing, Assembly, Classifier, Instance, Interface, LL, Model, Object, sbyte, Scope

Leave a Reply

Your email address will not be published. Required fields are marked *

This site uses Akismet to reduce spam. Learn how your comment data is processed.