The project instance, this entity belongs to.
A set of events assigned to this resource
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).
The total projected cost for the resource.
Specifies which rate table to use by default when assigning the resource.
The effective calendar used by this entity (either its own calendar if provided or the project calendar) for data calculation purposes.
The effective calendar used by this entity (either its own calendar if provided or the project calendar) for data visualizing purposes.
Gets the calendar.
Generated getter for the defaultRateTable field
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)
A maximum "capacity" for this resource, in percents. Corresponds to SchedulerProAssignmentMixin.units property. Default value is 100. If the sum of all "units" of all assignments of resource for a certain period exceeds this value, such resource is marked as "over-allocated" in the resource histogram.
The project instance, this entity belongs to.
The resource rate tables.
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.
Generated setter for the defaultRateTable field
Indicates whether the resource is a work, material or a cost resource. Work resources are people and equipment. Material resources are consumable supplies, such as concrete, or soil. And cost resources let to apply a cost to an event by assigning a cost item (like an extra expenditure on flights) to that event.
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)A graph identifier, that represents the whole entity.
An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.
An EntityMeta instance, representing the "meta" information about the entity class. It is shared among all instances of the class.
Adds a rate table to the resource
A rate table instance or data object (or an array of instances or data objects to add multiple tables)
An array of the added tables
Calculation method of the effectiveCalendar. Takes the calendar from the project, if not provided to the entity explicitly.
Calculation method of the effectiveCalendar. Takes the calendar from the project, if not provided to the entity explicitly.
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.
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.
This method is called when entity is added to some replica.
Convenience method to get the instance of assignment by its id.
Convenience method to get the instance of the assignment store in the project instance, this entity belongs to.
Convenience method to get the instance of calendar by its id.
Convenience method to get the instance of the calendar manager store in the project instance, this entity belongs to.
Convenience method to get the instance of dependency by its id.
Convenience method to get the instance of the dependency store in the project instance, this entity belongs to.
Convenience method to get the instance of event by its id.
Convenience method to get the instance of the event store in the project instance, this entity belongs to.
The method to get the ChronoGraph instance, this entity belongs to.
Returns a project instance
Returns the resource rate effective for the provided rate table at the provided date.
A table to get rate from
A date to get the effective rate at
Effective rate
Returns the resource rates effective for the provided rate table in the provided date range.
A table to get rates from
Start date of the range to get the effective rates in
End date of the range to get the effective rates in
Effective rates
Convenience method to get the instance of resource by its id.
Convenience method to get the instance of the resource store in the project instance, this entity belongs to.
Template method, which is called when model is joining the project (through joining some store that has already joined the project)
This method is called when entity is removed from the replica it's been added to.
Template method, which is called when model is leaving the project (through leaving some store usually)
Removes a rate table or multiple rate tables of the resource
A rate table or an array of tables to remove
An array of the removed tables
The method to set the project instance, this entity belongs to.
Calculation function that simply returns current (proposed or previous) value of an identifier.
Generated using TypeDoc
A mixin for the resource entity at the Scheduler Pro level.