Macro Build Utility/it

Descrizione
Questa macro è destinata ad essere utilizzata su grandi progetti, quelli che coinvolgono centinaia di oggetti. È inutile e superfluo utilizzarla su un piccolo progetto con un unico file. Su un grande progetto con molti oggetti e molti file da unire in quello finale, fa risparmiare tempo, evita le azioni ripetitive ed elimina gli errori umani.

Installazione
Tutto il codice di buildUtility.FCMacro è contenuto in una macro, quindi per installarla basta copiare il suo codice nella appropriata directory delle Macro. Dopo, si può invocare Build Utility dal menu Macro, dalla console Python o da un pulsante della barra degli strumenti (il metodo preferito).
 * per informazioni su come installare il codice delle macro vedere la pagina Come installare le macro
 * per informazioni su come installarla abbinata a un pulsante in una barra degli strumenti vedere la pagina Personalizzare la barra degli strumenti

Uso
Build Utility lavora sugli stessi principi dei file di costruzione che vengono utilizzati per assemblare i grandi sistemi software (come FreeCAD). Si utilizza un editor di testo per creare un file di testo che aderisce ai formati richiesti da Build Utility, poi Build Utility legge semplicemente ogni riga del file di testo ed esegue le azioni specificate.

La macro chiede all'utente un "build file", poi lo analizza, ci sono 3 tipi di righe lecite: Nota: il carattere "@" è per una futura espansione, quando verranno trattati i sub-file
 * le righe che iniziano con il carattere di commento "#" che sono ignorate in quanto sono commenti o osservazioni
 * le righe che iniziano con il carattere sub-file "@" che sono ignorate
 * tutte le altre righe che possono essere di un file di progetto o di una sotto-directory

L'estensione per il file Utility Build è ".FCBld". Questo serve ad evitare che il file sia usato impropriamente da altre applicazioni.

Si presume che il file specificato nel file build abbia l'estensione ".FCStd". Se la riga inizia con una directory il file di progetto viene letto da quella sottocartella, in caso contrario, si presume la linea specifichi un file di progetto. Le directory all'interno di directory sono supportate come nidificazione di profondità arbitraria. Il formato di specificazione del file è lo stile "Unix" con diversi livelli separati dal carattere barra "/".

Qualsiasi file mancante viene stampato nella Vista Report. Ogni directory mancante è stampata nella Vista Report.

Viene creato un nuovo documento e ogni progetto è un "Project Merged" posto in tale nuovo documento vuoto. Alla fine il documento non viene salvato, deve farlo l'utente, se lo desidera. Quando il file non esiste, il suo nome viene stampato nella vista report

Interfaccia utente
Per questa macro non c'è nessun tipo di GUI. La macro legge un file di testo che è stato preparato con un editor di testo e produce un modello in un documento di output. Basta fare clic sul pulsante nella barra degli strumenti per avviare il processo, non vi è alcuna interazione da parte dell'utente.

Example
You are working with some other departments in your company to use FreeCAD to generate a large CAD model for an external client. To prepare for the upcoming presentation you need to integrate the models represented in the 'black' and 'blue' subsystems, the engineering department has responsibility for the 'green' and 'grey' subsystems and you have the 'metal' subsystem on your own computer. The client also uses FreeCAD and your design must integrate with their subsystems "red', and 'yellow'. The external client has told you that the Stacker Assembly is not ready for you to use so you comment it out in your build file.

There are a lot of directory paths to type in so you enter the commands into the Build Utility text file which means you can run it with a single click on a toolbar button.



Il contenuto del seguente file di build "buildFile.FCBld" mostra la struttura del file per il progetto descritto sopra.

Una sintesi del file e del modo in cui viene elaborato è:
 * le prime due righe vengono trattate come commenti e tutto quello che segue il segno hash come carattere iniziale viene ignorato


 * anche la terza riga è ignorata perché il primo carattere è la "e commerciale" che è riservata per un uso futuro in cui i file di comando potranno richiamare altri file di comando


 * la quinta linea è la prima specificazione di un file, il file si trova nella stessa directory del file di build, non in una sottodirectory


 * la settima e l'ottava riga sono due specificazioni di file in cui il file è in una sotto-directory, notare che la sub-directory è del tipo "./black/" dove "black" è il nome della directory, quindi un file chiamato "sheetFold.FCstd" nella directory "outsourcing" appare "./outsourcing/sheetFold"


 * la diciannovesima riga mostra una specificazione di un file che esiste ma che non viene incluso in questa operazione di costruzione


 * le ultime due righe mostrano la specificazione di file che si trova oltre un livello di sub-directory

Opzioni
Non vi è alcuna interfaccia grafica quindi non ci sono opzioni. Esiste solo l'alternativa di utilizzare uno dei 3 tipi di righe nel file di testo come descritto sopra.

Osservazioni
Per ribadire quanto affermato all'inizio, su un singolo file di un piccolo modello questa macro non è di alcuna utilità. Ma è molto utile per chi modella aerei, locomotive, navi, edifici, impianti o circuiti complessi. Si è scelto l'estensione ".FCBld" sperando che all'interno di FreeCAD possa essere impostato questo standard per i file di compilazione. Si spera che il carattere "@" riservato per il prefisso nella definizione dei file di comando possa essere accettato in futuro e (se necessario) nello sviluppo.

Link
nessuno (fino ad ora)