DB.Api.AssemblyLibrary Class Reference

Class to handle model assembly libraries. An assembly library is used to house a number of pre-defined assemblies. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. Each DB model has an associated assembly library. Assemblies may be exported and imported using library functions. More...

Public Member Functions
int	ImportAssemblies (string path, IEnumerable< string > assemblyList)
	Imports assemblies from an existing library using a list of indices pointing to the assemblies to be imported. An empty string can be entered as the assemblyList argument in which case all assemblies will be imported.
int	ExportAssemblies (string path, IEnumerable< string > assemblyList)
	Exports assemblies using a list of indices pointing to the assemblies to be exported. An empty string can be entered as the assemblyList argument in which case all assemblies will be exported.
int	ReadFromProjectLibrary (bool overwrite=false)
	Reads all assemblies found in the current model assembly library to the AssemblyLibrary object.
int	SaveToProjectLibarary (bool overwrite=false)
	Writes all assemblies found in the AssemblyLibrary object to the current model assembly library.
int	ReadLibraryFromPath (string path)
	Reads assemblies from a file.
int	SaveLibraryToPath (string path)
	Writes all assemblies to a file.
bool	RemoveAssembly (int index)
	Removes assembly at specific index from library.
void	Dispose ()

Properties
Collections.Assemblies	Assemblies [get]
	Instantiates a collection of Assembly objects from Sketch SketchDAssemblyLibrary object.

Detailed Description

Class to handle model assembly libraries. An assembly library is used to house a number of pre-defined assemblies. An assembly is a collection of component blocks that form a re-usable model component. An assembly can be used to model building occupants, furnishings, staircases, etc. Once an assembly has been defined it can then be placed in the form of 'instances' within the model. Each DB model has an associated assembly library. Assemblies may be exported and imported using library functions.

Member Function Documentation

ExportAssemblies()

int DB.Api.AssemblyLibrary.ExportAssemblies	(	string	path,
		IEnumerable< string >	assemblyList
	)

Exports assemblies using a list of indices pointing to the assemblies to be exported. An empty string can be entered as the assemblyList argument in which case all assemblies will be exported.

Parameters

path	Full path name of assembly library to which the assemblies are to be exported (existing file will be overwritten)
assemblyList	Comma delimited list of indices pointing to the assemblies to be exported

Returns

Number of assemblies successfully exported

ImportAssemblies()

int DB.Api.AssemblyLibrary.ImportAssemblies	(	string	path,
		IEnumerable< string >	assemblyList
	)

Imports assemblies from an existing library using a list of indices pointing to the assemblies to be imported. An empty string can be entered as the assemblyList argument in which case all assemblies will be imported.

Parameters

path	Full path name of existing assembly library from which assemblies are to be imported
assemblyList	Comma delimited list of indices pointing to the assemblies to be imported

Returns

Number of assemblies successfully imported

ReadFromProjectLibrary()

int DB.Api.AssemblyLibrary.ReadFromProjectLibrary

(

bool

overwrite = false

)

Reads all assemblies found in the current model assembly library to the AssemblyLibrary object.

Parameters

overwrite

If TRUE removes all existing assemblies from the AssemblyLibrary object prior to reading

Returns

Number of assemblies successfully read from the current model assembly library

ReadLibraryFromPath()

int DB.Api.AssemblyLibrary.ReadLibraryFromPath

(

string

path

)

Reads assemblies from a file.

Parameters

path	Full path name of file from which assemblies are to be read

Returns

Number of assemblies successfully read from file

RemoveAssembly()

bool DB.Api.AssemblyLibrary.RemoveAssembly

(

int

index

)

Removes assembly at specific index from library.

Parameters

index

Index of assembly to be removed

Returns

TRUE if assembly successfully removed otherwise FALSE

SaveLibraryToPath()

int DB.Api.AssemblyLibrary.SaveLibraryToPath

(

string

path

)

Writes all assemblies to a file.

Parameters

path	Full path name of file to which assemblies are to be written

Returns

Number of assemblies successfully written to file

SaveToProjectLibarary()

int DB.Api.AssemblyLibrary.SaveToProjectLibarary

(

bool

overwrite = false

)

Writes all assemblies found in the AssemblyLibrary object to the current model assembly library.

Parameters

overwrite

If TRUE removes all existing assemblies from the current model assembly library prior to writing

Returns

Number of assemblies successfully written to the current model assembly library

---

The documentation for this class was generated from the following file:

• C:/DesignBuilder/Components Source/DB.Api/DB.Api/AssemblyLibrary.cs