FMXXXX Parser Documentation 0.1
FM2100, FM2200, FM4100 and FM4200 Data Parser

IOElement Class Reference

Public Member Functions

 __construct ($args=array())
 getEventIOID ()
 getTotalIO ()
 setEventIOID ($val)
 setTotalIO ($val)
 getIO ($size)
 getAllIO ()
 setIO ($size, $io)
 isOnEvent ()

Detailed Description

IO Element object for Teltonika's FMXXXX GPS device.

Author:
Thierno Ib. Barry < >
Date:
26 Feb 2011
See also:
Teltonika FMXXXX Protocols GNU/LGPL v2.1
Todo:
Add getters to get Hex values (getHexVaribleName)
Example: getHexEventID()

Constructor & Destructor Documentation

__construct ( args = array())

Constructor

Parameters:
array$argsConstructor arguments

Member Function Documentation

getAllIO ( )

Get all IOs.

Returns:
array Return an array of all IOs
getEventIOID ( )

Get the Event IO ID value converted in integer.

Returns:
int Return the Event IO ID converted in integer
getIO ( size)

Get IO.

Parameters:
int$sizeThe length (type) of IO's property which is wanted.
Returns:
IO Return wanted IO or false if the given size doesn't exist
getTotalIO ( )

Get the number of IO value converted in integer. Total number of properties coming with record.

Returns:
int Return the number total of IO converted in integer
isOnEvent ( )

Check if data is acquired on event or not

Returns:
boolean Return true if data is acquired on event and false if not
setEventIOID ( val)

Setter for the Event IO ID. Note: The value must be in Hexadecimal.

Parameters:
string$valThe Event IO ID value in Hex base (16)
setIO ( size,
io 
)

Setter for a type of IO. Note: Both of the parameters must be an Hexadecimal value

Parameters:
int$sizeThe length (type) of IO's property which is wanted to add.
IO$ioIO object
setTotalIO ( val)

Setter for the number of IO. Note: The value must be in Hexadecimal.

Parameters:
string$valThe number of IO value in Hex base (16)

The documentation for this class was generated from the following file:
 All Data Structures Files Functions Variables Enumerations