Class: File_Therion_Surface

Source Location: /File_Therion-0.4.1/File/Therion/Surface.php

Class Overview

File_Therion_BasicObject
   |
   --File_Therion_Surface

Class representing a therion surface object.

Author(s):

Benedikt Hallinger <beni at php.net>

Copyright:

2016 Benedikt Hallinger

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

File_Therion_BasicObject::$objStack
File_Therion_BasicObject::$_simpledata

Inherited Methods

Class: File_Therion_BasicObject

File_Therion_BasicObject::addComment(): Add a comment.
File_Therion_BasicObject::getData(): Get some simple data of this object.
File_Therion_BasicObject::getOption(): Get option of this object.
File_Therion_BasicObject::getOptionsString(): Generate basic options string.
File_Therion_BasicObject::handleCommonOption(): Handle known options supported by several objects.
File_Therion_BasicObject::setData(): Set some simple data of this object.
File_Therion_BasicObject::setOption(): Set options of this object.
File_Therion_BasicObject::_verify(): Verify basic compliance of item.

Class Details

[line 27]
Class representing a therion surface object.

A surface object holds information of the surface around a cave.

Author: Benedikt Hallinger <beni@php.net>
Copyright: 2016 Benedikt Hallinger
Link: http://pear.php.net/package/File_Therion/
License: LGPLv3

[ Top ]

Class Variables

$_data = array(
        'cs'         => "", // <coordinate system>
        'bitmap'     => "", // <filename> <calibration>
        'grid-units' => "", // <units>, meter by default if not specified
        'grid'       => array(),// <origin x> <origin y> <x spacing> <y spacing> <x count> <y count>
'grid-flip'=>"",// (none)/vertical/horizontal
'data'=>array())

[line 47]

Basic data elements.

Access: protected

Type:

array

[ Top ]

$_options = array(
// todo unchecked
)

[line 37]

Surface options (title, ...).

Var: assoc array
Access: protected

Type:	array
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 62]

File_Therion_Surface __construct(
[string
$id = ""])

Create a new therion surface object.

Access: public

Parameters:

string $id — optional name of the surface object.

[ Top ]

count [line 271]

int count(
)

Count number of data elements (SPL Countable).

Return: number of data elements
Access: public

[ Top ]

getCoordinateSystem [line 261]

string getCoordinateSystem(
)

Returns the coordinate system used for fixing stations.

Return: (empty string if not set so far)
Access: public

[ Top ]

getName [line 226]

string getName(
)

Get name (id) of this surface object.

Access: public

[ Top ]

parse [line 76]

File_Therion_Surface parse(
array
$lines)

Parses given Therion_Line-objects into internal data structures.

Return: Surface object
Todo: implement me
Throws: InvalidArgumentException
Access: public

Parameters:

array $lines — File_Therion_Line objects forming a surface

[ Top ]

setCoordinateSystem [line 251]

void setCoordinateSystem(
string
$cs)

Sets the coordinate system that is used for fixing stations.

Fixing stations coordinates is only meaningful defining a coordinate system for the coordinates given.

Access: public

Parameters:

string $cs —

[ Top ]

setName [line 237]

string setName(

$id)

Change name (id) of this surface object.

Todo: implement parameter checks
Access: public

Parameters:

$id —

[ Top ]

Class: File_Therion_Surface

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Class: File_Therion_BasicObject

Inherited Methods

Class: File_Therion_BasicObject

Class Details

Class Variables

$_options = array( // todo unchecked )

Method Detail

__construct (Constructor) [line 62]

Parameters:

count [line 271]

getCoordinateSystem [line 261]

getName [line 226]

parse [line 76]

Parameters:

setCoordinateSystem [line 251]

Parameters:

setName [line 237]

Parameters:

$_options = array(
// todo unchecked
)