File_Therion
[ class tree: File_Therion ] [ index: File_Therion ] [ all elements ]

Element index for package File_Therion

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ j ] [ l ] [ m ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ w ] [ _ ]

_

$_aliases
in file Shot.php, variable File_Therion_Shot::$_aliases
    Known field name aliases
$_centrelines
in file Survey.php, variable File_Therion_Survey::$_centrelines
    Associated centrelines
$_comment
in file Station.php, variable File_Therion_Station::$_comment
    Comment of this station.
$_content
in file Line.php, variable File_Therion_Line::$_content
    Line content.
$_data
in file Scrap.php, variable File_Therion_Scrap::$_data
    Basic data elements.
$_data
in file Map.php, variable File_Therion_Map::$_data
    Basic data elements.
$_data
in file ScrapArea.php, variable File_Therion_ScrapArea::$_data
    Basic data elements.
$_data
in file ScrapPoint.php, variable File_Therion_ScrapPoint::$_data
    Basic data elements.
$_data
in file Surface.php, variable File_Therion_Surface::$_data
    Basic data elements.
$_data
in file Shot.php, variable File_Therion_Shot::$_data
    Basic normalized data elements.
$_data
in file Grade.php, variable File_Therion_Grade::$_data
    Basic data elements.
$_data
in file ScrapLine.php, variable File_Therion_ScrapLine::$_data
    Basic data elements.
$_data
in file ScrapLine.php, variable File_Therion_ScrapLinePoint::$_data
    Data of this point.
$_data
in file Centreline.php, variable File_Therion_Centreline::$_data
    Basic data elements.
$_encoding
in file Therion.php, variable File_Therion::$_encoding
    Encoding of this file.
$_eol
in file Line.php, variable File_Therion_Line::$_eol
    Default line ending character
$_equates
in file Station.php, variable File_Therion_Station::$_equates
    Equated stations.
$_equatesBL
in file Station.php, variable File_Therion_Station::$_equatesBL
    Equated stations (backlinks).
$_extend
in file Centreline.php, variable File_Therion_Centreline::$_extend
    Extend definitions.
$_filename
in file Therion.php, variable File_Therion::$_filename
    Filename and path of this file.
$_fixedStations
in file Centreline.php, variable File_Therion_Centreline::$_fixedStations
    Fixed stations outside of shot data
$_fixes
in file Station.php, variable File_Therion_Station::$_fixes
    Fix-data for this station.
$_flags
in file Shot.php, variable File_Therion_Shot::$_flags
    Flags of this shot.
$_flags
in file Station.php, variable File_Therion_Station::$_flags
    Flags of this station.
$_header
in file Therion.php, variable File_Therion::$_header
    Header to be put into any generated file
$_id
in file Grade.php, variable File_Therion_Grade::$_id
    ID of this grade
$_joins
in file Scrap.php, variable File_Therion_Scrap::$_joins
    Scrap joins.
$_joins
in file Join.php, variable File_Therion_Join::$_joins
    Join arguments.
$_joins
in file Survey.php, variable File_Therion_Survey::$_joins
    Associated scrap joins
$_line
in file ScrapLine.php, variable File_Therion_ScrapLinePoint::$_line
    Line this point belongs to.
$_lines
in file ScrapArea.php, variable File_Therion_ScrapArea::$_lines
    Line references forming this area borders.
$_lines
in file Therion.php, variable File_Therion::$_lines
    Lines of this file.
$_maps
in file Survey.php, variable File_Therion_Survey::$_maps
    Associated maps
$_name
in file Station.php, variable File_Therion_Station::$_name
    Name/ID of this station.
$_name
in file Survey.php, variable File_Therion_Survey::$_name
    survey name (ID)
$_name
in file Scrap.php, variable File_Therion_Scrap::$_name
    Scrap name (ID)
$_name
in file Map.php, variable File_Therion_Map::$_name
    Map name (ID)
$_objects
in file Therion.php, variable File_Therion::$_objects
    objects of this file.
$_objects
in file Scrap.php, variable File_Therion_Scrap::$_objects
    Objects of this scrap.
$_options
in file Surface.php, variable File_Therion_Surface::$_options
    Surface options (title, ...).
$_options
in file Survey.php, variable File_Therion_Survey::$_options
    Survey options (title, ...)
$_options
in file ScrapPoint.php, variable File_Therion_ScrapPoint::$_options
    Object options (title, ...).
$_options
in file Join.php, variable File_Therion_Join::$_options
    Object options (title, ...).
$_options
in file Centreline.php, variable File_Therion_Centreline::$_options
    Centreline options (id, ...).
$_options
in file ScrapArea.php, variable File_Therion_ScrapArea::$_options
    Object options (title, ...).
$_options
in file Scrap.php, variable File_Therion_Scrap::$_options
    Scrap options (title, ...).
$_options
in file Map.php, variable File_Therion_Map::$_options
    Map options (title, ...).
$_options
in file BasicObject.abstract.php, variable File_Therion_BasicObject::$_options
    Object options (title, ...).
$_options
in file Grade.php, variable File_Therion_Grade::$_options
    options (title, ...).
$_options
in file ScrapLine.php, variable File_Therion_ScrapLine::$_options
    Object options (id, ...).
$_order
in file Shot.php, variable File_Therion_Shot::$_order
    data definition order for this shot.
$_out_std_commentSep
in file Line.php, variable File_Therion_Line::$_out_std_commentSep
    Standard output separator for comment.
$_parent
in file Survey.php, variable File_Therion_Survey::$_parent
    Associated parent survey
$_points
in file ScrapLine.php, variable File_Therion_ScrapLine::$_points
    Points of this line.
$_prePostfix
in file Station.php, variable File_Therion_Station::$_prePostfix
    Prefix/Postfix of this station
$_reader
in file Therion.php, variable File_Therion::$_reader
    Reader used for this file.
$_scraps
in file Survey.php, variable File_Therion_Survey::$_scraps
    Associated scraps
$_shotDef
in file Centreline.php, variable File_Therion_Centreline::$_shotDef
    Centreline data definition.
$_shots
in file Centreline.php, variable File_Therion_Centreline::$_shots
    Centreline shot definition.
$_shotTPL
in file Centreline.php, variable File_Therion_Centreline::$_shotTPL
    Shot template for initializing units etc
$_simpledata
in file BasicObject.abstract.php, variable File_Therion_BasicObject::$_simpledata
    Object data (simple ones).
$_style
in file Shot.php, variable File_Therion_Shot::$_style
    data reading style
$_supportedEncodings
in file Therion.php, variable File_Therion::$_supportedEncodings
    Currently supported encodings by therion.
$_surface
in file Survey.php, variable File_Therion_Survey::$_surface
    Associated surface definitions
$_survey
in file Station.php, variable File_Therion_Station::$_survey
    Survey context of this station (for name resolution).
$_survey
in file Centreline.php, variable File_Therion_Centreline::$_survey
    Survey context of this centreline.
$_surveys
in file Survey.php, variable File_Therion_Survey::$_surveys
    Associated subsurvey structures
$_tripStack
in file Centreline.php, variable File_Therion_Centreline::$_tripStack
    Trips Stack to store date, explo-date, team and explo-team in order.
$_units
in file Shot.php, variable File_Therion_Shot::$_units
    Units definition for normalized fields.
_getEncodingName
in file Therion.php, method File_Therion::_getEncodingName()
    Get internal (PHP compatible) name of encoding name.
_verify
in file BasicObject.abstract.php, method File_Therion_BasicObject::_verify()
    Verify basic compliance of item.
__construct
in file Survey.php, method File_Therion_Survey::__construct()
    Create a new therion survey object.
__construct
in file Scrap.php, method File_Therion_Scrap::__construct()
    Create a new therion Scrap object.
__construct
in file Map.php, method File_Therion_Map::__construct()
    Create a new therion Map object.
__construct
in file Line.php, method File_Therion_Line::__construct()
    Create a new therion line object.
__construct
in file Therion.php, method File_Therion::__construct()
    Create a new therion file object representing content at $filename.
__construct
in file ScrapLine.php, method File_Therion_ScrapLine::__construct()
    Create a new therion ScrapLine object.
__construct
in file ScrapArea.php, method File_Therion_ScrapArea::__construct()
    Create a new therion ScrapPoint object.
__construct
in file Join.php, method File_Therion_Join::__construct()
    Create a new therion Join object.
__construct
in file Shot.php, method File_Therion_Shot::__construct()
    Create a new therion shot object.
__construct
in file Surface.php, method File_Therion_Surface::__construct()
    Create a new therion surface object.
__construct
in file Centreline.php, method File_Therion_Centreline::__construct()
    Create a new therion centreline object.
__construct
in file ScrapPoint.php, method File_Therion_ScrapPoint::__construct()
    Create a new therion ScrapPoint object.
__construct
in file ScrapLine.php, method File_Therion_ScrapLinePoint::__construct()
    Create a new therion ScrapLinePoint object.
__construct
in file Station.php, method File_Therion_Station::__construct()
    Create a new therion station object.
__construct
in file Grade.php, method File_Therion_Grade::__construct()
    Create a new therion Grade object.
__toString
in file Therion.php, method File_Therion::__toString()
    Magic __toString() method calls toString().
__toString
in file Line.php, method File_Therion_Line::__toString()
    Magic __toString() method calls toString().
__toString
in file ScrapLine.php, method File_Therion_ScrapLinePoint::__toString()
    Magic __toString() method calls toString().
__toString
in file Join.php, method File_Therion_Join::__toString()
    Magic __toString() method calls toString().
top

a

addArgument
in file Join.php, method File_Therion_Join::addArgument()
    Add a join argument.
addCentreline
in file Survey.php, method File_Therion_Survey::addCentreline()
    Add a centreline definition.
addComment
in file BasicObject.abstract.php, method File_Therion_BasicObject::addComment()
    Add a comment.
addData
in file Line.php, method File_Therion_Line::addData()
    Add internal data to stack.
addDate
in file Centreline.php, method File_Therion_Centreline::addDate()
    Set survey date.
addElement
in file Map.php, method File_Therion_Map::addElement()
    Add an (scrap or map) element reference to this map.
addEquate
in file Station.php, method File_Therion_Station::addEquate()
    Add equated station.
addExploDate
in file Centreline.php, method File_Therion_Centreline::addExploDate()
    Set exploration date.
addExploTeam
in file Centreline.php, method File_Therion_Centreline::addExploTeam()
    Add a team member which explored.
addFixedStation
in file Centreline.php, method File_Therion_Centreline::addFixedStation()
    Add a fixed station definition.
addFormatter
in file Therion.php, method File_Therion::addFormatter()
    Add a formatter.
addJoin
in file Survey.php, method File_Therion_Survey::addJoin()
    Add a scrap join.
addJoin
in file Scrap.php, method File_Therion_Scrap::addJoin()
    Add a scrap join.
addLine
in file Therion.php, method File_Therion::addLine()
    Add a line to this file.
addLine
in file ScrapArea.php, method File_Therion_ScrapArea::addLine()
    Add a scrap line reference to this area.
addMap
in file Survey.php, method File_Therion_Survey::addMap()
    Add a map definition.
addObject
in file Therion.php, method File_Therion::addObject()
    Add an File_Therion data model object to this file
addObject
in file Scrap.php, method File_Therion_Scrap::addObject()
    Add an File_Therion_Scrap* data model object to this scrap.
addPhysicalLine
in file Line.php, method File_Therion_Line::addPhysicalLine()
    Add a physical Therion line as wrapped into its contents.
addPoint
in file ScrapLine.php, method File_Therion_ScrapLine::addPoint()
    Add a new Point to this line.
addScrap
in file Survey.php, method File_Therion_Survey::addScrap()
    Add a scrap object.
addShot
in file Centreline.php, method File_Therion_Centreline::addShot()
    Add a survey shot to this centreline.
addSurface
in file Survey.php, method File_Therion_Survey::addSurface()
    Add a surface definition.
addSurvey
in file Survey.php, method File_Therion_Survey::addSurvey()
    Add a subsurvey.
addTeam
in file Centreline.php, method File_Therion_Centreline::addTeam()
    Add a surveying team member.
aliasField
in file Shot.php, method File_Therion_Shot::aliasField()
    Get alias for normalized field name.
applyStationNames
in file Station.php, method File_Therion_Station::applyStationNames()
    Apply prefix/postfix setting permanently.
applyStationNames
in file Centreline.php, method File_Therion_Centreline::applyStationNames()
    Apply station-names to all stations of shots from this centreline.
top

b

BasicObject.abstract.php
procedural page BasicObject.abstract.php
top

c

changeEOL
in file Line.php, method File_Therion_Line::changeEOL()
    Change default End-of-Line characters of string representation.
checkSyntax
in file Therion.php, method File_Therion::checkSyntax()
    Check basic syntax of internal line buffer
checkSyntax_keyword
in file Line.php, method File_Therion_Line::checkSyntax_keyword()
    Check syntax on Therion keywords.
clearCentrelines
in file Survey.php, method File_Therion_Survey::clearCentrelines()
    Remove associated centrelines.
clearDate
in file Centreline.php, method File_Therion_Centreline::clearDate()
    Remove all survey dates.
clearDefinitions
in file Grade.php, method File_Therion_Grade::clearDefinitions()
    Clear all definitions from this grade definition.
clearElements
in file Map.php, method File_Therion_Map::clearElements()
    Clear referenced elements from this map.
clearEquates
in file Station.php, method File_Therion_Station::clearEquates()
    Removes all equated stations.
clearExploDate
in file Centreline.php, method File_Therion_Centreline::clearExploDate()
    Remove all survey exploration dates.
clearExploTeam
in file Centreline.php, method File_Therion_Centreline::clearExploTeam()
    Remove all associated exploring team members.
clearExtends
in file Centreline.php, method File_Therion_Centreline::clearExtends()
    Clear all extend definitions of centreline.
clearFix
in file Station.php, method File_Therion_Station::clearFix()
    Removes the fix-data for this station.
clearFixedStations
in file Centreline.php, method File_Therion_Centreline::clearFixedStations()
    Remove associated fixed stations.
clearFormatters
in file Therion.php, method File_Therion::clearFormatters()
    Remove all formatters.
clearJoins
in file Scrap.php, method File_Therion_Scrap::clearJoins()
    Clean existing scrap joins.
clearJoins
in file Survey.php, method File_Therion_Survey::clearJoins()
    Clean existing scrap joins.
clearLeftBezierHandle
in file ScrapLine.php, method File_Therion_ScrapLinePoint::clearLeftBezierHandle()
    Remove left bezier-courve handle.
clearLines
in file Therion.php, method File_Therion::clearLines()
    Clear associated lines.
clearLines
in file ScrapArea.php, method File_Therion_ScrapArea::clearLines()
    Clear referenced lines from this area.
clearMaps
in file Survey.php, method File_Therion_Survey::clearMaps()
    Remove associated maps.
clearObjects
in file Therion.php, method File_Therion::clearObjects()
    Clear associated objects.
clearObjects
in file Scrap.php, method File_Therion_Scrap::clearObjects()
    Clear associated objects.
clearRightBezierHandle
in file ScrapLine.php, method File_Therion_ScrapLinePoint::clearRightBezierHandle()
    Remove left bezier-courve handle.
clearScraps
in file Survey.php, method File_Therion_Survey::clearScraps()
    Remove associated scraps.
clearShots
in file Centreline.php, method File_Therion_Centreline::clearShots()
    Remove all associated shots from this centreline.
clearSurface
in file Survey.php, method File_Therion_Survey::clearSurface()
    Remove associated surface definitions.
clearSurveys
in file Survey.php, method File_Therion_Survey::clearSurveys()
    Remove associated subsurveys.
clearTeam
in file Centreline.php, method File_Therion_Centreline::clearTeam()
    Remove all associated team members.
count
in file Survey.php, method File_Therion_Survey::count()
    Count subsurveys of this survey (SPL Countable).
count
in file Therion.php, method File_Therion::count()
    Count (wrapped) lines in this file (SPL Countable).
count
in file Scrap.php, method File_Therion_Scrap::count()
    Count number of elements of this scrap (SPL Countable).
count
in file Join.php, method File_Therion_Join::count()
    Count arguments of this join (SPL Countable).
count
in file Grade.php, method File_Therion_Grade::count()
    Count valid definitions (SPL-Interface)
count
in file Centreline.php, method File_Therion_Centreline::count()
    Count number of shots of this centreline (SPL Countable).
count
in file Line.php, method File_Therion_Line::count()
    Count (wrapped) lines in this line (SPL Countable).
count
in file Map.php, method File_Therion_Map::count()
    Count number of elements of this map (SPL Countable).
count
in file Surface.php, method File_Therion_Surface::count()
    Count number of data elements (SPL Countable).
count
in file ScrapLine.php, method File_Therion_ScrapLine::count()
    Count points of this line (SPL Countable).
Centreline.php
procedural page Centreline.php
top

d

dereferenceElements
in file Map.php, method File_Therion_Map::dereferenceElements()
    Dereference element references using given survey.
dereferenceLines
in file ScrapArea.php, method File_Therion_ScrapArea::dereferenceLines()
    Dereference line reference using given scrap.
top

e

encode
in file Therion.php, method File_Therion::encode()
    Encode data.
escape
in file Line.php, method File_Therion_Line::escape()
    Escapes one or more datafields for proper therion syntax.
evalInputCMD
in file Therion.php, method File_Therion::evalInputCMD()
    Scan local filebuffer for 'input' commands and execute them.
expectMoreLines
in file Line.php, method File_Therion_Line::expectMoreLines()
    Let the Line know that it should expect an additional wrapped line.
extractMultilineCMD
in file Therion.php, method File_Therion::extractMultilineCMD()
    Build structure of local-scope multiline commands with associated lines.
extractOptions
in file Line.php, method File_Therion_Line::extractOptions()
    Extract options given to a command in this line.
Exception.php
procedural page Exception.php
top

f

$formatters
in file Therion.php, variable File_Therion::$formatters
    Registered formatters.
fetch
in file Therion.php, method File_Therion::fetch()
    Update the internal line representation of this file from datasource.
File_Therion
in file Therion.php, class File_Therion
    Class representing a therion file.
File_Therion_BasicObject
in file BasicObject.abstract.php, class File_Therion_BasicObject
    Abstract Class representing a basic therion object.
File_Therion_Centreline
in file Centreline.php, class File_Therion_Centreline
    Class representing a therion centreline object.
File_Therion_Exception
in file Exception.php, class File_Therion_Exception
    Basic Therion Exception designating a generic error.
File_Therion_Grade
in file Grade.php, class File_Therion_Grade
    Class representing a therion grade definition object.
File_Therion_InvalidReferenceException
in file Exception.php, class File_Therion_InvalidReferenceException
    Therion Exception designating a referencing error
File_Therion_IOException
in file Exception.php, class File_Therion_IOException
    Basic Therion Exception designating a IO-Error.
File_Therion_Join
in file Join.php, class File_Therion_Join
    Class representing a join definition object.
File_Therion_Line
in file Line.php, class File_Therion_Line
    A single logical line of a Therion file.
File_Therion_Map
in file Map.php, class File_Therion_Map
    Class representing a therion map definition object.
File_Therion_Scrap
in file Scrap.php, class File_Therion_Scrap
    Class representing a therion scrap object.
File_Therion_ScrapArea
in file ScrapArea.php, class File_Therion_ScrapArea
    Class representing a scrap area definition object.
File_Therion_ScrapLine
in file ScrapLine.php, class File_Therion_ScrapLine
    Class representing a scrap line definition object.
File_Therion_ScrapLinePoint
in file ScrapLine.php, class File_Therion_ScrapLinePoint
    Class describing a ScrapLine Point (a bezier courve point).
File_Therion_ScrapPoint
in file ScrapPoint.php, class File_Therion_ScrapPoint
    Class representing a scrap point definition object.
File_Therion_Shot
in file Shot.php, class File_Therion_Shot
    Class representing a therion shot object.
File_Therion_Station
in file Station.php, class File_Therion_Station
    Class representing a therion station object.
File_Therion_Surface
in file Surface.php, class File_Therion_Surface
    Class representing a therion surface object.
File_Therion_Survey
in file Survey.php, class File_Therion_Survey
    Class representing a therion survey object.
File_Therion_SyntaxException
in file Exception.php, class File_Therion_SyntaxException
    Therion Exception designating a file format syntax error
FILE_THERION_VERSION
in file Therion.php, constant FILE_THERION_VERSION
    File_Therion Version
filterNonEmpty
in file Line.php, method File_Therion_Line::filterNonEmpty()
    Filter empty Therion data lines out of array.
format
in file Therion.php, method File_Therion::format()
    Format lines using registered formatters.
top

g

Grade.php
procedural page Grade.php
getAllFlags
in file Station.php, method File_Therion_Station::getAllFlags()
    Get all active station flags.
getAllFlags
in file Shot.php, method File_Therion_Shot::getAllFlags()
    Get all active shot flags.
getAllObjects
in file Scrap.php, method File_Therion_Scrap::getAllObjects()
    Get all associated objects of this scrap.
getAllObjects
in file Therion.php, method File_Therion::getAllObjects()
    Get all associated objects of this file.
getAllStations
in file Survey.php, method File_Therion_Survey::getAllStations()
    Get all stations defined in all centrelines.
getAreas
in file Scrap.php, method File_Therion_Scrap::getAreas()
    Get all Area objects of this scrap.
getArguments
in file Join.php, method File_Therion_Join::getArguments()
    Return joined objects.
getAuthor
in file Centreline.php, method File_Therion_Centreline::getAuthor()
    Return author.
getBackBearing
in file Shot.php, method File_Therion_Shot::getBackBearing()
    Calculate backwards compass reading.
getBackGradient
in file Shot.php, method File_Therion_Shot::getBackGradient()
    Calculate backwards clino reading.
getBearing
in file Shot.php, method File_Therion_Shot::getBearing()
    Get shot compass bearing.
getBezierHandleCoordinates
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getBezierHandleCoordinates()
    Return coordinates of bezier courve handles.
getCentrelines
in file Survey.php, method File_Therion_Survey::getCentrelines()
    Get existing Centrelines objects.
getCentrelines
in file Therion.php, method File_Therion::getCentrelines()
    Get all directly associated centrelines of this file.
getComment
in file Station.php, method File_Therion_Station::getComment()
    Get comment of this station.
getComment
in file Line.php, method File_Therion_Line::getComment()
    Returns the unwrapped comment as string.
getContent
in file Line.php, method File_Therion_Line::getContent()
    Returns the unwrapped data-content as string.
getCoordinates
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getCoordinates()
    Return point coordinates.
getCoordinates
in file ScrapPoint.php, method File_Therion_ScrapPoint::getCoordinates()
    Get scrap coordinates of this point.
getCoordinateSystem
in file Surface.php, method File_Therion_Surface::getCoordinateSystem()
    Returns the coordinate system used for fixing stations.
getCoordinateSystem
in file Centreline.php, method File_Therion_Centreline::getCoordinateSystem()
    Returns the coordinate system used for fixing stations.
getCopyright
in file Centreline.php, method File_Therion_Centreline::getCopyright()
    Return copyright.
getData
in file BasicObject.abstract.php, method File_Therion_BasicObject::getData()
    Get some simple data of this object.
getDatafields
in file Line.php, method File_Therion_Line::getDatafields()
    Returns the data part of the line as array.
getDate
in file Centreline.php, method File_Therion_Centreline::getDate()
    Get survey date(s).
getDeclination
in file Centreline.php, method File_Therion_Centreline::getDeclination()
    Get declination of this centreline.
getDefinition
in file Grade.php, method File_Therion_Grade::getDefinition()
    Get the definition of an quantity.
getDownDimension
in file Shot.php, method File_Therion_Shot::getDownDimension()
    Get shot down (height to ground) dimensions.
getElements
in file Map.php, method File_Therion_Map::getElements()
    Get referenced elements.
getEncoding
in file Therion.php, method File_Therion::getEncoding()
    Get encoding of input/output files currently active.
getEquates
in file Survey.php, method File_Therion_Survey::getEquates()
    Get equated stations of this survey.
getEquates
in file Station.php, method File_Therion_Station::getEquates()
    Returns equated stations.
getExploDate
in file Centreline.php, method File_Therion_Centreline::getExploDate()
    Get exploration date.
getExploTeam
in file Centreline.php, method File_Therion_Centreline::getExploTeam()
    Get all exploring team members.
getExtends
in file Centreline.php, method File_Therion_Centreline::getExtends()
    Get extend definitions of centreline.
getFilename
in file Therion.php, method File_Therion::getFilename()
    Get physical file name of this file object.
getFix
in file Station.php, method File_Therion_Station::getFix()
    Gets the fix-data for this station.
getFixedStations
in file Centreline.php, method File_Therion_Centreline::getFixedStations()
    Get existing fixed station objects associated outside of shot data.
getFlag
in file Shot.php, method File_Therion_Shot::getFlag()
    Get a shot flag.
getFlag
in file Station.php, method File_Therion_Station::getFlag()
    Get a station flag.
getFrom
in file Shot.php, method File_Therion_Shot::getFrom()
    Get from (source) station.
getGrade
in file Centreline.php, method File_Therion_Centreline::getGrade()
    Get grade definition(s) of this centreline.
getGradient
in file Shot.php, method File_Therion_Shot::getGradient()
    Get shot gradient.
getHeader
in file Therion.php, method File_Therion::getHeader()
    Get current header string.
getIndent
in file Line.php, method File_Therion_Line::getIndent()
    Returns the indenting characters.
getJoins
in file Scrap.php, method File_Therion_Scrap::getJoins()
    Get existing scrap joins.
getJoins
in file Survey.php, method File_Therion_Survey::getJoins()
    Get existing scrap joins.
getLeftBezierHandleCoordinates
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getLeftBezierHandleCoordinates()
    Return coordinates of left bezier courve handle.
getLeftDimension
in file Shot.php, method File_Therion_Shot::getLeftDimension()
    Get shot left dimensions.
getLength
in file Shot.php, method File_Therion_Shot::getLength()
    Get shot length.
getLine
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getLine()
    Return reference to line this point is part of.
getLinePoints
in file ScrapLine.php, method File_Therion_ScrapLine::getLinePoints()
    Get points of this line.
getLines
in file Therion.php, method File_Therion::getLines()
    Get internal line buffer.
getLines
in file ScrapArea.php, method File_Therion_ScrapArea::getLines()
    Get referenced lines.
getLines
in file Scrap.php, method File_Therion_Scrap::getLines()
    Get all Line objects of this scrap.
getLRUDdata
in file Shot.php, method File_Therion_Shot::getLRUDdata()
    Get LRUD information compacted.
getMaps
in file Therion.php, method File_Therion::getMaps()
    Get all directly associated Maps of this file.
getMaps
in file Survey.php, method File_Therion_Survey::getMaps()
    Get existing Map objects.
getMark
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getMark()
    Return point mark.
getName
in file Surface.php, method File_Therion_Surface::getName()
    Get name (id) of this surface object.
getName
in file Map.php, method File_Therion_Map::getName()
    Get name (id) of this map.
getName
in file Survey.php, method File_Therion_Survey::getName()
    Get name (id) of this survey.
getName
in file Scrap.php, method File_Therion_Scrap::getName()
    Get name (id) of this scrap.
getName
in file Grade.php, method File_Therion_Grade::getName()
    Get name (id) of this grade definition.
getName
in file Station.php, method File_Therion_Station::getName()
    Get name of this station.
getObjects
in file Therion.php, method File_Therion::getObjects()
    Get all associated objects of this file.
getObjects
in file Scrap.php, method File_Therion_Scrap::getObjects()
    Get all associated objects of this file.
getOption
in file BasicObject.abstract.php, method File_Therion_BasicObject::getOption()
    Get option of this object.
getOption
in file ScrapArea.php, method File_Therion_ScrapArea::getOption()
    Options with area objects are not supported by therion.
getOptionsString
in file BasicObject.abstract.php, method File_Therion_BasicObject::getOptionsString()
    Generate basic options string.
getOrder
in file Shot.php, method File_Therion_Shot::getOrder()
    Get data definition order of this shot.
getOrderedData
in file Shot.php, method File_Therion_Shot::getOrderedData()
    Returns array with data fields ordered by current order.
getParent
in file Survey.php, method File_Therion_Survey::getParent()
    Returns the parent survey of this survey.
getPoints
in file Scrap.php, method File_Therion_Scrap::getPoints()
    Get all Point objects of this scrap.
getRightDimension
in file Shot.php, method File_Therion_Shot::getRightDimension()
    Get shot right dimensions.
getScraps
in file Therion.php, method File_Therion::getScraps()
    Get all directly associated Scraps of this file.
getScraps
in file Survey.php, method File_Therion_Survey::getScraps()
    Get existing Scrap objects.
getShots
in file Centreline.php, method File_Therion_Centreline::getShots()
    Get all shots of this centreline.
getSmoothness
in file ScrapLine.php, method File_Therion_ScrapLinePoint::getSmoothness()
    Return smothness setting.
getStationNames
in file Station.php, method File_Therion_Station::getStationNames()
    Get station-names (pre-/postfix).
getStationNames
in file Centreline.php, method File_Therion_Centreline::getStationNames()
    Get station-names (pre-/postfix).
getStations
in file Centreline.php, method File_Therion_Centreline::getStations()
    Get all station objects.
getStyle
in file Shot.php, method File_Therion_Shot::getStyle()
    Get data definition style of this shot
getSurfaces
in file Survey.php, method File_Therion_Survey::getSurfaces()
    Get existing surface objects.
getSurfaces
in file Therion.php, method File_Therion::getSurfaces()
    Get all directly associated Surface definitions of this file.
getSurveyContext
in file Centreline.php, method File_Therion_Centreline::getSurveyContext()
    Get survey context of this equate.
getSurveyContext
in file Station.php, method File_Therion_Station::getSurveyContext()
    Get survey context of this station.
getSurveys
in file Survey.php, method File_Therion_Survey::getSurveys()
    Get existing subsurveys.
getSurveys
in file Therion.php, method File_Therion::getSurveys()
    Get all directly associated surveys of this file.
getTeam
in file Centreline.php, method File_Therion_Centreline::getTeam()
    Get all surveying team members.
getTeamRoles
in file Centreline.php, method File_Therion_Centreline::getTeamRoles()
    Get surveying roles of a team member.
getTo
in file Shot.php, method File_Therion_Shot::getTo()
    Get to (targeted) station.
getType
in file ScrapPoint.php, method File_Therion_ScrapPoint::getType()
    Get point main type.
getType
in file ScrapArea.php, method File_Therion_ScrapArea::getType()
    Get area type.
getUnit
in file Centreline.php, method File_Therion_Centreline::getUnit()
    Get current default unit for shots.
getUnit
in file Shot.php, method File_Therion_Shot::getUnit()
    Get current unit for measurement.
getUpDimension
in file Shot.php, method File_Therion_Shot::getUpDimension()
    Get shot up (height to ceiling) dimensions.
getVersion
in file Therion.php, method File_Therion::getVersion()
    Returns the current release version, may be called statically
getX
in file ScrapPoint.php, method File_Therion_ScrapPoint::getX()
    Get scrap X coordinate of this point.
getY
in file ScrapPoint.php, method File_Therion_ScrapPoint::getY()
    Get scrap Y coordinate of this point.
top

h

handleCommonOption
in file BasicObject.abstract.php, method File_Therion_BasicObject::handleCommonOption()
    Handle known options supported by several objects.
handleEncodingLine
in file Therion.php, method File_Therion::handleEncodingLine()
    Handle 'encoding' command in internal line buffer.
hasSplayStation
in file Shot.php, method File_Therion_Shot::hasSplayStation()
    Tell if this shot is a splay shot due to naming conventions.
top

i

isCommentOnly
in file Line.php, method File_Therion_Line::isCommentOnly()
    Say if this is just a comment or empty line.
isContinuation
in file Line.php, method File_Therion_Line::isContinuation()
    Detect if the line is a continuation of a wrapped one.
isContinued
in file Line.php, method File_Therion_Line::isContinued()
    Detect if this Line expects wrapped content in the following physical line.
isFixed
in file Station.php, method File_Therion_Station::isFixed()
    Tell if this station has defined fixes.
isWrapped
in file Line.php, method File_Therion_Line::isWrapped()
    Detect if this logical Line contains wrapped physical data.
top

j

Join.php
procedural page Join.php
top

l

Line.php
procedural page Line.php
top

m

Map.php
procedural page Map.php
top

o

$objStack
in file BasicObject.abstract.php, variable File_Therion_BasicObject::$objStack
    Object data stack.
top

p

parse
in file Shot.php, method File_Therion_Shot::parse()
    Parse string content into a shot object using ordering information.
parse
in file ScrapPoint.php, method File_Therion_ScrapPoint::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Station.php, method File_Therion_Station::parse()
    Parse Therion_Line into station object.
parse
in file Surface.php, method File_Therion_Surface::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Therion.php, method File_Therion::parse()
    Parse datasource into objects.
parse
in file Survey.php, method File_Therion_Survey::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file ScrapLine.php, method File_Therion_ScrapLine::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file ScrapArea.php, method File_Therion_ScrapArea::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Join.php, method File_Therion_Join::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Grade.php, method File_Therion_Grade::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Line.php, method File_Therion_Line::parse()
    Parse a physical Therion line into its contents.
parse
in file Map.php, method File_Therion_Map::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Scrap.php, method File_Therion_Scrap::parse()
    Parses given Therion_Line-objects into internal data structures.
parse
in file Centreline.php, method File_Therion_Centreline::parse()
    Parses given Therion_Line-objects into internal data structures.
top

r

reverse
in file Shot.php, method File_Therion_Shot::reverse()
    Swap direction of measurement of this shot.
top

s

Scrap.php
procedural page Scrap.php
ScrapArea.php
procedural page ScrapArea.php
ScrapLine.php
procedural page ScrapLine.php
ScrapPoint.php
procedural page ScrapPoint.php
Shot.php
procedural page Shot.php
Station.php
procedural page Station.php
Surface.php
procedural page Surface.php
Survey.php
procedural page Survey.php
setAuthor
in file Centreline.php, method File_Therion_Centreline::setAuthor()
    Sets author remark.
setBearing
in file Shot.php, method File_Therion_Shot::setBearing()
    Set shot compass bearing.
setComment
in file Station.php, method File_Therion_Station::setComment()
    Set Comment of this station.
setCommentSeparator
in file Line.php, method File_Therion_Line::setCommentSeparator()
    Set separator for appending comments to datalines in output (toString().
setContent
in file Line.php, method File_Therion_Line::setContent()
    Set payload of the line.
setCoordinateSystem
in file Centreline.php, method File_Therion_Centreline::setCoordinateSystem()
    Sets the coordinate system that is used for fixing stations.
setCoordinateSystem
in file Surface.php, method File_Therion_Surface::setCoordinateSystem()
    Sets the coordinate system that is used for fixing stations.
setCopyright
in file Centreline.php, method File_Therion_Centreline::setCopyright()
    Sets copyright remark.
setData
in file BasicObject.abstract.php, method File_Therion_BasicObject::setData()
    Set some simple data of this object.
setDeclination
in file Centreline.php, method File_Therion_Centreline::setDeclination()
    Set declination of this centreline.
setDefinition
in file Grade.php, method File_Therion_Grade::setDefinition()
    Set a definition element of this grade definition.
setDownDimension
in file Shot.php, method File_Therion_Shot::setDownDimension()
    Set shot down (height to ground) dimensions.
setEncoding
in file Therion.php, method File_Therion::setEncoding()
    Set encoding of input/output files.
setExtend
in file Centreline.php, method File_Therion_Centreline::setExtend()
    Modify extend definition of centreline.
setFilename
in file Therion.php, method File_Therion::setFilename()
    Set filename of this file object.
setFix
in file Station.php, method File_Therion_Station::setFix()
    Set fixed surface coordinates for this station.
setFlag
in file Shot.php, method File_Therion_Shot::setFlag()
    Set shot flag.
setFlag
in file Station.php, method File_Therion_Station::setFlag()
    Set station flag.
setFrom
in file Shot.php, method File_Therion_Shot::setFrom()
    Set from (source) station.
setGrade
in file Centreline.php, method File_Therion_Centreline::setGrade()
    Set grade(s) applying to this centreline.
setGradient
in file Shot.php, method File_Therion_Shot::setGradient()
    Set shot gradient.
setHeader
in file Therion.php, method File_Therion::setHeader()
    Set header string, that will be printed to generated files.
setIndent
in file Line.php, method File_Therion_Line::setIndent()
    Set indenting for output (toString().
setLeftBezierHandle
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setLeftBezierHandle()
    Set left bezier-courve handle position.
setLeftDimension
in file Shot.php, method File_Therion_Shot::setLeftDimension()
    Set shot left dimensions.
setLength
in file Shot.php, method File_Therion_Shot::setLength()
    Set shot length.
setMark
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setMark()
    Set mark (alternative ID) of this point.
setName
in file Surface.php, method File_Therion_Surface::setName()
    Change name (id) of this surface object.
setName
in file Map.php, method File_Therion_Map::setName()
    Change name (id) of this map.
setName
in file Station.php, method File_Therion_Station::setName()
    Set Name/ID of this station.
setName
in file Survey.php, method File_Therion_Survey::setName()
    Change name (id) of this survey.
setName
in file Grade.php, method File_Therion_Grade::setName()
    Change name (id) of this grade definition.
setName
in file Scrap.php, method File_Therion_Scrap::setName()
    Change name (id) of this scrap.
setOption
in file ScrapArea.php, method File_Therion_ScrapArea::setOption()
    Options with area objects are not supported by therion.
setOption
in file BasicObject.abstract.php, method File_Therion_BasicObject::setOption()
    Set options of this object.
setOrder
in file Shot.php, method File_Therion_Shot::setOrder()
    Set data definition order of this shot.
setParent
in file Survey.php, method File_Therion_Survey::setParent()
    Sets the parent survey of this survey.
setReader
in file Therion.php, method File_Therion::setReader()
    Set default reader that is used to fetch file content.
setRightBezierHandle
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setRightBezierHandle()
    Set right bezier-courve handle position.
setRightDimension
in file Shot.php, method File_Therion_Shot::setRightDimension()
    Set shot right dimensions.
setSmoothness
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setSmoothness()
    Set smoothness of this point
setStationNames
in file Centreline.php, method File_Therion_Centreline::setStationNames()
    Set station names pre-/postfix for newly added shots/stations.
setStationNames
in file Station.php, method File_Therion_Station::setStationNames()
    Set prefix/postfix of this station.
setStyle
in file Shot.php, method File_Therion_Shot::setStyle()
    Set data definition style of this shot
setSurveyContext
in file Station.php, method File_Therion_Station::setSurveyContext()
    Set local survey context of this station.
setSurveyContext
in file Centreline.php, method File_Therion_Centreline::setSurveyContext()
    Set local survey context of this centreline.
setTo
in file Shot.php, method File_Therion_Shot::setTo()
    Set to (targeted) station.
setType
in file ScrapPoint.php, method File_Therion_ScrapPoint::setType()
    Set main type of point.
setType
in file ScrapArea.php, method File_Therion_ScrapArea::setType()
    Set type of area.
setUnit
in file Shot.php, method File_Therion_Shot::setUnit()
    Set unit for measurements of this shot.
setUnit
in file Centreline.php, method File_Therion_Centreline::setUnit()
    Set default unit for shots.
setUpDimension
in file Shot.php, method File_Therion_Shot::setUpDimension()
    Set shot up (height to ceiling) dimensions.
setX
in file ScrapPoint.php, method File_Therion_ScrapPoint::setX()
    Set X scrap coordinate value of point.
setX
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setX()
    Set Points X coordinate on the scrap.
setY
in file ScrapLine.php, method File_Therion_ScrapLinePoint::setY()
    Set Points Y coordinate on the scrap.
setY
in file ScrapPoint.php, method File_Therion_ScrapPoint::setY()
    Set Y scrap coordinate value of point.
stripStationNames
in file Centreline.php, method File_Therion_Centreline::stripStationNames()
    Strip station-names from all stations of shots from this centreline.
stripStationNames
in file Station.php, method File_Therion_Station::stripStationNames()
    Strip prefix/postfix setting from name.
top

t

Therion.php
procedural page Therion.php
toEquateString
in file Station.php, method File_Therion_Station::toEquateString()
    Return equate command as string.
toFixString
in file Station.php, method File_Therion_Station::toFixString()
    Generate "fix ..." string for this station.
toLines
in file Survey.php, method File_Therion_Survey::toLines()
    Generate line content from this object.
toLines
in file Centreline.php, method File_Therion_Centreline::toLines()
    Generate line content from this object.
toLines
in file Shot.php, method File_Therion_Shot::toLines()
    Return formatted datafields as Therion Line in current order.
toLines
in file Grade.php, method File_Therion_Grade::toLines()
    Generate line content from this object.
toLines
in file Join.php, method File_Therion_Join::toLines()
    Return Line representation of this command.
toLines
in file Line.php, method File_Therion_Line::toLines()
    Return this line as object.
toLinesDataDef
in file Shot.php, method File_Therion_Shot::toLinesDataDef()
    Return formatted datadefinition as Therion Line.
toLinesUnitsDef
in file Shot.php, method File_Therion_Shot::toLinesUnitsDef()
    Return formatted units definitions for data defintion as Therion Line(s).
toStationString
in file Station.php, method File_Therion_Station::toStationString()
    Generate "station ..." string for this station.
toString
in file Therion.php, method File_Therion::toString()
    Get file lines as string.
toString
in file Line.php, method File_Therion_Line::toString()
    Returns the whole line as String.
toString
in file ScrapLine.php, method File_Therion_ScrapLinePoint::toString()
    Generate therion compatible string representation of this point.
toString
in file Join.php, method File_Therion_Join::toString()
    Return therion compatible string of this join definition.
top

u

unaliasField
in file Shot.php, method File_Therion_Shot::unaliasField()
    Resolve field name alias to normalized name.
unescape
in file Line.php, method File_Therion_Line::unescape()
    Unescapes one or more datafields for proper processing in PHP.
updateLines
in file Therion.php, method File_Therion::updateLines()
    Update the internal line representation of this file from contained objects.
updateObjects
in file Therion.php, method File_Therion::updateObjects()
    Parses the internal line buffer to associated Therion objects.
updateShotStationNames
in file Centreline.php, method File_Therion_Centreline::updateShotStationNames()
    Update station-names setting in all shots of this centreline.
top

w

write
in file Therion.php, method File_Therion::write()
    Write this therion file content to the file.
top

Documentation generated on Mon, 11 Mar 2019 15:09:45 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.