Header file for reading and writing atomic model files. More...

#include "View2.h"
#include "Bstring.h"
#include "Color.h"
#include <map>

Classes
class	Bcomptype

class	Blinktype

class	Bangletype

class	Bcomponent

class	Blink

class	Bpolygon

class	Bgroup

class	Bmodel

Macros
#define	MAXLINK 10

#define	_Bmodel_

Functions
Bmodel *	read_model (Bstring &filename)

Bmodel *	read_model (Bstring *file_list)

Bmodel *	read_model (Bstring &filename, Bstring &paramfile)

Bmodel *	read_model (Bstring *file_list, Bstring &paramfile)
	Reads model parameters. More...

int	write_model (Bstring &filename, Bmodel *model)
	Writes model parameters. More...

int	write_model (Bstring &filename, Bmodel *model, int split)
	Writes model parameters. More...

Bmodel *	model_add (Bmodel **model, string id)
	Adds a model to a linked list. More...

Bcomponent *	component_add (Bcomponent **comp, string &id)
	Adds a component to a linked list. More...

Bcomponent *	component_add (Bcomponent **comp, unsigned long number)

Blink *	link_add (Blink *link, Bcomponent comp1, Bcomponent *comp2, double length, double radius)
	Adds a component link to a linked list. More...

Blink *	link_add (Blink *link, Bcomponent comp1, Bcomponent *comp2)

int	model_set_map_filenames (Bmodel *model, Bstring &mapfile)
	Sets all the map file names of selected models. More...

int	model_set_type (Bmodel *model, Bstring &set_type)
	Reset the component types. More...

int	model_change_type (Bmodel *model, Bstring &change_type)
	Change a component type name. More...

int	model_check (Bmodel *model, Bstring path)
	Checks model properties. More...

Bmodel *	model_list_copy (Bmodel *model)
	Copies a model. More...

int	component_list_kill (Bcomponent *comp)
	Deallocates memory for a list of components. More...

int	comp_type_list_kill (Bcomptype *type)
	Deallocates memory for a list of component types. More...

int	model_link_list_kill (Bmodel *model)
	Deallocates memory for a list of component links. More...

int	link_kill (Blink *link_list, Bcomponent comp, int i)
	Deletes a link. More...

int	link_kill (Blink *link_list, Bcomponent comp, Bcomponent *comp2)
	Deletes a link. More...

int	poly_list_kill (Bpolygon *poly)
	Deallocates memory for a list of polygons. More...

int	comp_associated_links_kill (Bcomponent comp, Blink *link)
	Deallocates memory for links associated with a component. More...

int	model_kill (Bmodel *model)
	Deallocates all memory in the list. More...

int	model_associate (Bmodel *model, Bstring &associate_type, Bstring &associate_file)
	Associates a model file with a component type. More...

int	model_associate_mass (Bmodel *model, Bstring &associate_type, double mass)
	Associates a mass with a component type. More...

int	model_set_comptype_filenames (Bmodel *model, Bstring &filename)
	Sets the filenames of all selected component types to the given string. More...

long	model_set_component_radius (Bmodel *model, double comprad)
	Set the display radius for all components to a specific value. More...

Detailed Description

Header file for reading and writing atomic model files.

Author: Bernard Heymann

Date: Created: 20060919; Modified: 20220929

Macro Definition Documentation

◆ _Bmodel_

#define _Bmodel_

◆ MAXLINK

#define MAXLINK 10

Function Documentation

◆ comp_associated_links_kill()

int comp_associated_links_kill	(	Bcomponent *	comp,
		Blink **	link
	)

Deallocates memory for links associated with a component.

Parameters

*comp	associated componet.
**link	pointer to component link list.

Returns: int number of component links deallocated.

◆ comp_type_list_kill()

int comp_type_list_kill ( Bcomptype * type )

Deallocates memory for a list of component types.

Parameters

*type component type list.

Returns: int total number of component types.

◆ component_add() [1/2]

Bcomponent * component_add	(	Bcomponent **	comp,
		string &	id
	)

Adds a component to a linked list.

Parameters

**comp	component list.
&id	component identifier.

Returns: Bcomponent new component.

The function allocates memory for a new component structure.
If the content of the pointer is null, the new structure is
the first in the list. Otherwise, the end of the list is found
and the new structure added to it.

◆ component_add() [2/2]

Bcomponent * component_add	(	Bcomponent **	comp,
		unsigned long	number
	)

◆ component_list_kill()

int component_list_kill ( Bcomponent * comp )

Deallocates memory for a list of components.

Parameters

*comp component list.

Returns: int total number of components.

◆ link_add() [1/2]

Blink * link_add	(	Blink **	link,
		Bcomponent *	comp1,
		Bcomponent *	comp2
	)

◆ link_add() [2/2]

Blink * link_add	(	Blink **	link,
		Bcomponent *	comp1,
		Bcomponent *	comp2,
		double	length,
		double	radius
	)

Adds a component link to a linked list.

Parameters

**link	component link list.
*comp1	first component.
*comp2	second component.
length	length of link.
radius	display radius.

Returns

Bcomponent new component.

The function allocates memory for a new link structure.
If the content of the pointer is null, the new structure is
the first in the list. Otherwise, the end of the list is found
and the new structure added to it.

◆ link_kill() [1/2]

int link_kill	(	Blink **	link_list,
		Bcomponent *	comp,
		Bcomponent *	comp2
	)

Deletes a link.

The link in the model link list is removed.
The associated references to the link in the component link arrays
are removed and the link arrays reorganized.

Parameters

**link_list	pointer to list of links.
*comp	one component in the link.
*comp2	second component in the link.

Returns: Bdistmat* new distance matrix structure.

◆ link_kill() [2/2]

int link_kill	(	Blink **	link_list,
		Bcomponent *	comp,
		int	i
	)

Deletes a link.

The link in the model link list is removed.
The associated references to the link in the component link arrays
are removed and the link arrays reorganized.

Parameters

**link_list	pointer to list of links.
*comp	one component in the link.
i	index for second component in link array of first component.

Returns: Bdistmat* new distance matrix structure.

◆ model_add()

Bmodel * model_add	(	Bmodel **	model,
		string	id
	)

Adds a model to a linked list.

Parameters

**model	model list.
id	model identifier.

Returns

Bmodel* new model.

The function allocates memory for a new model structure.
If the content of the pointer is null, the new structure is
the first in the list. Otherwise, the end of the list is found
and the new structure added to it.

◆ model_associate()

int model_associate	(	Bmodel *	model,
		Bstring &	associate_type,
		Bstring &	associate_file
	)

Associates a model file with a component type.

Parameters

*model	the model.
&associate_type	component type.
&associate_file	component file name.

Returns

int number of types associated.

Model files can be coordinates or maps.

◆ model_associate_mass()

int model_associate_mass	(	Bmodel *	model,
		Bstring &	associate_type,
		double	mass
	)

Associates a mass with a component type.

Parameters

*model	model list.
&associate_type	component type.
mass	component type mass.

Returns: int number of types associated.

◆ model_change_type()

int model_change_type	(	Bmodel *	model,
		Bstring &	change_type
	)

Change a component type name.

Parameters

*model	model.
&change_type	component type.

Returns

int number of models.

Sets all the component types to the given string.

◆ model_check()

int model_check	(	Bmodel *	model,
		Bstring	path
	)

Checks model properties.

Parameters

*model	model.
path	search path to find map files.

Returns: int 0.

◆ model_kill()

int model_kill ( Bmodel * model )

Deallocates all memory in the list.

Parameters

*model model parameters.

Returns: int 0.

◆ model_link_list_kill()

int model_link_list_kill ( Bmodel * model )

Deallocates memory for a list of component links.

Only the first model in the list is processed.

Parameters

*model model.

Returns: int total number of component links.

◆ model_list_copy()

Bmodel * model_list_copy ( Bmodel * model )

Copies a model.

Parameters

*model model parameters.

Returns

Bmodel* model copy.

Copies all the models in a list.

◆ model_set_component_radius()

long model_set_component_radius	(	Bmodel *	model,
		double	comprad
	)

Set the display radius for all components to a specific value.

Parameters

*model	model parameters.
comprad	component display radius.

Returns: long number of components selected.

◆ model_set_comptype_filenames()

int model_set_comptype_filenames	(	Bmodel *	model,
		Bstring &	filename
	)

Sets the filenames of all selected component types to the given string.

Parameters

*model	model parameters.
&filename	component file name.

Returns

int number of component types set.

The image numbers are sequentially set as well.

◆ model_set_map_filenames()

int model_set_map_filenames	(	Bmodel *	model,
		Bstring &	mapfile
	)

Sets all the map file names of selected models.

Parameters

*model	model parameters.
&mapfile	map file name.

Returns: int 0.

◆ model_set_type()

int model_set_type	(	Bmodel *	model,
		Bstring &	set_type
	)

Reset the component types.

Parameters

*model	model.
&set_type	component type.

Returns

int number of models.

Sets all the component types to the given string.

◆ poly_list_kill()

int poly_list_kill ( Bpolygon * poly )

Deallocates memory for a list of polygons.

Parameters

*poly polygon list.

Returns: int total number of polygons.

◆ read_model() [1/4]

Bmodel * read_model ( Bstring & filename )

◆ read_model() [2/4]

Bmodel * read_model	(	Bstring &	filename,
		Bstring &	paramfile
	)

◆ read_model() [3/4]

Bmodel * read_model ( Bstring * file_list )

◆ read_model() [4/4]

Bmodel * read_model	(	Bstring *	file_list,
		Bstring &	paramfile
	)

Reads model parameters.

Parameters

*file_list	list of model parameter file names.
&paramfile	parameter file.

Returns: Bmodel* model parameters.

◆ write_model() [1/2]

int write_model	(	Bstring &	filename,
		Bmodel *	model
	)

Writes model parameters.

Parameters

&filename	model parameter file name.
*model	model parameters.

Returns: int number of models.

◆ write_model() [2/2]

int write_model	(	Bstring &	filename,
		Bmodel *	model,
		int	split
	)

Writes model parameters.

Parameters

&filename	model parameter file name.
*model	model parameters.
split	number of digits for writing multiple models.

Returns: int number of models.

Classes

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ _Bmodel_

◆ MAXLINK

Function Documentation

◆ comp_associated_links_kill()

◆ comp_type_list_kill()

◆ component_add() [1/2]

◆ component_add() [2/2]

◆ component_list_kill()

◆ link_add() [1/2]

◆ link_add() [2/2]

◆ link_kill() [1/2]

◆ link_kill() [2/2]

◆ model_add()

◆ model_associate()

◆ model_associate_mass()

◆ model_change_type()

◆ model_check()

◆ model_kill()

◆ model_link_list_kill()

◆ model_list_copy()

◆ model_set_component_radius()

◆ model_set_comptype_filenames()

◆ model_set_map_filenames()

◆ model_set_type()

◆ poly_list_kill()

◆ read_model() [1/4]

◆ read_model() [2/4]

◆ read_model() [3/4]

◆ read_model() [4/4]

◆ write_model() [1/2]

◆ write_model() [2/2]