Options
All
  • Public
  • Public/Protected
  • All
Menu

A mixin for the dependency entity at the Scheduler Pro level. It adds lag and lagUnit fields.

The calendar according to which the lag time is calculated is defined with the dependenciesCalendar config of the project.

Hierarchy

Index

Properties

$project

The project instance, this entity belongs to.

active

active: Boolean

Indicates whether the dependency is active (true) or not (false). Non-active dependencies do not affect linked tasks scheduling.

calendar

The calendar of the dependency used to take lag duration into account.

fromEvent

The event at which the dependency starts

fromSide

fromSide: string

The from side

getLag

getLag: () => Duration

Generated getter for the lag.

Type declaration

graph

graph: Replica

A reference to the graph, this entity belongs to. Initially empty, and is populated when the entity instance is added to the replica (Replica.addEntity)

lag

The lag (lead) for dependency. Negative values can be used to provide lead. Please note, that only working time is counted in. The working time is defined with the dependency calendar which configured on the project level with dependenciesCalendar option (by default successor event calendar is used).

See also lagUnit

lagUnit

lagUnit: TimeUnit

The duration unit for the dependency lag

project

The project instance, this entity belongs to.

toEvent

The event at which the dependency ends

toSide

toSide: string

The to side

type

The type of the dependency

Accessors

$

  • get $(): {}
  • An object, which properties corresponds to the ChronoGraph Identifiers, created for every field.

    For example:

    class Author extends Entity.mix(Base) {
        @field()
        firstName       : string
        @field()
        lastName        : string
    }
    
    const author = Author.new()
    
    // identifier for the field `firstName`
    author.$.firstName
    
    const firstName = replica.read(author.$.firstName)

    Returns {}

$$

  • A graph identifier, that represents the whole entity.

    Returns EntityIdentifier

$entity

  • An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.

    Returns EntityMeta

Static $entity

  • An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.

    Returns EntityMeta

Methods

commit

  • This is a convenience method, that just delegates to the ChronoGraph.commit method of this entity's graph.

    If there's no graph (entity has not been added to any replica) a CommitZero constant will be returned.

    Parameters

    Returns CommitResult

commitAsync

  • This is a convenience method, that just delegates to the ChronoGraph.commitAsync method of this entity's graph.

    If there's no graph (entity has not been added to any replica) a resolved promise with CommitZero constant will be returned.

    Parameters

    Returns Promise<CommitResult>

enterGraph

  • enterGraph(replica: Replica): void
  • This method is called when entity is added to some replica.

    Parameters

    Returns void

getAssignmentById

  • getAssignmentById(id: ModelId): this["project"]["assignmentStore"]["modelInstanceT"]

getAssignmentStore

  • getAssignmentStore(): this["project"]["assignmentStore"]

getCalendarById

  • getCalendarById(id: ModelId): this["project"]["calendarManagerStore"]["modelInstanceT"]

getCalendarManagerStore

  • getCalendarManagerStore(): this["project"]["calendarManagerStore"]

getDependencyById

  • getDependencyById(id: ModelId): this["project"]["dependencyStore"]["modelInstanceT"]

getDependencyStore

  • getDependencyStore(): this["project"]["dependencyStore"]

getEventById

  • getEventById(id: ModelId): this["project"]["eventStore"]["modelInstanceT"]

getEventStore

  • getEventStore(): this["project"]["eventStore"]

getGraph

getProject

  • getProject(): this["project"]

getResourceById

  • getResourceById(id: ModelId): this["project"]["resourceStore"]["modelInstanceT"]

getResourceStore

  • getResourceStore(): this["project"]["resourceStore"]

joinProject

  • joinProject(): void

leaveGraph

  • This method is called when entity is removed from the replica it's been added to.

    Parameters

    Returns void

leaveProject

  • leaveProject(isReplacing?: boolean): void

setLag

setProject

  • setProject(project: this["project"]): this["project"]

userProvidedValue

Generated using TypeDoc