/usr/include/sidlx_rmi_Common.h is in libsidl-dev 1.4.0.dfsg-8build3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 | /*
* File: sidlx_rmi_Common.h
* Symbol: sidlx.rmi.Common-v0.1
* Symbol Type: class
* Babel Version: 1.4.0 (Revision: 6607 release-1-4-0-branch)
* Description: Client-side glue code for sidlx.rmi.Common
*
* WARNING: Automatically generated; changes will be lost
*
*/
#ifndef included_sidlx_rmi_Common_h
#define included_sidlx_rmi_Common_h
/**
* Symbol "sidlx.rmi.Common" (version 0.1)
*
* Some basic useful functions
*/
struct sidlx_rmi_Common__object;
struct sidlx_rmi_Common__array;
typedef struct sidlx_rmi_Common__object* sidlx_rmi_Common;
/*
* Includes for all header dependencies.
*/
#ifndef included_sidl_header_h
#include "sidl_header.h"
#endif
#ifndef included_sidl_BaseException_h
#include "sidl_BaseException.h"
#endif
#ifndef included_sidl_BaseInterface_h
#include "sidl_BaseInterface.h"
#endif
#ifndef included_sidl_ClassInfo_h
#include "sidl_ClassInfo.h"
#endif
#ifndef included_sidl_RuntimeException_h
#include "sidl_RuntimeException.h"
#endif
#ifndef included_sidl_SIDLException_h
#include "sidl_SIDLException.h"
#endif
#ifndef included_sidl_rmi_Call_h
#include "sidl_rmi_Call.h"
#endif
#ifndef included_sidl_rmi_Return_h
#include "sidl_rmi_Return.h"
#endif
#ifdef SIDL_C_HAS_INLINE
#ifndef included_sidlx_rmi_Common_IOR_h
#include "sidlx_rmi_Common_IOR.h"
#endif
#endif /* SIDL_C_HAS_INLINE */
#ifdef __cplusplus
extern "C" {
#endif
#if !defined(SIDLX_RMI_COMMON_INLINE_DECL) && defined(SIDL_C_HAS_INLINE)
#if (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || defined(__INTEL_COMPILER) || !defined(__GNUC__)
#define SIDLX_RMI_COMMON_INLINE_DECL inline
#else
#define SIDLX_RMI_COMMON_INLINE_DECL extern inline
#endif
#endif /* inline preprocessor definitions */
/**
* Constructor function for the class.
*/
struct sidlx_rmi_Common__object*
sidlx_rmi_Common__create(sidl_BaseInterface* _ex);
/**
* Wraps up the private data struct pointer (struct sidlx_rmi_Common__data) passed in rather than running the constructor.
*/
sidlx_rmi_Common
sidlx_rmi_Common__wrapObj(void * data, sidl_BaseInterface *_ex);
#ifdef WITH_RMI
/**
* RMI constructor function for the class.
*/
sidlx_rmi_Common
sidlx_rmi_Common__createRemote(const char * url, sidl_BaseInterface *_ex);
/**
* RMI connector function for the class.(addrefs)
*/
sidlx_rmi_Common
sidlx_rmi_Common__connect(const char *, sidl_BaseInterface *_ex);
#endif /*WITH_RMI*/
/**
* Method to enable/disable static interface contract enforcement.
*/
void
sidlx_rmi_Common__set_contracts_static(
sidl_bool enable,
const char* enfFilename,
sidl_bool resetCounters,
struct sidl_BaseInterface__object **_ex);
/**
* Method to dump static interface contract enforcement statistics.
*/
void
sidlx_rmi_Common__dump_stats_static(
const char* filename,
const char* prefix,
struct sidl_BaseInterface__object **_ex);
/**
* Method to enable/disable interface contract enforcement.
*/
void
sidlx_rmi_Common__set_contracts(
sidlx_rmi_Common self,
sidl_bool enable,
const char* enfFilename,
sidl_bool resetCounters,
struct sidl_BaseInterface__object **_ex);
/**
* Method to dump interface contract enforcement statistics.
*/
void
sidlx_rmi_Common__dump_stats(
sidlx_rmi_Common self,
const char* filename,
const char* prefix,
struct sidl_BaseInterface__object **_ex);
/**
* Method: fork[]
*/
int32_t
sidlx_rmi_Common_fork(
/* out */ sidl_BaseInterface *_ex);
/**
* Method: getHostIP[]
*/
int32_t
sidlx_rmi_Common_getHostIP(
/* in */ const char* hostname,
/* out */ sidl_BaseInterface *_ex);
/**
* Method: getCanonicalName[]
*/
char*
sidlx_rmi_Common_getCanonicalName(
/* in */ const char* hostname,
/* out */ sidl_BaseInterface *_ex);
/**
* <p>
* Add one to the intrinsic reference count in the underlying object.
* Object in <code>sidl</code> have an intrinsic reference count.
* Objects continue to exist as long as the reference count is
* positive. Clients should call this method whenever they
* create another ongoing reference to an object or interface.
* </p>
* <p>
* This does not have a return value because there is no language
* independent type that can refer to an interface or a
* class.
* </p>
*/
SIDLX_RMI_COMMON_INLINE_DECL
void
sidlx_rmi_Common_addRef(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
(*self->d_epv->f_addRef)(
self,
_ex);
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Decrease by one the intrinsic reference count in the underlying
* object, and delete the object if the reference is non-positive.
* Objects in <code>sidl</code> have an intrinsic reference count.
* Clients should call this method whenever they remove a
* reference to an object or interface.
*/
SIDLX_RMI_COMMON_INLINE_DECL
void
sidlx_rmi_Common_deleteRef(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
(*self->d_epv->f_deleteRef)(
self,
_ex);
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Return true if and only if <code>obj</code> refers to the same
* object as this object.
*/
SIDLX_RMI_COMMON_INLINE_DECL
sidl_bool
sidlx_rmi_Common_isSame(
/* in */ sidlx_rmi_Common self,
/* in */ sidl_BaseInterface iobj,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
sidl_bool _result;
_result = (*self->d_epv->f_isSame)(
self,
iobj,
_ex);
return _result;
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Return whether this object is an instance of the specified type.
* The string name must be the <code>sidl</code> type name. This
* routine will return <code>true</code> if and only if a cast to
* the string type name would succeed.
*/
SIDLX_RMI_COMMON_INLINE_DECL
sidl_bool
sidlx_rmi_Common_isType(
/* in */ sidlx_rmi_Common self,
/* in */ const char* name,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
sidl_bool _result;
_result = (*self->d_epv->f_isType)(
self,
name,
_ex);
return _result;
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Return the meta-data about the class implementing this interface.
*/
SIDLX_RMI_COMMON_INLINE_DECL
sidl_ClassInfo
sidlx_rmi_Common_getClassInfo(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
sidl_ClassInfo _result;
_result = (*self->d_epv->f_getClassInfo)(
self,
_ex);
return _result;
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Cast method for interface and class type conversions.
*/
struct sidlx_rmi_Common__object*
sidlx_rmi_Common__cast(
void* obj,
sidl_BaseInterface* _ex);
/**
* String cast method for interface and class type conversions.
*/
void*
sidlx_rmi_Common__cast2(
void* obj,
const char* type,
sidl_BaseInterface *_ex);
/**
* Select and execute a method by name
*/
SIDLX_RMI_COMMON_INLINE_DECL
void
sidlx_rmi_Common__exec(
/* in */ sidlx_rmi_Common self,
/* in */ const char* methodName,
/* in */ sidl_rmi_Call inArgs,
/* in */ sidl_rmi_Return outArgs,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
(*self->d_epv->f__exec)(
self,
methodName,
inArgs,
outArgs,
_ex);
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Get the URL of the Implementation of this object (for RMI)
*/
SIDLX_RMI_COMMON_INLINE_DECL
char*
sidlx_rmi_Common__getURL(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
char* _result;
_result = (*self->d_epv->f__getURL)(
self,
_ex);
return _result;
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* On a remote object, addrefs the remote instance.
*/
SIDLX_RMI_COMMON_INLINE_DECL
void
sidlx_rmi_Common__raddRef(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
(*self->d_epv->f__raddRef)(
self,
_ex);
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* TRUE if this object is remote, false if local
*/
SIDLX_RMI_COMMON_INLINE_DECL
sidl_bool
sidlx_rmi_Common__isRemote(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
sidl_bool _result;
_result = (*self->d_epv->f__isRemote)(
self,
_ex);
return _result;
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* TRUE if this object is remote, false if local
*/
sidl_bool
sidlx_rmi_Common__isLocal(
/* in */ sidlx_rmi_Common self,
/* out */ sidl_BaseInterface *_ex);
/**
* Static Method to enable/disable method hooks invocation.
*/
void
sidlx_rmi_Common__set_hooks_static(
/* in */ sidl_bool enable,
/* out */ sidl_BaseInterface *_ex);
/**
* Method to enable/disable method hooks invocation.
*/
SIDLX_RMI_COMMON_INLINE_DECL
void
sidlx_rmi_Common__set_hooks(
/* in */ sidlx_rmi_Common self,
/* in */ sidl_bool enable,
/* out */ sidl_BaseInterface *_ex)
#ifdef SIDLX_RMI_COMMON_INLINE_DECL
{
(*self->d_epv->f__set_hooks)(
self,
enable,
_ex);
}
#else
;
#endif /* SIDLX_RMI_COMMON_INLINE_DECL */
/**
* Create a contiguous array of the given dimension with specified
* index bounds in column-major order. This array
* owns and manages its data.
* This function initializes the contents of the array to
* NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_createCol(
int32_t dimen,
const int32_t lower[],
const int32_t upper[]);
/**
* Create a contiguous array of the given dimension with specified
* index bounds in row-major order. This array
* owns and manages its data.
* This function initializes the contents of the array to
* NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_createRow(
int32_t dimen,
const int32_t lower[],
const int32_t upper[]);
/**
* Create a contiguous one-dimensional array with a lower index
* of 0 and an upper index of len-1. This array
* owns and manages its data.
* This function initializes the contents of the array to
* NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_create1d(int32_t len);
/**
* Create a dense one-dimensional vector with a lower
* index of 0 and an upper index of len-1. The initial data for this
* new array is copied from data. This will increment the reference
* count of each non-NULL object/interface reference in data.
*
* This array owns and manages its data.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_create1dInit(
int32_t len,
sidlx_rmi_Common* data);
/**
* Create a contiguous two-dimensional array in column-major
* order with a lower index of (0,0) and an upper index of
* (m-1,n-1). This array owns and manages its data.
* This function initializes the contents of the array to
* NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_create2dCol(int32_t m, int32_t n);
/**
* Create a contiguous two-dimensional array in row-major
* order with a lower index of (0,0) and an upper index of
* (m-1,n-1). This array owns and manages its data.
* This function initializes the contents of the array to
* NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_create2dRow(int32_t m, int32_t n);
/**
* Create an array that uses data (memory) from another
* source. The initial contents are determined by the
* data being borrowed.
* Any time an element in the borrowed array is replaced
* via a set call, deleteRef will be called on the
* value being replaced if it is not NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_borrow(
sidlx_rmi_Common* firstElement,
int32_t dimen,
const int32_t lower[],
const int32_t upper[],
const int32_t stride[]);
/**
* If array is borrowed, allocate a new self-sufficient
* array and copy the borrowed array into the new array;
* otherwise, increment the reference count and return
* the array passed in. Use this whenever you want to
* make a copy of a method argument because arrays
* passed into methods aren't guaranteed to exist after
* the method call.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_smartCopy(
struct sidlx_rmi_Common__array *array);
/**
* Increment the array's internal reference count by one.
*/
void
sidlx_rmi_Common__array_addRef(
struct sidlx_rmi_Common__array* array);
/**
* Decrement the array's internal reference count by one.
* If the reference count goes to zero, destroy the array.
* If the array isn't borrowed, this releases all the
* object references held by the array.
*/
void
sidlx_rmi_Common__array_deleteRef(
struct sidlx_rmi_Common__array* array);
/**
* Retrieve element i1 of a(n) 1-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get1(
const struct sidlx_rmi_Common__array* array,
const int32_t i1);
/**
* Retrieve element (i1,i2) of a(n) 2-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get2(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2);
/**
* Retrieve element (i1,i2,i3) of a(n) 3-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get3(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3);
/**
* Retrieve element (i1,i2,i3,i4) of a(n) 4-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get4(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4);
/**
* Retrieve element (i1,i2,i3,i4,i5) of a(n) 5-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get5(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5);
/**
* Retrieve element (i1,i2,i3,i4,i5,i6) of a(n) 6-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get6(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5,
const int32_t i6);
/**
* Retrieve element (i1,i2,i3,i4,i5,i6,i7) of a(n) 7-dimensional array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get7(
const struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5,
const int32_t i6,
const int32_t i7);
/**
* Retrieve element indices of an n-dimensional array.
* indices is assumed to have the right number of elements
* for the dimension of array.
*/
sidlx_rmi_Common
sidlx_rmi_Common__array_get(
const struct sidlx_rmi_Common__array* array,
const int32_t indices[]);
/**
* Set element i1 of a(n) 1-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set1(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2) of a(n) 2-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set2(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2,i3) of a(n) 3-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set3(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2,i3,i4) of a(n) 4-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set4(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2,i3,i4,i5) of a(n) 5-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set5(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2,i3,i4,i5,i6) of a(n) 6-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set6(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5,
const int32_t i6,
sidlx_rmi_Common const value);
/**
* Set element (i1,i2,i3,i4,i5,i6,i7) of a(n) 7-dimensional array to value.
*/
void
sidlx_rmi_Common__array_set7(
struct sidlx_rmi_Common__array* array,
const int32_t i1,
const int32_t i2,
const int32_t i3,
const int32_t i4,
const int32_t i5,
const int32_t i6,
const int32_t i7,
sidlx_rmi_Common const value);
/**
* Set element indices of an n-dimensional array to value.indices is assumed to have the right number of elements
* for the dimension of array.
*/
void
sidlx_rmi_Common__array_set(
struct sidlx_rmi_Common__array* array,
const int32_t indices[],
sidlx_rmi_Common const value);
/**
* Return the dimension of array. If the array pointer is
* NULL, zero is returned.
*/
int32_t
sidlx_rmi_Common__array_dimen(
const struct sidlx_rmi_Common__array* array);
/**
* Return the lower bound of dimension ind.
* If ind is not a valid dimension, 0 is returned.
* The valid range for ind is from 0 to dimen-1.
*/
int32_t
sidlx_rmi_Common__array_lower(
const struct sidlx_rmi_Common__array* array,
const int32_t ind);
/**
* Return the upper bound of dimension ind.
* If ind is not a valid dimension, -1 is returned.
* The valid range for ind is from 0 to dimen-1.
*/
int32_t
sidlx_rmi_Common__array_upper(
const struct sidlx_rmi_Common__array* array,
const int32_t ind);
/**
* Return the length of dimension ind.
* If ind is not a valid dimension, -1 is returned.
* The valid range for ind is from 0 to dimen-1.
*/
int32_t
sidlx_rmi_Common__array_length(
const struct sidlx_rmi_Common__array* array,
const int32_t ind);
/**
* Return the stride of dimension ind.
* If ind is not a valid dimension, 0 is returned.
* The valid range for ind is from 0 to dimen-1.
*/
int32_t
sidlx_rmi_Common__array_stride(
const struct sidlx_rmi_Common__array* array,
const int32_t ind);
/**
* Return a true value iff the array is a contiguous
* column-major ordered array. A NULL array argument
* causes 0 to be returned.
*/
int
sidlx_rmi_Common__array_isColumnOrder(
const struct sidlx_rmi_Common__array* array);
/**
* Return a true value iff the array is a contiguous
* row-major ordered array. A NULL array argument
* causes 0 to be returned.
*/
int
sidlx_rmi_Common__array_isRowOrder(
const struct sidlx_rmi_Common__array* array);
/**
* Create a sub-array of another array. This resulting
* array shares data with the original array. The new
* array can be of the same dimension or potentially
* less assuming the original array has dimension
* greater than 1. If you are removing dimension,
* indicate the dimensions to remove by setting
* numElem[i] to zero for any dimension i wthat should
* go away in the new array. The meaning of each
* argument is covered below.
*
* src the array to be created will be a subset
* of this array. If this argument is NULL,
* NULL will be returned. The array returned
* borrows data from src, so modifying src or
* the returned array will modify both
* arrays.
*
* dimen this argument must be greater than zero
* and less than or equal to the dimension of
* src. An illegal value will cause a NULL
* return value.
*
* numElem this specifies how many elements from src
* should be taken in each dimension. A zero
* entry indicates that the dimension should
* not appear in the new array. This
* argument should be an array with an entry
* for each dimension of src. Passing NULL
* here will cause NULL to be returned. If
* srcStart[i] + numElem[i]*srcStride[i] is
* greater than upper[i] for src or if
* srcStart[i] + numElem[i]*srcStride[i] is
* less than lower[i] for src, NULL will be
* returned.
*
* srcStart this array holds the coordinates of the
* first element of the new array. If this
* argument is NULL, the first element of src
* will be the first element of the new
* array. If non-NULL, this argument should
* be an array with an entry for each
* dimension of src. If srcStart[i] is less
* than lower[i] for the array src, NULL will
* be returned.
*
* srcStride this array lets you specify the stride
* between elements in each dimension of
* src. This stride is relative to the
* coordinate system of the src array. If
* this argument is NULL, the stride is taken
* to be one in each dimension. If non-NULL,
* this argument should be an array with an
* entry for each dimension of src.
*
* newLower this argument is like lower in a create
* method. It sets the coordinates for the
* first element in the new array. If this
* argument is NULL, the values indicated by
* srcStart will be used. If non-NULL, this
* should be an array with dimen elements.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_slice(
struct sidlx_rmi_Common__array* src,
int32_t dimen,
const int32_t numElem[],
const int32_t *srcStart,
const int32_t *srcStride,
const int32_t *newStart);
/**
* Copy the contents of one array (src) to a second array
* (dest). For the copy to take place, both arrays must
* exist and be of the same dimension. This method will
* not modify dest's size, index bounds, or stride; only
* the array element values of dest may be changed by
* this function. No part of src is ever changed by copy.
*
* On exit, dest[i][j][k]... = src[i][j][k]... for all
* indices i,j,k... that are in both arrays. If dest and
* src have no indices in common, nothing is copied. For
* example, if src is a 1-d array with elements 0-5 and
* dest is a 1-d array with elements 2-3, this function
* will make the following assignments:
* dest[2] = src[2],
* dest[3] = src[3].
* The function copied the elements that both arrays have
* in common. If dest had elements 4-10, this function
* will make the following assignments:
* dest[4] = src[4],
* dest[5] = src[5].
*/
void
sidlx_rmi_Common__array_copy(
const struct sidlx_rmi_Common__array* src,
struct sidlx_rmi_Common__array* dest);
/**
* If necessary, convert a general matrix into a matrix
* with the required properties. This checks the
* dimension and ordering of the matrix. If both these
* match, it simply returns a new reference to the
* existing matrix. If the dimension of the incoming
* array doesn't match, it returns NULL. If the ordering
* of the incoming array doesn't match the specification,
* a new array is created with the desired ordering and
* the content of the incoming array is copied to the new
* array.
*
* The ordering parameter should be one of the constants
* defined in enum sidl_array_ordering
* (e.g. sidl_general_order, sidl_column_major_order, or
* sidl_row_major_order). If you specify
* sidl_general_order, this routine will only check the
* dimension because any matrix is sidl_general_order.
*
* The caller assumes ownership of the returned reference
* unless it's NULL.
*/
struct sidlx_rmi_Common__array*
sidlx_rmi_Common__array_ensure(
struct sidlx_rmi_Common__array* src,
int32_t dimen,
int ordering);
#pragma weak sidlx_rmi_Common__connectI
/**
* RMI connector function for the class. (no addref)
*/
struct sidlx_rmi_Common__object*
sidlx_rmi_Common__connectI(const char * url, sidl_bool ar, struct
sidl_BaseInterface__object **_ex);
#ifdef __cplusplus
}
#endif
#endif
|