API Documentation
\

\SCDPlant

SCDPlant - classe per il confermento alla Città Metropolitana di Venezia i dati dell'impianto di fusione del vetro

Summary

Methods
Properties
Constants
__construct()
__construct1()
initRegister()
packData()
validateDoc()
deliverToDatacenter()
connect()
send()
getListaTracciati()
sendReports()
emptyWorkingFolders()
sendWarning()
$xmlmodel
$xmlmodelschema
$datacenterurl
$maxdeliverablerecords
$name
$code
$subscriptiondate
$emailto
$emailcc
$username
$password
$datafolder
$deliveringdatapace
$sendingreportpace
$datalogger
$datamodel
$smtp
$map
$xmldoc
$logfilename
No constants found
No protected methods found
No protected properties found
N/A
retrieveDataFile()
getColumnList()
parseDataModel()
massageData()
getXmlSkeleton()
libxml_display_error()
libxml_display_errors()
validateXmlDoc()
fillXmlFragment()
moveXmlDoc()
parseJSON()
createArchive()
createArchives()
emptyFolder()
$rowbegindata
N/A

Properties

$xmlmodel

$xmlmodel : string

Nome del file di modello xml per il conferimento dei dati al datacenter.

Type

string

$xmlmodelschema

$xmlmodelschema : string

Nome dello schema xml per il file di modello conferimento dei dati al datacenter.

Da utilizzare per la convalida

Type

string

$datacenterurl

$datacenterurl : string

Url del datacenter addetto all'acquisizione dei tracciati

Type

string

$maxdeliverablerecords

$maxdeliverablerecords : integer

Numero massimo di record XML conferibili in una singola trasmissione

Type

integer

$name

$name : string

Nome in chiaro dell'impianto

Type

string

$code

$code : string

Codice dell'impianto (assegnato dal sistema della Città Metropolitana)

Type

string

$subscriptiondate

$subscriptiondate : \datetime

Data di sottoscrizione del servizio di conferimento oppure data di attivazione del servizio di conferimento in modalità stand-alone Il valore è utilizzato, assieme a $deliveringdatapeace, per calcolare la cadenza di invio dei reports agli operatori e ai supervisori

Type

\datetime

$emailto

$emailto : array

Lista delle email degli operatori dell'impianto incaricati della lettura dei reports inviati dal software di conferimento al datacenter

Type

array

$emailcc

$emailcc : array

Lista delle email degli operatori dell'impianto addetti alla supervisione/conoscenza dei reports inviati dal software di conferimento al datacenter

Type

array

$username

$username : string

Nome utente per l'accesso al datacenter di acquisizione dei tracciati (assegnato dal sistema della Città Metropolitana)

Type

string

$password

$password : string

Password per l'accesso al datacenter di acquisizione dei tracciati (assegnata dal sistema della Città Metropolitana)

Type

string

$datafolder

$datafolder :

Cartella locale contenente i file di registro trasferiti dal datalogger; se non preceduta da un percorso completo sarà interpretata come relativa alla cartella di installazione del programma.

Type

$deliveringdatapace

$deliveringdatapace : integer

Intervallo di conferimento al datacenter dei dati elaborati dal datalogger.

Il valore è espresso in minuti. Valore predefinito: 60 (artigiani; 5 per le imprese).

Type

integer

$sendingreportpace

$sendingreportpace : integer

Intervallo di invio del report agli incaricati della lettura/supervisione Il valore è espresso in giorni.

Valore predefinito: 7.

Type

integer

$datalogger

$datalogger : array

Scheda tecnica del datalogger

Type

array — contiene: @var string manifacturer: produttore @var string model: modello @var string monitorpace: intervallo di misurazione del dato espresso in minuti @var string datatransfer: modalità di invio dei dati al software di conferimento (valore predefinito: ftp) @var string dataformat: formato dei dati registrati dal datalogger (valore predefinito: cvs) @var filenamemodel: modello di struttura del nome del file dati registrato dal datalogger @var totalfilenumber: numero dei file trasferiti dal datalogger per ciascun ciclo di misurazioni (valore predefinito: 1)

$datamodel

$datamodel : array

Modello dei dati fornito dal datalogger.

Type

array — contiene: <field order="n" name="<name>" map="<map>" type="<datatyp>"/> dove order=posizione della colonna nel file di registrazione dei dati name=nome della colonna nel file di registrazione dei dati map [opzionale]= campo del modello dati di conferimento sul quale è mappato il valore del campo corrente type= tipo dati

$smtp

$smtp : array

Configuazione dell'smtp server usato dal software di conferimento per l'invio dei report via email

Type

array — contiene: @var string server: email server address @var string port: email server port @var bool requireauthentication: flag serer richiede autenticazione valore predefinito: true @var string username: nome utente per l'autenticazione @var string password: password per l'autenticazione @var string mailmittente: indirizzo email del mittente del report @var string nomemittente: nome in chiaro del mittente del report @var string replyto: indirizzo email da utilizzare per la risposta (opzionale)

$map

$map : array

Valori richiesti dal sistema di acquisizione dei tracciati mappati sui campi del modello dati esposto dal datalogger

Type

array — contiene: $map["Data"]="TIMESTAMP"; $map["Ora"]="TIMESTAMP"; $map["IniezioneCalce"]="VBAT"; $map["BypassAbbattitore"]="POW"; $map["Temperatura"]="forno_1;forno_2;.."; $map["FreeField1"]=""; $map["FreeField2"]=""; $map["FreeField3"]="";

$xmldoc

$xmldoc : string

Lista dei nomi dei file(s) contenenti i documenti xml conferiti al datacenter.

Type

string

$logfilename

$logfilename : string

Nome del file di log da inviare all'operatore (assegnata dal sistema di conferimento: SCDUtils::getStructFilename())

Type

string

$rowbegindata

$rowbegindata :

Riga del file di log a partire dalla quale iniziano i dati

Type

Methods

__construct()

__construct()

__construct1()

__construct1(  $a1)

Parameters

$a1

initRegister()

initRegister()

Inizia le operazioni preliminari per la registrazione locale dei dati 1. verifica delle cartelle 2. assegnazione del nome del file di registro 3. inzializzazione del file di registro

@throws SCDPlanExceptionException

packData()

packData(  $XmlModel,   $XmlModelSchema)

Mappa i dati ricevuti dal datalogger sul modello previsto dal sistema di acquisizione dei tracciati 1. rilevamento del file di dati corretto 2. mappa del contenuto su modello previsto dal sistema di acquisizione dei tracciati 3. registrazione dell'operazione

Parameters

$XmlModel
$XmlModelSchema

validateDoc()

validateDoc(  $Filename)

Parameters

$Filename

deliverToDatacenter()

deliverToDatacenter(  $DatacenterUrl)

Conferimento del documento xml al datacenter

Parameters

$DatacenterUrl

Throws

\SCDPlanExceptionException

connect()

connect()

send()

send()

getListaTracciati()

getListaTracciati()

sendReports()

sendReports()

invia i report agli operatori e ai supervisori basandosi sulle istruzioni contenute nel file d configurazione

emptyWorkingFolders()

emptyWorkingFolders()

archivia le cartelle contenenti i dati conferiti e i report inviati.

L'archiviazione avviene tramite rinomina delle cartelle

sendWarning()

sendWarning(  $Subject,   $Content)

Parameters

$Subject
$Content

retrieveDataFile()

retrieveDataFile() : array

Individua il/i file di registro candidati all'estrazione del dato da conferire alla città metropolitana

Returns

array —

wfl (WorkingFileList), contenente l'elenco dei file candidati all'estrazione dei dati

getColumnList()

getColumnList(  $Filename)

Parameters

$Filename

parseDataModel()

parseDataModel(  $Filename) : array

Legge il/i file candidati al conferimento al sistema di acquisizione dei tracciati, analizza il contenuto per ricostrurne il modello e lo confronta con il modello dichiarato nel file di configurazione.

Se l'esito è positivo restituisce un array contenente il modello dati (ridondante rispetto al modello letto dal file di configurazione).

Parameters

$Filename

Returns

array —

dm (DataModel) @throws SCDPlanExceptionException

massageData()

massageData(  $DataModel,   $Filename)

Apre il file candidato all'estrazione dei dati e verifica il contenuto di ciascuna riga.

La condizione per l'elezione della riga alla spedizione è il confronto tra il timestamp di ciascun record, il timestamp del conferimento e l'intervallo del p eriodo di conferimento al datacenter previsto. Individuato il record per l'invio si procede alla compilazione di una record XML tracciato e lo si registra in un array fino a un massimo di $maxdeliverablerecords; raggiunto questo limite si confeziona il documento completo e si procede con il conferimento al datacenter.

Parameters

$DataModel
$Filename

Throws

\SCDPlanExceptionException

getXmlSkeleton()

getXmlSkeleton() : \DOMDocument:

ottiene una copia per l'editin del documento xml per il conferimento

Returns

\DOMDocument: —

un clone del documento xml per il conferimento

libxml_display_error()

libxml_display_error(  $error)

Parameters

$error

libxml_display_errors()

libxml_display_errors()

validateXmlDoc()

validateXmlDoc()

fillXmlFragment()

fillXmlFragment(  $Tracciato,   $Database,   $TemperatureField)

Popola il record xml per il conferimento al datacenter dei dati di registro.

Parameters

$Tracciato
$Database
$TemperatureField

Throws

\SCDPlanExceptionException

moveXmlDoc()

moveXmlDoc(string  $Destination)

sposta il file xml da /prepared/ a /sent/ o /failed/

Parameters

string $Destination

parseJSON()

parseJSON(  $JsonString)

decodifica la stringa restituita dal datacenter

Parameters

$JsonString

Throws

\SCDPlanExceptionException

createArchive()

createArchive(  $Archive,   $SourcePath,   $Glob,   $Ext)

Parameters

$Archive
$SourcePath
$Glob
$Ext

createArchives()

createArchives()

crea gli allegati per i report da inviare a operatori e supervisori

@return $al array: lista degli allegati

emptyFolder()

emptyFolder(  $Folder)

Parameters

$Folder