Building Class Reference
[Scheduler]

Basic class describing a building. More...

List of all members.

Public Member Functions
	getAbbrev ($locale)
	getBuildingAbbrev ()
	getBuildingDescription ()
	getBuildingId ()
	getBuildingName ()
	getDescription ($locale)
	getName ($locale)
	getSchedConfId ()
	setAbbrev ($abbrev, $locale)
	setBuildingId ($buildingId)
	setDescription ($description, $locale)
	setName ($name, $locale)
	setSchedConfId ($schedConfId)

---

Detailed Description

Basic class describing a building.

See also:

BuildingDAO

Definition at line 18 of file Building.inc.php.

---

Member Function Documentation

Building.getAbbrev

(

$

locale

)

Get the abbreviation of the building.

Parameters:

$locale

string

Returns:

string

Definition at line 96 of file Building.inc.php.

Building.getBuildingAbbrev

(

)

Get the localized abbreviation of the building.

Returns:

string

Definition at line 87 of file Building.inc.php.

Building.getBuildingDescription

(

)

Get the localized description of the building.

Returns:

string

Definition at line 113 of file Building.inc.php.

Building.getBuildingId

(

)

Get the ID of the building.

Returns:

int

Definition at line 27 of file Building.inc.php.

Building.getBuildingName

(

)

Get the localized name of the building.

Returns:

string

Definition at line 61 of file Building.inc.php.

Building.getDescription

(

$

locale

)

Get the description of the building.

Parameters:

$locale

string

Returns:

string

Definition at line 122 of file Building.inc.php.

Building.getName

(

$

locale

)

Get the name of the building.

Parameters:

$locale

string

Returns:

string

Definition at line 70 of file Building.inc.php.

Building.getSchedConfId

(

)

Get the sched conf ID of the building.

Returns:

int

Definition at line 45 of file Building.inc.php.

Building.setAbbrev	(	$	abbrev,
		$	locale
	)

Set the abbreviation of the building.

Parameters:

	$abbrev	string
	$locale	string

Definition at line 105 of file Building.inc.php.

Building.setBuildingId

(

$

buildingId

)

Set the ID of the building.

Parameters:

$buildingId

int

Definition at line 36 of file Building.inc.php.

Building.setDescription	(	$	description,
		$	locale
	)

Set the description of the building.

Parameters:

	$description	string
	$locale	string

Definition at line 131 of file Building.inc.php.

Building.setName	(	$	name,
		$	locale
	)

Set the name of the building.

Parameters:

	$name	string
	$locale	string

Definition at line 79 of file Building.inc.php.

Building.setSchedConfId

(

$

schedConfId

)

Set the sched conf ID of the building.

Parameters:

$schedConfId

int

Definition at line 53 of file Building.inc.php.

---

The documentation for this class was generated from the following file:

• classes/scheduler/Building.inc.php

---