% 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 - Object methods for tower_sector records
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;
An FS::tower_sector object represents a tower sector. FS::tower_sector inherits from FS::Record. The following fields are currently supported:
primary key
towernum
sectorname
ip_addr
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.
The band center frequency in MHz.
The antenna beam direction in degrees from north.
The -3dB horizontal beamwidth in degrees.
The antenna beam elevation in degrees below horizontal.
The -3dB vertical beamwidth in degrees.
The signal loss margin to treat as "high quality".
The signal loss margin to treat as "low quality".
The coverage map, as a PNG.
The coordinate boundaries of the coverage map.
The sector title.
Up rate limit for sector.
down rate limit for sector.
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.
Adds this record to the database. If there is an error, returns the error, otherwise returns false.
Delete this record from the database.
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.
Returns the tower for this sector, as an FS::tower object (see FS::tower).
Returns a description for this sector including tower name.
Returns the services on this tower sector.
Returns a list of required fields for the coverage map that aren't yet filled.
Starts a job to recalculate the coverage map.
Returns all sector exports. Eventually this may be refined to the level of enabling exports on specific sectors.
Returns all svc_broadband exports.
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'.
FS::tower, FS::Record, schema.html from the base documentation.
Hey! The above document had some coding errors, which are explained below:
You forgot a '=back' before '=head1'