Class: LWS::Presence::Location

Inherits:
Generic::Model show all
Defined in:
lib/lws/apps/presence.rb

Overview

The location class

Defined Under Namespace

Classes: Map

Instance Attribute Summary collapse

Attributes inherited from Generic::Model

#created_at, #id, #updated_at, #url, #url_html

Method Summary

Methods inherited from Generic::Model

#dig, #reload, #rollback, #save

Instance Attribute Details

#ancestor_ids ⇒ Array<Integer>

Returns the ID of the locations that containt the location, including the location itself.

Returns:

  • (Array<Integer>) —

    the ID of the locations that containt the location, including the location itself



98
 
# File 'lib/lws/apps/presence.rb', line 98

attribute :ancestor_ids

#appointments ⇒ Array<Appointment>

Returns the appointments taking place at the location.

Returns:

  • (Array<Appointment>) —

    the appointments taking place at the location



102
 
# File 'lib/lws/apps/presence.rb', line 102

has_many :appointments

#capacity ⇒ Integer

Returns the capacity (maximum number of people) of the location.

Returns:

  • (Integer) —

    the capacity (maximum number of people) of the location



106
 
# File 'lib/lws/apps/presence.rb', line 106

attribute :capacity

#capacity_tree ⇒ Integer

Returns the capacity (maximum number of people) of the location including descendant locations.

Returns:

  • (Integer) —

    the capacity (maximum number of people) of the location including descendant locations



111
 
# File 'lib/lws/apps/presence.rb', line 111

attribute :capacity_tree

#capacity_used ⇒ Integer

Returns the used capacity (present number of people) of the location.

Returns:

  • (Integer) —

    the used capacity (present number of people) of the location



115
 
# File 'lib/lws/apps/presence.rb', line 115

attribute :capacity_used

#capacity_used_percentage ⇒ Float

Returns the used capacity percentage of the location.

Returns:

  • (Float) —

    the used capacity percentage of the location



124
 
# File 'lib/lws/apps/presence.rb', line 124

attribute :capacity_used_precentage

#capacity_used_percentage_tree ⇒ Float

Returns the used capacity percentage of the location including descendant locations.

Returns:

  • (Float) —

    the used capacity percentage of the location including descendant locations



129
 
# File 'lib/lws/apps/presence.rb', line 129

attribute :capacity_used_precentage_tree

#capacity_used_tree ⇒ Integer

Returns the used capacity (present number of people) of the location including descendant locations.

Returns:

  • (Integer) —

    the used capacity (present number of people) of the location including descendant locations



120
 
# File 'lib/lws/apps/presence.rb', line 120

attribute :capacity_used_tree

#checkout_location ⇒ Location?

Returns the location to move people to when they are checked out.

Returns:

  • (Location, nil) —

    the location to move people to when they are checked out



134
135
136
 
# File 'lib/lws/apps/presence.rb', line 134

belongs_to :checkout_location, class_name: "LWS::Presence::Location",
foreign_key: "checkout_location_id",
uri: "locations/:id"

#checkout_location_id ⇒ Integer?

Returns the ID of the location to move people to when they are checked out.

Returns:

  • (Integer, nil) —

    the ID of the location to move people to when they are checked out



141
 
# File 'lib/lws/apps/presence.rb', line 141

attribute :checkout_location_id

#company ⇒ LWS::Auth::Company

Returns the company the location belongs to.

Returns:



145
 
# File 'lib/lws/apps/presence.rb', line 145

belongs_to :company, class_name: "LWS::Auth::Company"

#company_id ⇒ Integer

Returns the ID of the company the location belongs to.

Returns:

  • (Integer) —

    the ID of the company the location belongs to



149
 
# File 'lib/lws/apps/presence.rb', line 149

attribute :company_id

#descendant_ids ⇒ Array<Integer>

Returns the IDs of the underlying locations of the location.

Returns:

  • (Array<Integer>) —

    the IDs of the underlying locations of the location



153
 
# File 'lib/lws/apps/presence.rb', line 153

attribute :descendant_ids

#lat ⇒ Float

Returns the latitude of the location.

Returns:

  • (Float) —

    the latitude of the location



157
 
# File 'lib/lws/apps/presence.rb', line 157

attribute :lat

#logoff_time ⇒ String

Returns the time everybody is automatically logged off (format HH:MM).

Returns:

  • (String) —

    the time everybody is automatically logged off (format HH:MM)



162
 
# File 'lib/lws/apps/presence.rb', line 162

attribute :logoff_time

#long ⇒ Float

Returns the longitude of the location.

Returns:

  • (Float) —

    the longitude of the location



166
 
# File 'lib/lws/apps/presence.rb', line 166

attribute :long

#map_positions ⇒ Array<Location::Map::Position>

Returns the location map positions that track this location.

Returns:



171
 
# File 'lib/lws/apps/presence.rb', line 171

has_many :map_positions, class_name: "LWS::Presence::Location::Map::Position"

#maps ⇒ Array<Location::Map>

Returns the maps for this location.

Returns:



175
 
# File 'lib/lws/apps/presence.rb', line 175

has_many :maps, class_name: "LWS::Presence::Location::Map"

#name ⇒ String

Returns the name of the location.

Returns:

  • (String) —

    the name of the location



179
 
# File 'lib/lws/apps/presence.rb', line 179

attribute :name

#owner ⇒ Person?

Returns the owner of the location.

Returns:

  • (Person, nil) —

    the owner of the location



183
184
185
 
# File 'lib/lws/apps/presence.rb', line 183

belongs_to :owner, class_name: "LWS::Presence::Person",
foreign_key: "owner_id",
uri: "people/:id"

#owner_id ⇒ Fixnum?

Returns the ID of the owner of the location.

Returns:

  • (Fixnum, nil) —

    the ID of the owner of the location



189
 
# File 'lib/lws/apps/presence.rb', line 189

attribute :owner_id

#parent ⇒ Location

Returns the parent of the location.

Returns:

  • (Location) —

    the parent of the location



193
194
195
 
# File 'lib/lws/apps/presence.rb', line 193

belongs_to :parent, class_name: "LWS::Presence::Location",
foreign_key: "parent_id",
uri: "locations/:id"

#parent_id ⇒ Integer

Returns the ID of the parent of the location.

Returns:

  • (Integer) —

    the ID of the parent of the location



199
 
# File 'lib/lws/apps/presence.rb', line 199

attribute :parent_id

#people ⇒ Array<Person>

Returns the people associated with the location.

Returns:

  • (Array<Person>) —

    the people associated with the location



203
 
# File 'lib/lws/apps/presence.rb', line 203

has_many :people

#people_tree ⇒ Array<Person>

Returns the people associated with the location including descendant locations.

Returns:

  • (Array<Person>) —

    the people associated with the location including descendant locations



208
 
# File 'lib/lws/apps/presence.rb', line 208

has_many :people_tree, class_name: "LWS::Presence::Person"

#range ⇒ Integer

Returns the range around the location in meters.

Returns:

  • (Integer) —

    the range around the location in meters



212
 
# File 'lib/lws/apps/presence.rb', line 212

attribute :range

#readers ⇒ Array<Reader>

Returns the (RFID/code/ID/…) readers linked to this location.

Returns:

  • (Array<Reader>) —

    the (RFID/code/ID/…) readers linked to this location



216
 
# File 'lib/lws/apps/presence.rb', line 216

has_many :readers

#uuid ⇒ String

Returns the UUID of the location.

Returns:

  • (String) —

    the UUID of the location



220
 
# File 'lib/lws/apps/presence.rb', line 220

attribute :uuid