<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::tower_sector

NAME

FS::tower_sector - Object methods for tower_sector records

SYNOPSIS

  use FS::tower_sector;

  $record = new FS::tower_sector \%hash;
  $record = new FS::tower_sector { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

DESCRIPTION

An FS::tower_sector object represents a tower sector. FS::tower_sector inherits from FS::Record. The following fields are currently supported:

sectornum

primary key

towernum

towernum

sectorname

sectorname

ip_addr

ip_addr

height

The height of this antenna on the tower, measured from ground level. This plus the tower's altitude should equal the height of the antenna above sea level.

freq_mhz

The band center frequency in MHz.

direction

The antenna beam direction in degrees from north.

width

The -3dB horizontal beamwidth in degrees.

downtilt

The antenna beam elevation in degrees below horizontal.

v_width

The -3dB vertical beamwidth in degrees.

margin

The signal loss margin allowed on the sector, in dB. This is normally transmitter EIRP minus receiver sensitivity.

image

The coverage map, as a PNG.

west, east, south, north

The coordinate boundaries of the coverage map.

title

The sector title.

up_rate_limit

Up rate limit for sector.

down_rate_limit

down rate limit for sector.

METHODS

new HASHREF

Creates a new sector. To add the sector to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

check

Checks all fields to make sure this is a valid sector. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

tower

Returns the tower for this sector, as an FS::tower object (see FS::tower).

description

Returns a description for this sector including tower name.

svc_broadband

Returns the services on this tower sector.

need_fields_for_coverage

Returns a list of required fields for the coverage map that aren't yet filled.

queue_generate_coverage

Starts a job to recalculate the coverage map.

SUBROUTINES

part_export_svc_broadband

Returns all svc_broadband exports.

process_generate_coverage JOB, PARAMS

Queueable routine to fetch the sector coverage map from the tower mapping server and store it. Highly experimental. Requires Map::Splat to be installed.

PARAMS must include 'sectornum'.

BUGS

SEE ALSO

FS::tower, FS::Record, schema.html from the base documentation.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 349:

You forgot a '=back' before '=head1'

<% include ('/elements/footer.html' ) %>