Building

java.lang.Object
- rescuecore2.worldmodel.AbstractEntity
- - rescuecore2.standard.entities.StandardEntity
  - - rescuecore2.standard.entities.Area
    - - rescuecore2.standard.entities.Building

All Implemented Interfaces:

Entity

Direct Known Subclasses:

AmbulanceCentre, FireStation, GasStation, PoliceOffice, Refuge
```
public class Building
extends Area
```
The Building object.

Field Summary

Fields
Modifier and Type Field and Description

static java.util.EnumSet<StandardEntityConstants.Fieryness> BURNING
Fieryness levels that indicate burning.

Fields
Modifier and Type	Field and Description
`static java.util.EnumSet<StandardEntityConstants.Fieryness>`	`BURNING` Fieryness levels that indicate burning.

Constructor Summary

Constructors
Constructor and Description

Building(Building other)
Building copy constructor.

Building(EntityID id)
Construct a Building object with entirely undefined property values.

Constructors
Constructor and Description
`Building(Building other)` Building copy constructor.
`Building(EntityID id)` Construct a Building object with entirely undefined property values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Entity`	`copyImpl()` Create a copy of this entity.
`int`	`getBrokenness()` Get the brokenness of this building.
`IntProperty`	`getBrokennessProperty()` Get the brokenness property.
`int`	`getBuildingAttributes()` Get the building attributes of this building.
`IntProperty`	`getBuildingAttributesProperty()` Get the building attributes property.
`int`	`getBuildingCode()` Get the building code of this building.
`StandardEntityConstants.BuildingCode`	`getBuildingCodeEnum()` Get the building code of this building as an enum constant.
`IntProperty`	`getBuildingCodeProperty()` Get the building code property.
`protected java.lang.String`	`getEntityName()` Get the name of this entity.
`int`	`getFieryness()` Get the fieryness of this building.
`StandardEntityConstants.Fieryness`	`getFierynessEnum()` Get the fieryness of this building as an enum constant.
`IntProperty`	`getFierynessProperty()` Get the fieryness property.
`int`	`getFloors()` Get the number of floors in this building.
`IntProperty`	`getFloorsProperty()` Get the floors property.
`int`	`getGroundArea()` Get the ground area of this building.
`IntProperty`	`getGroundAreaProperty()` Get the ground area property.
`boolean`	`getIgnition()` Get the value of the ignition property.
`BooleanProperty`	`getIgnitionProperty()` Get the ignition property.
`int`	`getImportance()` Get the importance of this building.
`IntProperty`	`getImportanceProperty()` Get the building importance property.
`Property`	`getProperty(java.lang.String urn)` Get a property by urn.
`StandardEntityURN`	`getStandardURN()` Get the URN of this entity type as an instanceof StandardEntityURN.
`int`	`getTemperature()` Get the temperature of this building.
`IntProperty`	`getTemperatureProperty()` Get the temperature property.
`int`	`getTotalArea()` Get the total area of this building.
`IntProperty`	`getTotalAreaProperty()` Get the total area property.
`boolean`	`isBrokennessDefined()` Find out if the brokenness property has been defined.
`boolean`	`isBuildingAttributesDefined()` Find out if the building attributes property has been defined.
`boolean`	`isBuildingCodeDefined()` Find out if the building code has been defined.
`boolean`	`isFierynessDefined()` Find out if the fieryness property has been defined.
`boolean`	`isFloorsDefined()` Find out if the floors property has been defined.
`boolean`	`isGroundAreaDefined()` Find out if the ground area property has been defined.
`boolean`	`isIgnitionDefined()` Find out if the ignition property has been defined.
`boolean`	`isImportanceDefined()` Find out if the importance property has been defined.
`boolean`	`isOnFire()` Find out if this building is on fire.
`boolean`	`isTemperatureDefined()` Find out if the temperature property has been defined.
`boolean`	`isTotalAreaDefined()` Find out if the total area property has been defined.
`void`	`setBrokenness(int brokenness)` Set the brokenness of this building.
`void`	`setBuildingAttributes(int newAttributes)` Set the building attributes of this building.
`void`	`setBuildingCode(int newCode)` Set the building code of this building.
`void`	`setFieryness(int fieryness)` Set the fieryness of this building.
`void`	`setFloors(int floors)` Set the number of floors in this building.
`void`	`setGroundArea(int ground)` Set the ground area of this building.
`void`	`setIgnition(boolean ignition)` Set the ignition property.
`void`	`setImportance(int importance)` Set the importance of this building.
`void`	`setTemperature(int temperature)` Set the temperature of this building.
`void`	`setTotalArea(int total)` Set the total area of this building.
`void`	`undefineBrokenness()` Undefine the brokenness property.
`void`	`undefineBuildingAttributes()` Undefine the building attributes.
`void`	`undefineBuildingCode()` Undefine the building code.
`void`	`undefineFieryness()` Undefine the fieryness property.
`void`	`undefineFloors()` Undefine the floors property.
`void`	`undefineGroundArea()` Undefine the ground area.
`void`	`undefineIgnition()` Undefine the ingition property.
`void`	`undefineImportance()` Undefine the importance property.
`void`	`undefineTemperature()` Undefine the temperature property.
`void`	`undefineTotalArea()` Undefine the total area property.

Methods inherited from class rescuecore2.standard.entities.Area
getApexList, getBlockades, getBlockadesProperty, getEdges, getEdgesProperty, getEdgeTo, getLocation, getNeighbours, getShape, getX, getXProperty, getY, getYProperty, isBlockadesDefined, isEdgesDefined, isXDefined, isYDefined, setBlockades, setEdges, setX, setY, undefineBlockades, undefineEdges, undefineX, undefineY

Methods inherited from class rescuecore2.standard.entities.StandardEntity
getURN

Methods inherited from class rescuecore2.worldmodel.AbstractEntity
addEntityListener, copy, equals, firePropertyChanged, getFullDescription, getID, getProperties, hashCode, read, registerProperties, removeEntityListener, toString, write

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - BURNING
```
public static final java.util.EnumSet<StandardEntityConstants.Fieryness> BURNING
```
    Fieryness levels that indicate burning.
- Constructor Detail
  - Building
```
public Building(EntityID id)
```
    Construct a Building object with entirely undefined property values.
    
    Parameters:
    
    id - The ID of this entity.
  - Building
```
public Building(Building other)
```
    Building copy constructor.
    
    Parameters:
    
    other - The Building to copy.
- Method Detail
  - copyImpl
```
protected Entity copyImpl()
```
    Description copied from class: AbstractEntity
    
    Create a copy of this entity. Property values do not need to be copied.
    
    Specified by:
    
    copyImpl in class AbstractEntity
    
    Returns:
    
    A new Entity of the same type as this and with the same ID.
  - getStandardURN
```
public StandardEntityURN getStandardURN()
```
    Description copied from class: StandardEntity
    
    Get the URN of this entity type as an instanceof StandardEntityURN.
    
    Specified by:
    
    getStandardURN in class StandardEntity
    
    Returns:
    
    A StandardEntityURN.
  - getEntityName
```
protected java.lang.String getEntityName()
```
    Description copied from class: AbstractEntity
    
    Get the name of this entity. Default implementation returns the entity URN.
    
    Overrides:
    
    getEntityName in class AbstractEntity
    
    Returns:
    
    The name of this entity.
  - getProperty
```
public Property getProperty(java.lang.String urn)
```
    Description copied from interface: Entity
    
    Get a property by urn.
    
    Specified by:
    
    getProperty in interface Entity
    
    Overrides:
    
    getProperty in class Area
    
    Parameters:
    
    urn - The urn to look up.
    
    Returns:
    
    The property with the given urn or null if no such property exists.
  - getFloorsProperty
```
public IntProperty getFloorsProperty()
```
    Get the floors property.
    
    Returns:
    
    The floors property.
  - getFloors
```
public int getFloors()
```
    Get the number of floors in this building.
    
    Returns:
    
    The number of floors.
  - setFloors
```
public void setFloors(int floors)
```
    Set the number of floors in this building.
    
    Parameters:
    
    floors - The new number of floors.
  - isFloorsDefined
```
public boolean isFloorsDefined()
```
    Find out if the floors property has been defined.
    
    Returns:
    
    True if the floors property has been defined, false otherwise.
  - undefineFloors
```
public void undefineFloors()
```
    Undefine the floors property.
  - getIgnitionProperty
```
public BooleanProperty getIgnitionProperty()
```
    Get the ignition property.
    
    Returns:
    
    The ignition property.
  - getIgnition
```
public boolean getIgnition()
```
    Get the value of the ignition property.
    
    Returns:
    
    The ignition property value.
  - setIgnition
```
public void setIgnition(boolean ignition)
```
    Set the ignition property.
    
    Parameters:
    
    ignition - The new ignition value.
  - isIgnitionDefined
```
public boolean isIgnitionDefined()
```
    Find out if the ignition property has been defined.
    
    Returns:
    
    True if the ignition property has been defined, false otherwise.
  - undefineIgnition
```
public void undefineIgnition()
```
    Undefine the ingition property.
  - getFierynessProperty
```
public IntProperty getFierynessProperty()
```
    Get the fieryness property.
    
    Returns:
    
    The fieryness property.
  - getFieryness
```
public int getFieryness()
```
    Get the fieryness of this building.
    
    Returns:
    
    The fieryness property value.
  - getFierynessEnum
```
public StandardEntityConstants.Fieryness getFierynessEnum()
```
    Get the fieryness of this building as an enum constant. If fieryness is not defined then return null.
    
    Returns:
    
    The fieryness property value as a Fieryness enum, or null if fieryness is undefined.
  - setFieryness
```
public void setFieryness(int fieryness)
```
    Set the fieryness of this building.
    
    Parameters:
    
    fieryness - The new fieryness value.
  - isFierynessDefined
```
public boolean isFierynessDefined()
```
    Find out if the fieryness property has been defined.
    
    Returns:
    
    True if the fieryness property has been defined, false otherwise.
  - undefineFieryness
```
public void undefineFieryness()
```
    Undefine the fieryness property.
  - getBrokennessProperty
```
public IntProperty getBrokennessProperty()
```
    Get the brokenness property.
    
    Returns:
    
    The brokenness property.
  - getBrokenness
```
public int getBrokenness()
```
    Get the brokenness of this building.
    
    Returns:
    
    The brokenness value.
  - setBrokenness
```
public void setBrokenness(int brokenness)
```
    Set the brokenness of this building.
    
    Parameters:
    
    brokenness - The new brokenness.
  - isBrokennessDefined
```
public boolean isBrokennessDefined()
```
    Find out if the brokenness property has been defined.
    
    Returns:
    
    True if the brokenness property has been defined, false otherwise.
  - undefineBrokenness
```
public void undefineBrokenness()
```
    Undefine the brokenness property.
  - getBuildingCodeProperty
```
public IntProperty getBuildingCodeProperty()
```
    Get the building code property.
    
    Returns:
    
    The building code property.
  - getBuildingCode
```
public int getBuildingCode()
```
    Get the building code of this building.
    
    Returns:
    
    The building code.
  - getBuildingCodeEnum
```
public StandardEntityConstants.BuildingCode getBuildingCodeEnum()
```
    Get the building code of this building as an enum constant. If building code is not defined then return null.
    
    Returns:
    
    The building code property value as a BuildingCode enum, or null if building code is undefined.
  - setBuildingCode
```
public void setBuildingCode(int newCode)
```
    Set the building code of this building.
    
    Parameters:
    
    newCode - The new building code.
  - isBuildingCodeDefined
```
public boolean isBuildingCodeDefined()
```
    Find out if the building code has been defined.
    
    Returns:
    
    True if the building code has been defined, false otherwise.
  - undefineBuildingCode
```
public void undefineBuildingCode()
```
    Undefine the building code.
  - getBuildingAttributesProperty
```
public IntProperty getBuildingAttributesProperty()
```
    Get the building attributes property.
    
    Returns:
    
    The building attributes property.
  - getBuildingAttributes
```
public int getBuildingAttributes()
```
    Get the building attributes of this building.
    
    Returns:
    
    The building attributes.
  - setBuildingAttributes
```
public void setBuildingAttributes(int newAttributes)
```
    Set the building attributes of this building.
    
    Parameters:
    
    newAttributes - The new building attributes.
  - isBuildingAttributesDefined
```
public boolean isBuildingAttributesDefined()
```
    Find out if the building attributes property has been defined.
    
    Returns:
    
    True if the building attributes property has been defined, false otherwise.
  - undefineBuildingAttributes
```
public void undefineBuildingAttributes()
```
    Undefine the building attributes.
  - getGroundAreaProperty
```
public IntProperty getGroundAreaProperty()
```
    Get the ground area property.
    
    Returns:
    
    The ground area property.
  - getGroundArea
```
public int getGroundArea()
```
    Get the ground area of this building.
    
    Returns:
    
    The ground area.
  - setGroundArea
```
public void setGroundArea(int ground)
```
    Set the ground area of this building.
    
    Parameters:
    
    ground - The new ground area.
  - isGroundAreaDefined
```
public boolean isGroundAreaDefined()
```
    Find out if the ground area property has been defined.
    
    Returns:
    
    True if the ground area property has been defined, false otherwise.
  - undefineGroundArea
```
public void undefineGroundArea()
```
    Undefine the ground area.
  - getTotalAreaProperty
```
public IntProperty getTotalAreaProperty()
```
    Get the total area property.
    
    Returns:
    
    The total area property.
  - getTotalArea
```
public int getTotalArea()
```
    Get the total area of this building.
    
    Returns:
    
    The total area.
  - setTotalArea
```
public void setTotalArea(int total)
```
    Set the total area of this building.
    
    Parameters:
    
    total - The new total area.
  - isTotalAreaDefined
```
public boolean isTotalAreaDefined()
```
    Find out if the total area property has been defined.
    
    Returns:
    
    True if the total area property has been defined, false otherwise.
  - undefineTotalArea
```
public void undefineTotalArea()
```
    Undefine the total area property.
  - getTemperatureProperty
```
public IntProperty getTemperatureProperty()
```
    Get the temperature property.
    
    Returns:
    
    The temperature property.
  - getTemperature
```
public int getTemperature()
```
    Get the temperature of this building.
    
    Returns:
    
    The temperature.
  - setTemperature
```
public void setTemperature(int temperature)
```
    Set the temperature of this building.
    
    Parameters:
    
    temperature - The new temperature.
  - isTemperatureDefined
```
public boolean isTemperatureDefined()
```
    Find out if the temperature property has been defined.
    
    Returns:
    
    True if the temperature property has been defined, false otherwise.
  - undefineTemperature
```
public void undefineTemperature()
```
    Undefine the temperature property.
  - getImportanceProperty
```
public IntProperty getImportanceProperty()
```
    Get the building importance property.
    
    Returns:
    
    The importance property.
  - getImportance
```
public int getImportance()
```
    Get the importance of this building.
    
    Returns:
    
    The importance.
  - setImportance
```
public void setImportance(int importance)
```
    Set the importance of this building.
    
    Parameters:
    
    importance - The new importance.
  - isImportanceDefined
```
public boolean isImportanceDefined()
```
    Find out if the importance property has been defined.
    
    Returns:
    
    True if the importance property has been defined, false otherwise.
  - undefineImportance
```
public void undefineImportance()
```
    Undefine the importance property.
  - isOnFire
```
public boolean isOnFire()
```
    Find out if this building is on fire.
    
    Returns:
    
    True iff this buildings fieryness indicates that it is burning.

Class Building

Field Summary

Constructor Summary

Method Summary

Methods inherited from class rescuecore2.standard.entities.Area

Methods inherited from class rescuecore2.standard.entities.StandardEntity

Methods inherited from class rescuecore2.worldmodel.AbstractEntity

Methods inherited from class java.lang.Object

Field Detail

BURNING

Constructor Detail

Building

Building

Method Detail

copyImpl

getStandardURN

getEntityName

getProperty

getFloorsProperty

getFloors

setFloors

isFloorsDefined

undefineFloors

getIgnitionProperty

getIgnition

setIgnition

isIgnitionDefined

undefineIgnition

getFierynessProperty

getFieryness

getFierynessEnum

setFieryness

isFierynessDefined

undefineFieryness

getBrokennessProperty

getBrokenness

setBrokenness

isBrokennessDefined

undefineBrokenness

getBuildingCodeProperty

getBuildingCode

getBuildingCodeEnum

setBuildingCode

isBuildingCodeDefined

undefineBuildingCode

getBuildingAttributesProperty

getBuildingAttributes

setBuildingAttributes

isBuildingAttributesDefined

undefineBuildingAttributes

getGroundAreaProperty

getGroundArea

setGroundArea

isGroundAreaDefined

undefineGroundArea

getTotalAreaProperty

getTotalArea

setTotalArea

isTotalAreaDefined

undefineTotalArea

getTemperatureProperty

getTemperature

setTemperature

isTemperatureDefined

undefineTemperature

getImportanceProperty

getImportance

setImportance

isImportanceDefined

undefineImportance

isOnFire