Options
All
  • Public
  • Public/Protected
  • All
Menu

This is an event class, SchedulerProProjectMixin is working with. It is constructed as SchedulerBasicEvent, enhanced with extra functionality.

Hierarchy

Index

Properties

Accessors

Methods

Properties

$project

The project instance, this entity belongs to.

assigned

assigned: Set<InstanceType<this["project"]["assignmentModelClass"]>>

A set of resources assigned to this task

calendar

The calendar of this entity.

Please use effectiveCalendar to get the calendar that is actually used by the entity. The calendar reflects only the value provided to this entity while effectiveCalendar returns the calendar that is really used (falls back to the project calendar in case the own calendar is not provided).

childEvents

childEvents: Set<HasChildrenMixin>

A set of references to child events

constraintDate

constraintDate: Date

The date of the constraint, applied to this event

constraintType

constraintType: ConstraintType

The type of constraint, applied to this event

direction

direction: Direction

The scheduling direction of the event. The Forward direction corresponds to the as-soon-as-possible scheduling (ASAP), Backward - to as-late-as-possible (ALAP).

If not specified (which is the default), direction is inherited from the parent task (and from project for the top-level tasks). By default, the project model has forward scheduling mode.

dispatcher

dispatcher: SEDDispatcher

The dispatcher instance for this event. Dispatcher accumulates the information about user input and decide which formula to use for calculation of every related field (startDate, endDate and duration at this level).

Every field can be calculated with 2 type of formulas. The 1st one is called "proposed" and it is used when there is a user input for this field ("proposed" input), or, when user intention is to keep the previous value of the field. The 2nd type is called "pure" and it is used, when a value of the field should be calculated "purely" based on the values of other fields.

See CycleResolverGuide for more information.

duration

duration: Duration

The duration of the event. See also durationUnit.

durationUnit

durationUnit: TimeUnit

The duration unit of the event's duration. See also duration.

earlyEndDate

earlyEndDate: Date

The earliest possible date the event can finish. This value is calculated based on the event restrictions.

earlyStartDate

earlyStartDate: Date

The earliest possible date the event can start. This value is calculated based on the event restrictions.

effectiveCalendar

effectiveCalendar: BaseCalendarMixin

The effective calendar used by this entity (either its own calendar if provided or the project calendar) for data calculation purposes.

effectiveVisualCalendar

effectiveVisualCalendar: BaseCalendarMixin

The effective calendar used by this entity (either its own calendar if provided or the project calendar) for data visualizing purposes.

effort

effort: Duration

The effort of this event. See also effortUnit.

effortDriven

effortDriven: boolean

Whether the effort of the task is "fixed". The FixedEffortMixin operates as if this flag is always enabled.

effortUnit

effortUnit: TimeUnit

The time unit of the effort field.

endDate

endDate: Date

The end date of the event. Can also be provided as a string, parsable with DateHelper.parse()

endDateConstraintIntervals

endDateConstraintIntervals: DateInterval[]

Field to accumulate the "generic" constraints for end date (which are not related to ASAP scheduling). It is calculated with calculateEndDateConstraintIntervals.

getCalendar

getCalendar: () => BaseCalendarMixin

Gets the calendar.

Type declaration

getDirection

getDirection: () => Direction

Getter for direction field.

Type declaration

getEffortDriven

getEffortDriven: () => boolean

Generated getter for the effortDriven field.

Type declaration

    • (): boolean
    • Returns boolean

getEffortUnit

getEffortUnit: () => TimeUnit

Generated getter for the effortUnit

Type declaration

getEndDate

getEndDate: () => Date

Gets the event end date.

Type declaration

    • (): Date
    • Returns Date

getSchedulingMode

getSchedulingMode: () => SchedulingMode

Generated getter for the schedulingMode field.

Type declaration

getStartDate

getStartDate: () => Date

Gets the event start date

Type declaration

    • (): Date
    • Returns Date

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)

hasPostponedOwnConstraintConflict

hasPostponedOwnConstraintConflict: boolean

This flag indicates that task has a postponed scheduling conflict.

ignoreResourceCalendar

ignoreResourceCalendar: boolean

Ignore assigned resource calendars when scheduling the event. If setting this to true the event dates/duration will be calculated based on the event calendar only.

inactive

inactive: Boolean

Inactive events do not affect successors nor rollup their attributes to parent events.

incomingDeps

incomingDeps: Set<InstanceType<this["project"]["dependencyModelClass"]>>

A set of incoming dependencies for this task (dependencies which ends at this task)

isSegmented

isSegmented: boolean

Indicates whether the event is segmented or not. Is set to true if the event is segmented and false otherwise.

manuallyScheduled

manuallyScheduled: boolean

A boolean field, indicating whether this event should be scheduled automatically or its startDate and endDate are supposed to be defined manually.

outgoingDeps

outgoingDeps: Set<InstanceType<this["project"]["dependencyModelClass"]>>

A set of outgoing dependencies from this task (dependencies which starts at this task)

parentEvent

parentEvent: HasChildrenMixin

A reference to the parent event

percentDone

percentDone: number

The percent done for this event.

project

The project instance, this entity belongs to.

schedulingMode

schedulingMode: SchedulingMode

The scheduling mode of the task.

setCalendar

setCalendar: (calendar: BaseCalendarMixin | ModelId) => Promise<CommitResult>

Sets the calendar. The method triggers schedule change propagation and returns a Promise:

// set calendar
model.setCalendar(calendar1).then(() => {
    // some code to run after schedule got updated
    ...
})

It also adds the calendar to the project calendar manager.

Type declaration

setConstraintDate

setConstraintDate: (constrainDate: Date) => Promise<CommitResult>

Sets the constraint date of the event.

param

Constraint date.

returns

Promise

Type declaration

setConstraintType

setConstraintType: (constrainType: ConstraintType) => Promise<CommitResult>

Sets the constraint type of the event.

param

Constraint type.

returns

Promise

Type declaration

setDirection

setDirection: (value: Direction) => Promise<CommitResult>

Setter for direction field.

Type declaration

setEffort

setEffort: (effort: Duration, unit?: TimeUnit) => Promise<CommitResult>

Generated setter for the effort

Type declaration

setEffortDriven

setEffortDriven: (effortDriven: boolean) => Promise<CommitResult>

Generated setter for the effortDriven field.

Type declaration

setSchedulingMode

setSchedulingMode: (schedulingMode: SchedulingMode) => Promise<CommitResult>

Generated setter for the schedulingMode field.

Type declaration

startDate

startDate: Date

The start date of the event. Can also be provided as a string, parsable with DateHelper.parse()

startDateConstraintIntervals

startDateConstraintIntervals: DateInterval[]

Field to accumulate the "generic" constraints for start date (which are not related to ASAP scheduling). It is calculated with calculateStartDateConstraintIntervals.

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

earlyPreSchedule

earlySchedule

firstSegment

  • get firstSegment(): InstanceType<this["segmentModelClass"]>

lastSegment

  • get lastSegment(): InstanceType<this["segmentModelClass"]>

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

assign

  • assign(resource: InstanceType<this["project"]["resourceModelClass"]>): Promise<any>

calculateDuration

calculateDurationProposed

calculateDurationPure

calculateEffectiveCalendar

calculateEffectiveVisualCalendar

calculateEndDate

calculateEndDateProposed

calculateEndDatePure

calculateMaxChildrenEndDate

calculateMinChildrenStartDate

calculatePercentDone

calculateProjectedDuration

calculateProjectedXDateWithDuration

calculateStartDate

calculateStartDateProposed

calculateStartDatePure

calculateTotalChildrenEffort

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"]

getAssignmentFor

  • getAssignmentFor(resource: InstanceType<this["project"]["resourceModelClass"]>): InstanceType<this["project"]["assignmentModelClass"]> | null

getAssignmentStore

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

getCalendarById

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

getCalendarManagerStore

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

getConstraintTypeDefaultDate

  • getConstraintTypeDefaultDate(Y: any, constraintType: ConstraintType): Date

getDependencyById

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

getDependencyStore

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

getDuration

getEffort

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"]

getSegment

  • getSegment(index: any): InstanceType<this["segmentModelClass"]>

getSegmentByDate

  • getSegmentByDate(date: Date, segments?: InstanceType<this["segmentModelClass"]>[]): InstanceType<this["segmentModelClass"]>

hasSubEvents

isConstraintTypeApplicable

Private isTaskPinnableWithConstraint

  • isTaskPinnableWithConstraint(): boolean

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

mergeSegments

  • mergeSegments(segment1: InstanceType<this["segmentModelClass"]>, segment2: InstanceType<this["segmentModelClass"]>): Promise<{ rejectedWith?: RejectEffect<unknown> | null }>

setConstraint

setDuration

setEndDate

  • setEndDate(date: Date, keepDuration?: boolean): Promise<CommitResult>

setProject

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

setStartDate

  • setStartDate(date: Date, keepDuration?: boolean): Promise<CommitResult>

shouldPredecessorAffectScheduling

shouldRollupChildEarlyEndDate

  • shouldRollupChildEarlyEndDate(child: ConstrainedEarlyEventMixin): CalculationIterator<boolean>

shouldRollupChildEarlyStartDate

  • shouldRollupChildEarlyStartDate(child: ConstrainedEarlyEventMixin): CalculationIterator<boolean>

shouldRollupChildEffort

shouldRollupChildEndDate

shouldRollupChildLateEndDate

  • shouldRollupChildLateEndDate(childEvent: ConstrainedEarlyEventMixin): CalculationIterator<boolean>

shouldRollupChildLateStartDate

  • shouldRollupChildLateStartDate(childEvent: ConstrainedEarlyEventMixin): CalculationIterator<boolean>

shouldRollupChildPercentDoneSummaryData

  • shouldRollupChildPercentDoneSummaryData(childEvent: HasPercentDoneMixin): ChronoIterator<boolean>

shouldRollupChildStartDate

shouldSuccessorAffectScheduling

skipNonWorkingTime

skipWorkingTime

splitToSegments

subEventsIterable

unassign

  • unassign(resource: InstanceType<this["project"]["resourceModelClass"]>): Promise<any>

userProvidedValue

Generated using TypeDoc