diguyVariable Class Declaration

diguyVariable.h

DI-Guy API Version 5.1.26

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

Alphabetical Index

Includes: declspec_diguy.h

Link against: libdiguy

class diguyVariable

class BDI_DECLSPEC_diguy diguyVariable
{
public:
    int copy(diguyVariable* rhs);
    const char* get_name();
    int get_value_as_int();
    float get_value_as_float();
    const char* get_value_as_string();
    int set_value_as_int(int value);
    int set_value_as_float(float value);
    int set_value_as_string(const char* value);
    int increment_value_as_int(int value = 1);
    int decrement_value_as_int(int value = 1);
    int equal_to_int(int value);
    int greater_than_int(int value);
    int less_than_int(int value);
    int equal_to_float(float value);
    int greater_than_float(float value);
    int less_than_float(float value);
    int equal_to_string(const char* value);
    int greater_than_string(const char* value);
    int less_than_string(const char* value);
#ifdef CPLUSPLUS_ONLY
    bdiScenarioVariable* get_scripted_object() {return m_scripted_object;}
};

function diguyVariable::copy

Prototype:

int copy(diguyVariable* rhs);
Description:

Copies the contents of the passed variable.

Callable From:

Returns:

0 on success, -1 on failure

function diguyVariable::get_name

Prototype:

const char* get_name();
Description:

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

Callable From:

Returns:

name of the variable

function diguyVariable::get_value_as_int

Prototype:

int get_value_as_int();
Description:

Returns the value of the variable as an integer.

Callable From:

Returns:

value of the variable

function diguyVariable::get_value_as_float

Prototype:

float get_value_as_float();
Description:

Returns the value of the variable as a floating point number.

Callable From:

Returns:

value of the variable

function diguyVariable::get_value_as_string

Prototype:

const char* get_value_as_string();
Description:

Returns the value of the variable as a string. This pointer will never be NULL.

Callable From:

Returns:

value of the variable

function diguyVariable::set_value_as_int

Prototype:

int set_value_as_int(int value);
Description:

This function sets the value as an integer.

Callable From:

Arguments:

valuenew value of variable
Returns:

0 on success, -1 on failure

function diguyVariable::set_value_as_float

Prototype:

int set_value_as_float(float value);
Description:

This function sets the value as a floating point number.

Callable From:

Arguments:

valuenew value of variable
Returns:

0 on success, -1 on failure

function diguyVariable::set_value_as_string

Prototype:

int set_value_as_string(const char* value);
Description:

This function sets the value as a string.

Callable From:

Arguments:

valuenew value of variable
Returns:

0 on success, -1 on failure

function diguyVariable::increment_value_as_int

Prototype:

int increment_value_as_int(int value = 1);
Description:

This function increments the value as an int.

Callable From:

Arguments:

valuethe value by which to increment
Returns:

0 on success, -1 on failure

function diguyVariable::decrement_value_as_int

Prototype:

int decrement_value_as_int(int value = 1);
Description:

This function decrements the value as an int.

Callable From:

Arguments:

valuethe value by which to decrement
Returns:

0 on success, -1 on failure

function diguyVariable::equal_to_int

Prototype:

int equal_to_int(int value);
Returns:

1 if the variable as an int is equal to the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::greater_than_int

Prototype:

int greater_than_int(int value);
Returns:

1 if the variable as an int is greater than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::less_than_int

Prototype:

int less_than_int(int value);
Returns:

1 if the variable as an int is less than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::equal_to_float

Prototype:

int equal_to_float(float value);
Returns:

1 if the variable as a float is equal to the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::greater_than_float

Prototype:

int greater_than_float(float value);
Returns:

1 if the variable as a float is greater than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::less_than_float

Prototype:

int less_than_float(float value);
Returns:

1 if the variable as a float is less than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::equal_to_string

Prototype:

int equal_to_string(const char* value);
Returns:

1 if the variable as a string is equal to the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::greater_than_string

Prototype:

int greater_than_string(const char* value);
Returns:

1 if the variable as a string is alphabetically greater than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::less_than_string

Prototype:

int less_than_string(const char* value);
Returns:

1 if the variable as a string is alphabetically less than the passed value; 0 if not

Callable From:

Arguments:

valuethe value to compare against
Returns:

0 on success, -1 on failure

function diguyVariable::get_scripted_object

Prototype:

bdiScenarioVariable* 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.