CAAM : Среда разработки и моделирования

См. исходные тексты.


Функции
void	TestCase (bool test, AnsiString errorMsg)
	Вызывает ошибку системы с текстом errorMsg в случае ложного условия.
void	assert (bool condition)
	Производит утверждение что данное условие должно выполняться в текущем месте.
void	CheckEqualsInteger (int expected, int actual)
	Производит проверку на равенство целых чисел.
void	CheckEqualsDouble (double expected, double actual)
	Производит проверку на равенство вещевственных чисел.
void	CheckEqualsBoolean (bool expected, bool actual)
	Производит проверку на равенство булевских значений.
void	CheckEqualsString (AnsiString expected, AnsiString actual)
	Производит проверку на равенство строковых значений.
void	TestStructure (AnsiString libraryName, AnsiString structName)
	Производит проверку плагина на работоспособность, утечки памяти, а так же на совместимость с текущей системой .
void	SortObjects (AnsiString Name1, AnsiString Name2)
	Производит выстраивание объектов согласно связям схемы.
synchronized void	ShowMessage (AnsiString Msg)
	Вызывает диалоговое окно с текстом Msg.
int	TypeObjectsCount (AnsiString TypeName)
	Возвращает число объектов заданного типа для текущей схемы.
int	ObjectsCount ()
	Возвращает общее число объектов для текущей схемы.
void	RunObject (int Index)
	Производит запуск (расчет) объекта.
void	Start ()
	Производит запуск всех готовых к выполнению объектов.
void	Wait ()
	Производит ожидание завершения выполнения всех объектов.
void	InitializationObjects ()
	Производит инициализацию всех объектов текущей схемы.
AnsiString	ObjectName (int Index)
	Возвращает имя объекта.
AnsiString	ObjectType (int Index)
	Возвращает тип объекта.
int	IndexOfObject (AnsiString Name)
	Возвращает номер объекта.
void	LoadOpticsFromBitmaps (TOptics Optics, AnsiString AmplitudePath, AnsiString PhasePath)
	Производит загрузку оптического изображения из BMP файлов.
AnsiString	ExecutionTime ()
	Возвращает время внутреннего таймера программы.
void	TimeReset ()
	Сбрасывает в начальное время внутреннего таймера программы.
void	Pause ()
	Выполняет приостановление выполнения программы.
void	Progress (double position)
	Задает позицию системного индикатора завершения задачи/программы.
void	Text (AnsiString progressComment)
	Задает текстовый комментарий для системного слижения за процессом исполнения.
synchronized void	View (Bind bind)
	Производит показ окна просмотра связи.
synchronized void	CloseAllView ()
	Производит закрытие всех окон просмотра.
void	AcceptBind (Bind bind, bool isReady)
	Производит установку соединения в определенное состояние.
bool	isReadyBind (Bind bind)
	Возвращает состояние готовности соединения.
bool	isDistributed ()
	Возвращает истину при режиме распределенных вычислений.
void	waitForObject (Object waitObject, Object forObject)
	Переводит объект waitObject в режим ожидания завершения выполнения forObject.

Подробное описание

Здесь содержатся базовые, функции, описания типов данных обслуживающие работу системы.

Функции

void AcceptBind	(	Bind	bind,
		bool	isReady
	)

Производит установку соединения в определенное состояние.

Состояние может быть как готовности так и блокировки обработки данных.

Аргументы:

	bind	Bind [in] - интерфейс соединения.
	isReady	bool [in] - состояние готовности, которое передается данному соединению.

Прим.:: Работает только в режиме распределенных вычислений.

См. также:: isReadyBind , Start , Wait , isDistributed .

void assert ( bool condition )

Производит утверждение что данное условие должно выполняться в текущем месте.

Если условие не выполняется, то будет возвращена ошибка с соответствующим сообщением.

Аргументы:

condition

- условие которое должно выполняться

См. также:: TestCase .

void CheckEqualsBoolean	(	bool	expected,
		bool	actual
	)

Производит проверку на равенство булевских значений.

При отличных значениях вызывает ошибку системы с указанием отличий текущего значения от ожидаемого.

Аргументы:

	expected	- ожидаемое (предпологаемое) значение.
	actual	- проверяемое (фактическое) значение.

void CheckEqualsDouble	(	double	expected,
		double	actual
	)

Производит проверку на равенство вещевственных чисел.

При отличных значениях вызывает ошибку системы с указанием отличий текущего значения от ожидаемого.

Аргументы:

	expected	- ожидаемое (предпологаемое) значение.
	actual	- проверяемое (фактическое) значение.

void CheckEqualsInteger	(	int	expected,
		int	actual
	)

Производит проверку на равенство целых чисел.

При отличных значениях вызывает ошибку системы с указанием отличий текущего значения от ожидаемого.

Аргументы:

	expected	- ожидаемое (предпологаемое) значение.
	actual	- проверяемое (фактическое) значение.

void CheckEqualsString	(	AnsiString	expected,
		AnsiString	actual
	)

Производит проверку на равенство строковых значений.

При отличных значениях вызывает ошибку системы с указанием отличий текущего значения от ожидаемого.

Аргументы:

	expected	- ожидаемое (предпологаемое) значение.
	actual	- проверяемое (фактическое) значение.

synchronized void CloseAllView ( )

Производит закрытие всех окон просмотра.

Предупреждения:: Функция является синхронизованной с пользовательским интерфейсом.

AnsiString ExecutionTime ( )

Возвращает время внутреннего таймера программы.

Возвращает:: AnsiString форматированное время внутреннего таймера программы

int IndexOfObject ( AnsiString Name )

Возвращает номер объекта.

известным под названием Name

Возвращает:: int - номер объекта

Аргументы:

Name

AnsiString - имя интересуемого объекта

void InitializationObjects ( )

Производит инициализацию всех объектов текущей схемы.

При этом производится инициализация всех их компонент.

Уст.:: Фактически не нужен в данной версии

bool isDistributed ( )

Возвращает истину при режиме распределенных вычислений.

Состояние может быть как готовности (true) так и блокировки (false) обработки данных.

Аргументы:

bind

Bind [in] - интерфейс соединения.

Прим.:: Корректно работает только в режиме распределенных вычислений.

См. также:: AcceptBind , Start , Wait , isReadyBind .

bool isReadyBind ( Bind bind )

Возвращает состояние готовности соединения.

Состояние может быть как готовности (true) так и блокировки (false) обработки данных.

Аргументы:

bind

Bind [in] - интерфейс соединения.

Прим.:: Корректно работает только в режиме распределенных вычислений.

См. также:: AcceptBind , Start , Wait , isDistributed .

void LoadOpticsFromBitmaps	(	TOptics	Optics,
		AnsiString	AmplitudePath,
		AnsiString	PhasePath
	)

Производит загрузку оптического изображения из BMP файлов.

Для этого нужно два изображения (амплитуды и фазы) светового поля.

Аргументы:

	Optics	TOptics [out] - загружаемое оптическое изображение
	AmplitudePath	AnsiString [in] - путь к BMP фаилу амплитуды
	PhasePath	AnsiString [in] - путь к BMP фаилу амплитуды

Предупреждения:: BMP изображения должны быть 8бит формата в градациях серого в противном случае при их загрузке произойдет непоправимая ошибка.

Уст.:: функция является неисправной, пользуйтесь Optics.h -> LoadFromBMPOptics

AnsiString ObjectName ( int Index )

Возвращает имя объекта.

находящегося под номером Index

Возвращает:: AnsiString - имя объекта

Аргументы:

Index

int - индекс объекта

int ObjectsCount ( )

Возвращает общее число объектов для текущей схемы.

Возвращает:: Возвращает общее число объектов для текущей схемы

AnsiString ObjectType ( int Index )

Возвращает тип объекта.

находящегося под номером Index

Возвращает:: AnsiString - тип объекта

Аргументы:

Index

int - индекс объекта

void Pause ( )

Выполняет приостановление выполнения программы.

до тех пор пока пользователь собственоручно не продолжит или завершит работу

void Progress ( double position )

Задает позицию системного индикатора завершения задачи/программы.

Индикатор показывает уровень завершенности текущей задачи. Также он полезен для определения времени расчета этой задачи.

Аргументы:

position

double [in] - позиция индикатора.

Предупреждения:: position имеет ограничение по значению, оно должно лежать в пределах [0..100]

void RunObject ( int Index )

Производит запуск (расчет) объекта.

находящегося под номером Index

Аргументы:

Index

int - индекс запускаемого объекта

Прим.:: Если режим запуска был выбран как распределенный, то после запуска данного объекта функция не дожидаясь его окончания завершит свое выполнение, чтобы дождаться выполнения всех объектов используйте Wait;

См. также:: Start , Wait .

synchronized void ShowMessage ( AnsiString Msg )

Вызывает диалоговое окно с текстом Msg.

Аргументы:

Msg

- текст сообщения, выводимый в модальном окне.

Предупреждения:: функция является синхронизованной с пользовательским интерфейсом.

void SortObjects	(	AnsiString	Name1,
		AnsiString	Name2
	)

Производит выстраивание объектов согласно связям схемы.

При этом последовательность тянется по мере передачи параметров.

Аргументы:

	Name1	AnsiString - имя первого объекта (источника информационныз данных).
	Name2	AnsiString - имя последнего объекта (завершающий поток данных).

void Start ( )

Производит запуск всех готовых к выполнению объектов.

Используется для запуска распределенных вычислений. Фактически стартуют все объекты, которые имеют только выходы.

Прим.:: Работает только в режиме распределенных вычислений.

См. также:: RunObject , Wait , AcceptBind .

void TestCase	(	bool	test,
		AnsiString	errorMsg
	)

Вызывает ошибку системы с текстом errorMsg в случае ложного условия.

Вызывает ошибку с текстом errorMsg в том случае, если значение test равнялось False. В противном случае ничего не происходит.

Аргументы:

	test	- условие прохождения теста (отрицательный результат вызывает ошибку).
	errorMsg	- текст сообщения о непрохождении теста.

См. также:: assert .

void TestStructure	(	AnsiString	libraryName,
		AnsiString	structName
	)

Производит проверку плагина на работоспособность, утечки памяти, а так же на совместимость с текущей системой .

В частности проверка касается конкретной структуры.

Аргументы:

	libraryName	AnsiString[in] - имя библиотеки, в которой распологается тестируемая структура.
	structName	AnsiString[in] - имя тестируемой структуры.

Прим.:: параметр libraryName может включать в себя относительный путь начинающийся с директории в которой распологается система.

void Text ( AnsiString progressComment )

Задает текстовый комментарий для системного слижения за процессом исполнения.

Аргументы:

progressComment

AnsiString [in] - текстовый комментарий процесса выполнения

void TimeReset ( )

Сбрасывает в начальное время внутреннего таймера программы.

При этом таймер принимает нулевое значение и начинает отсчет занового.

int TypeObjectsCount ( AnsiString TypeName )

Возвращает число объектов заданного типа для текущей схемы.

Возвращает:: Возвращает число объектов типа TypeName для текущей схемы

Аргументы:

TypeName

AnsiString - название типа объектов

synchronized void View ( Bind bind )

Производит показ окна просмотра связи.

Аргументы:

bind

Bind [in]- интересумая связь.

Предупреждения:: Функция является синхронизованной с пользовательским интерфейсом.

void Wait ( )

Производит ожидание завершения выполнения всех объектов.

Прим.:: Работает только в режиме распределенных вычислений

См. также:: RunObject , Start , AcceptBind .

void waitForObject	(	Object	waitObject,
		Object	forObject
	)

Переводит объект waitObject в режим ожидания завершения выполнения forObject.

Аргументы:

	waitObject	Object - интерфейс ожидающего объекта.
	forObject	Object - интерфейс ожидаемого объекта

Прим.:: waitObject не выйдет из режима ожидания, если после запуска данной функции forObject не завершил свое выполнение.

См. также:: AcceptBind , Start , Wait , isReadyBind .

Файл Common.h

Функции

Подробное описание

Функции