Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Section

A section contains all the fields that a Course has, and it holds additional information specific to that section.

All section instances are immutable. Additionally, they will never be duplicated. They will only be created once using Object.create on page load

Hierarchy

Implements

Index

Properties

Accessors

Methods

Properties

Readonly course

course: Course

reference to the course that this section belongs to. This property is non-enumerable

Optional Readonly dateArray

dateArray: MeetingDate
see

MeetingDate undefined if the meeting date is TBA/TBD or cannot be parsed

Readonly dates

dates: string

Readonly enrollment

enrollment: number

Readonly enrollment_limit

enrollment_limit: number

Readonly id

id: number

the id of the section, must be globally unique

Readonly instructors

instructors: string

instructor names (computed from meeting)

Readonly key

key: string

Key of the course that this section belongs to; same for all sections.

Readonly meetings

meetings: readonly Meeting[]

Readonly rooms

rooms: string

rooms (computed from meeting)

Readonly section

section: string

the section number recorded in sis

Readonly status

status: CourseStatus

one of "Open", "Closed" and "Wait List"

Readonly topic

topic: string

the topic of this section, may be empty

Readonly valid

valid: ValidFlag
see

ValidFlag

Readonly wait_list

wait_list: number

Static Private Readonly Validity

Validity: [[0, "Valid"], [1, "Warning: Some meetings have incomplete instructor or room information (e.g. TBA/TBD). This won't affect schedule generation."], [2, "Fatal: This section has several different meeting dates. Plannable currently cannot handle these type of meetings correctly"], [1, "Warning: Some meetings have invalid (TBA/TBD) start or end time. They will not be rendered on the schedule."], [2, "Fatal: This section has unknown start and end date."]] = [[0, 'Valid'],[1,`Warning: Some meetings have incomplete instructor or room information (e.g. TBA/TBD). This won't affect schedule generation.`],[2,'Fatal: This section has several different meeting dates. Plannable currently cannot handle these type of meetings correctly'],[1,'Warning: Some meetings have invalid (TBA/TBD) start or end time. They will not be rendered on the schedule.'],[2, 'Fatal: This section has unknown start and end date.']] as const

Accessors

department

  • get department(): string

description

  • get description(): string

displayName

  • get displayName(): string

displayNameNoType

  • get displayNameNoType(): string

number

  • get number(): number

title

  • get title(): string

type

  • get type(): "" | "Clinical" | "CLN" | "Discussion" | "DIS" | "Drill" | "DRL" | "Independent Study" | "IND" | "Laboratory" | "LAB" | "Lecture" | "LEC" | "Practicum" | "PRA" | "Seminar" | "SEM" | "Studio" | "STO" | "Workshop" | "WKS"

  • Returns "" | "Clinical" | "CLN" | "Discussion" | "DIS" | "Drill" | "DRL" | "Independent Study" | "IND" | "Laboratory" | "LAB" | "Lecture" | "LEC" | "Practicum" | "PRA" | "Seminar" | "SEM" | "Studio" | "STO" | "Workshop" | "WKS"

units

  • get units(): string

validMsg

  • get validMsg(): [string, string]

Methods

combinedTime

  • combinedTime(): string

  • Returns string

    all meeting times of this section concatenated together and concatenated by their dates

getTimeRoom

has

hash

  • hash(): number
  • remarks

    The hashes of all sections of a Course by design are equal to each other.

    Returns number

    the hash of the Course that this section belongs to.

isTBD

  • isTBD(): boolean

sameTimeAs

  • sameTimeAs(other: Section): boolean

Generated using TypeDoc