diguySignal Class Declaration

diguySignal.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguySignal.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: diguy_constants.h | declspec_diguy.h

Link against: libdiguy

class diguySignal

class BDI_DECLSPEC_diguy diguySignal
{
public:
    const char* get_name();
    const char* get_type_name();
    int reset();
    int trigger();
    enum {
        CALLBACK_ID_PRE_TRIGGER = 1,
        CALLBACK_ID_POST_TRIGGER
    };
#ifdef CPLUSPLUS_ONLY
    int add_callback(int callback_id,
        diguySignalCallback* callback,
        void* callback_params = 0,
        void* callback_user_data = 0);
    int remove_callback(int callback_id,
        diguySignalCallback* callback);
    int remove_callback_with_user_data(int callback_id,
        void* callback_user_data);
    int play_sound();
    int triggered();
    int triggered_at_least_n_times(int n);
    int signal_palette_show();
    int signal_palette_hide();
    int get_is_visible_in_signal_palette();
    int add_callback_script(int callback_id,
        const char* callback_script,
        const char* callback_script_type = NULL);
    int remove_callback_script(int callback_id,
        const char* callback_script,
        const char* callback_script_type = NULL);
    bdiScenarioSignal* get_scripted_object() {return m_signal;}
};

function diguySignal::get_name

Prototype:

const char* get_name();
Description:

Returns the name of the object. This pointer will never be NULL.

Callable From:

Returns:

name of the signal

function diguySignal::get_type_name

Prototype:

const char* get_type_name();
Description:

Returns the type name of the object. This pointer will never be NULL.

Returns:

type name of the object

Callable From:

function diguySignal::reset

Prototype:

int reset();
Description:

This function resets the signal. The number of times the signal has been triggered will be set to 0.

Callable From:

Returns:

0 on success, -1 on failure

function diguySignal::trigger

Prototype:

int trigger();
Description:

This function triggers the signal. If a sound is associated with the signal, it will be played. The number of times the signal has been triggered will be incremented by one.

Callable From:

Returns:

0 on success, -1 on failure

enumeration

	enum {
		CALLBACK_ID_PRE_TRIGGER = 1,
		CALLBACK_ID_POST_TRIGGER
	};
Description:

This is an enumeration of the different callbacks that can be registered with add_callback() and add_callback_script().

Usable From:

function diguySignal::add_callback

Prototype:

int add_callback(int callback_id,
		diguySignalCallback* callback,
		void* callback_params = 0,
		void* callback_user_data = 0);
Description:

This function adds a user callback.

Arguments:

callback pointer to function with prototype diguySignalCallback (typedefed above)
callback_id integer id of when this callback is to be called
callback_paramsstruct containing additional parameters needed by some callbacks
callback_user_datapointer for user's own use; DI-Guy will do nothing to the contents of this pointer beyond passing it back when the callback is invoked
callback_id should be one of the following values:

CALLBACK_ID_PRE_TRIGGER

This callback will be called whenever the trigger() function is called, whether internally by DI-Guy of explicitly by the user in C++ or in a script. It will be called before the default handler of the function.

There are no parameters for this callback

CALLBACK_ID_POST_TRIGGER

This callback will be called whenever the trigger() function is called, whether internally by DI-Guy of explicitly by the user in C++ or in a script. It will be called after the default handler of the function.

There are no parameters for this callback

Callback Return Values:

Callbacks return a value of type diguyCallbackReturn, which will be DIGUY_CALLBACK_STOP or DIGUY_CALLBACK_CONTINUE. If the callback returns DIGUY_CALLBACK_STOP, the default handler of the function will not be called; the callback is asserting that it has done everything necessary for the function call. If the callback returns DIGUY_CALLBACK_CONTINUE, the default handler for the function will be called after the callback.

Returns:

0 on success, -1 on failure

Callable From:

Returns:

0 on success, -1 on failure

function diguySignal::remove_callback

Prototype:

int remove_callback(int callback_id,
		diguySignalCallback* callback);

function diguySignal::remove_callback_with_user_data

Prototype:

int remove_callback_with_user_data(int callback_id,
		void* callback_user_data);

function diguySignal::play_sound

Prototype:

int play_sound();
Description:

DEPRECATED

Displays a warning that this function should not be used.

This function will be removed in a future release.

Callable From:

Returns:

0

function diguySignal::triggered

Prototype:

int triggered();
Returns:

Returns the number of times this signal has been triggered since the scenario started or since the last call to reset().

Callable From:

function diguySignal::triggered_at_least_n_times

Prototype:

int triggered_at_least_n_times(int n);
Returns:

Returns 1 if the signal has been triggered at least n times, else returns 0.

Callable From:

function diguySignal::signal_palette_show

Prototype:

int signal_palette_show();

function diguySignal::signal_palette_hide

Prototype:

int signal_palette_hide();

function diguySignal::get_is_visible_in_signal_palette

Prototype:

int get_is_visible_in_signal_palette();

Experimental Functions

The following functions are experimental and may change or disappear with no warning.

function diguySignal::add_callback_script

Prototype:

int add_callback_script(int callback_id,
		const char* callback_script,
		const char* callback_script_type = NULL);

function diguySignal::remove_callback_script

Prototype:

int remove_callback_script(int callback_id,
		const char* callback_script,
		const char* callback_script_type = NULL);

function diguySignal::get_scripted_object

Prototype:

bdiScenarioSignal* get_scripted_object();

Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/515 Massachusetts Avenue/Cambridge MA 02139.