Class MyProperties ver.1.

8
G.Parrini

S.M. Scienzia Machinale srl Via Giuntini 13/25 56023 Navacchio di Cascina PISA - ITALY Settembre 2011 Class MyProperties ver.1.8 - pag. 1 di 12

Indice generale
Cap.1- Installazione.................................................................................................................................. 3 1.1 Contenuto del pacchetto di installazione.........................................................................................3 1.2 Copiare il file .class......................................................................................................................... 3 1.3 Aggiungere Variabile di ambiente....................................................................................................3 Cap.2- Utilizzo.......................................................................................................................................... 4 2.1 Assegnazione ad una Global Property ...........................................................................................4 2.2 Utilizzo come Label di Sheet........................................................................................................... 5 Cap.3- Metodi implementati...................................................................................................................... 6 3.1 String getVersion............................................................................................................................. 6 3.2 String setCSYSonName.................................................................................................................. 6 3.3 String setPortNumber...................................................................................................................... 7 3.4 String setLeadingZeroes................................................................................................................. 7 3.5 String isConnected.......................................................................................................................... 7 3.6 String getFirstConnectedFiber........................................................................................................ 8 3.7 String getFirstConnectedFiberAllType.............................................................................................8 3.8 String getWhoisConnected............................................................................................................. 9 3.9 String firstConnected..................................................................................................................... 10 3.10 String getContainerProperty........................................................................................................10 3.11 String getRealMultiplied............................................................................................................... 11

Class MyProperties ver.1.8 - pag. 2 di 12

Cap.1- Installazione

1.1 Contenuto del pacchetto di installazione.

Il pacchetto di installazione contiene il file MyProperties.class e la presente documentazione. Il file MyProperties.class un compilato Java, adatto per essere richiamato da RSD.

1.2 Copiare il file .class

il file MyProperties.class va copiato in una directory del disco fisso locale. Si consiglia di crearne una apposita, di nome evocativo.

1.3 Aggiungere Variabile di ambiente

Definire la seguente variabile di ambiente, dopo aver definito la directory (vedi par. precedente) dove copiare la classe CLIENT_CLASSPATH
inserire il percorso della directory dove RSD cercher le classi create dall'utente.

Class MyProperties ver.1.8 - pag. 3 di 12

Cap.2- Utilizzo
I metodi implementati, a seconda del come sono realizzati, possono essere assegnati a delle propriet all'interno delle Global Properties oppure visualizzati nelle label di sheet.

2.1 Assegnazione ad una Global Property

1. Si apra quindi Global Properties. 2. Si cerchi o si istanzi la propriet sulla quale vogliamo agire. 3. Nel dialogo Property Definition si spunti Derived Property e si clicchi su Define Function 4. Il nome del metodo dovr essere preceduta dal nome della classe e il tutto inserito fra parentesi graffe. Ad esempio, se la funzione setCSYSonName dovremo scrivere {MyProperties.setCSYSonName} 5. Se il metodo ha bisogno di parametri, Inserirli dal dialogo Define Function, scrivendo il nome o il valore del parametro (secondo quanto stabilito nella definizione del metodo) e premendo Add

Class MyProperties ver.1.8 - pag. 4 di 12

2.2 Utilizzo come Label di Sheet

Tramite il toolbar Diagramming possibile creare dentro un foglio (sheet) una label di sheet. La icona sulla toolbar la seguente

Nel dialogo che segue si inserisca (nell'esempio la getVersion) {MyProperties.getVersion()}

La label di Sheet puo' quindi essere piazzata dovunque nello sheet attualmente aperto.

Class MyProperties ver.1.8 - pag. 5 di 12

Cap.3- Metodi implementati

3.1 String getVersion

Utilizzo Scopo Parametri Restituisce Errori Esempio d'uso come Label di Sheet Per ottenere la versione di questa libreria Nessuno una stringa del tipo MyProperties Ver.1.5.b Nessuno In una label inserire la stringa {MyProperties.getVersion()}

3.2 String setCSYSonName

Utilizzo Scopo Parametri Restituisce Errori Esempio d'uso come property nelle Porte da utilizzare nella property entry_port di una Porta, per definire automaticamente il nome del CSYS da usare in Pro/Cabling. nessuno L'entry_port sar settato a. stringa pin_ concatenato al nome della porta (property 'name') Nessuno Nelle Global Properties inserire nella propriet entry_port, in Derived property la stringa {MyProperties.setCSYSonName} senza aggiungere parametri

Class MyProperties ver.1.8 - pag. 6 di 12

3.3 String setPortNumber

Utilizzo Scopo come property nelle Porte Per ordinare correttamente i pin dei connettori nei report rsd. da utilizzare con una nuova property port_number, da definire in una Porta, per mettere i nomi delle porte in ordine progressivo alfabetico (modifica il nome porta aggiungendo degli 0 davanti). Parametri Restituisce Errori Esempio d'uso nessuno restituisce una stringa. Il parametro port_number sar settato al valore del nome porta, con degli 0 davanti per un formato del tipo #### Nessuno da completare

3.4 String setLeadingZeroes

Utilizzo Scopo come property nelle Porte Per ordinare correttamente i pin dei connettori nei report rsd. La funzione permette di creare una propriet che, riferendosi ad una propriet numerica, aggiunge fino a maxPlaces '0' davanti al numero corrente e ne restituisce la stringa cosi' realizzata. Per es: se la propriet sorgente vale 31 e MaxPlaces vale 5, restituir '00031' Parametri String sourcePropName il nome della propriet da cui leggere il dato (tale dato deve essere un intero, il nome della propriet una stringa) String maxPlaces il numero (intero, anche se passato come stringa), delle posizioni di leading zero Restituisce restituisce una stringa. Aggiunge fino a maxPlaces '0' davanti al numero corrente e ne restituisce la stringa cosi' realizzata. Per es: se la propriet sorgente vale 31 e MaxPlaces vale 5, restituir '00031' Nessuno da completare

Errori Esempio d'uso

3.5 String isConnected

Class MyProperties ver.1.8 - pag. 7 di 12

Utilizzo Scopo

come property nelle Porte verifica che una porta di tipo wiring sia connessa ad una fibra da utilizzare con una nuova property connesso, da definire in una Porta, per verificare che la porta stessa sia collegata ad una fiber o no.

Parametri Restituisce Errori

nessuno Se la porta connessa ad almeno una fibra restituisce OK Se l'artifact passato non una porta restituisce not_a_port Se la porta non connessa a niente restituisce NULL

Esempio d'uso

Nelle Global Properties inserire nella propriet connesso, in Derived property la stringa {MyProperties.isConnected} senza aggiungere parametri

3.6 String getFirstConnectedFiber

Utilizzo Scopo Parametri come property nelle Porte Se una porta di tipo wiring connessa ad almeno una fibra restituisce la propriet indicata se contenuta nella prima fibra che incontra String wishedProperty il nome della propriet da cui leggere il dato (tale dato deve essere una stringa, il nome della propriet una stringa) Restituisce Errori La funzione restituisce il valore di una propriet della prima fibra collegata Se l'artifact passato non una porta restituisce not_a_port Se la porta non connessa a niente restituisce NO_FIBER Se la wishedProperty non esiste restituisce PROP_NOT_EXIST Esempio d'uso Nelle Global Properties inserire in una propriet come derived Property. Nel dialogo Derived property inserire la stringa {MyProperties.getFirstConnectedFiber} con il nome del parametro desiderato come primo parametro (Es: name)

3.7 String getFirstConnectedFiberAllType

Class MyProperties ver.1.8 - pag. 8 di 12

Utilizzo Scopo Parametri

come property nelle Porte Se una porta di tipo wiring connessa ad almeno una fibra restituisce la propriet indicata se contenuta nella prima fibra che incontra String wishedProperty il nome della propriet da cui leggere il dato (tale dato deve essere una stringa, il nome della propriet una stringa) String PortType un numero. 0 significa Tutti i tipi di Porta, 3 significa Wiring String strNoFiber la stringa che viene restituita quando non ci sono connessioni attaccate alla poryta

Restituisce Errori

La funzione restituisce il valore di una propriet della prima fibra collegata Se l'artifact passato non una porta restituisce not_a_port Se la porta non connessa a niente restituisce strNoFiber (parametro) Se la wishedProperty non esiste restituisce PROP_NOT_EXIST

Esempio d'uso

Nelle Global Properties inserire in una propriet come derived Property. Nel dialogo Derived property inserire la stringa {MyProperties.getFirstConnectedFiberAllType} con il nome del parametro desiderato, il tipo di schema e la stringa di uscita (Es: name, 0, NC)

3.8 String getWhoisConnected

Utilizzo Scopo come property nelle Fibre. Le fibre devono essere Orientate Leggere una propriet del componente collegato all'arrivo di una fibra. La propriet puo' essere restituita come sottostringa, specificando inizio e fine posizione di lettura nella stringa

Parametri

String wishedProperty
il nome della propriet da cui leggere il dato (tale dato deve essere una stringa, il nome della propriet una stringa)

String direction
E' una stringa di valore null, forward o reverse. null interpretato come forward

Class MyProperties ver.1.8 - pag. 9 di 12

String fromposition deve essere inserito un numero a partire da 0. E' il numero di caratteri da cui si parte per ottenere una sottostringa String toposition deve essere inserito un numero. E' il numero di caratteri a cui si arriva per ottenere la sottostringa. Se 0 si intende che si prendono tutti i caratteri della stringa a partire da fromposition Restituisce La funzione restituisce il valore di una propriet del container che collegato al punto di partenza della fibra. Il valore restituito una sottostringa, regolata dai parametri from e toposition. Se la fibra non collegata a niente, restituisce NONE Se la wishedProperty non esiste restituisce PROP_NOT_EXIST Se i parametri passati in from..toposition non sono numerivi restituisce INVALIDTYPES Esempio d'uso getWhoisConnected(name, forward,0,0) restituir il nome intero (non sottostringa) del componente collegato in direzione forward. In Global Properties creare una propriet e inserire nella casella delle Derived Properties la definizione {MyProperties.getWhoisConnected} senza parentesi. I 4 parametri vanno aggiunti nella lista sottostante

Errori

3.9 String firstConnected

Utilizzo Scopo Parametri Restituisce Errori Esempio d'uso nelle Labels di Shape da utilizzare nelle label (non nelle global properties) di una Porta per stampare il nome della prima fibra wiring connessa alla porta stessa. nessuno restituisce una stringa Se non c' nessuna fibra connessa restituisce "NULL" da completare

3.10 String getContainerProperty

Class MyProperties ver.1.8 - pag. 10 di 12

Utilizzo Scopo

come property per Components Leggere il valore di una propriet del proprio container. A differenza dell'accessor container!propriet, vengono gestiti anche i casi in cui wishedProperty non esiste sul container oppure il caso in cui container non esiste.

Parametri

String wishedProperty
il nome della propriet da cui leggere il dato (tale dato deve essere una stringa, il nome della propriet una stringa)

Restituisce Errori

La funzione restituisce come stringa il valore di una propriet del container. vengono gestiti anche i casi in cui wishedProperty non esiste sul container oppure il caso in cui container non esiste. In questi casi la funzione restituisce rispettivamente NOPROPERTY e NOCONTAINER. Se la wishedProperty non di tipo stringa restituisce INVALIDTYPE da completare

Esempio d'uso

3.11 String getRealMultiplied

Utilizzo Scopo come property per Components,Fibers,Port Legge due parametri che vengono specificati e li moltiplica fornendo il risultato come String Pu essere utilizzata SOLO da parametri di tipo Real. Parametri

string firstPropName, string secondPropName

sono il nome delle propriet da cui leggere i dati (tali dati devono essere dei Real, il nome della propriet una stringa)

Restituisce Errori Esempio d'uso

La funzione restituisce una Stringa che contiene il valore della moltiplicazione dei due valori contenuti nelle propriet indicate. Se il tipo di firstPropName o secondPropName non Real, stampa un messaggio di errore sulla console getRealMultiplied(density, quantity) restituir il valore della moltiplicazione fra il contenuto della variabile density e il contenuto della variabile quantity. In Global Properties creare una propriet e inserire nella casella delle Derived Properties la definizione {MyProperties.getRealMultiplied}

Class MyProperties ver.1.8 - pag. 11 di 12

senza parentesi. I 2 parametri vanno aggiunti nella lista sottostante

Class MyProperties ver.1.8 - pag. 12 di 12