Main Page | Class Hierarchy | Compound List | File List | Compound Members

BxDataset Class Reference

Class implementing the BinX compound type BXSTRUCT. More...

#include <BxDataset.h>

Inheritance diagram for BxDataset:

BxDataObject BxObject List of all members.

Public Member Functions

 BxDataset ()
 BxDataset (const BxDataset &copy)
virtual char * toString (bool xml)
virtual bool toStream (FILE *)
virtual bool toStreamBinary (FILE *)
void reset ()
bool next ()
BxDataObjectgetDataObject () const
BxByte8getByte8 ()
BxCharacter8getCharacter8 ()
BxShort16getShort16 ()
BxInteger32getInteger32 ()
BxLong64getLong64 ()
BxUnsignedShort16getUnsignedShort16 ()
BxUnsignedInteger32getUnsignedInteger32 ()
BxUnsignedLong64getUnsignedLong64 ()
BxFloat32getFloat32 ()
BxDouble64getDouble64 ()
BxDatasetgetDataset ()
BxArraygetArray ()
BxUniongetUnion ()
BxStringgetString ()
bool isByte8 () const
bool isCharacter8 () const
bool isShort16 () const
bool isInteger32 () const
bool isLong64 () const
bool isUnsignedShort16 () const
bool isUnsignedInteger32 () const
bool isUnsignedLong64 () const
bool isFloat32 () const
bool isDouble64 () const
bool isDataset () const
bool isArray () const
bool isUnion () const
bool isString () const
int count () const
BxDataObjectgetDataObject (int index) const
BxDataObjectgetDataObject (const char *name) const
BxByte8getByte8 (int index)
BxCharacter8getCharacter8 (int index)
BxShort16getShort16 (int index)
BxInteger32getInteger32 (int index)
BxLong64getLong64 (int index)
BxUnsignedShort16getUnsignedShort16 (int index)
BxUnsignedInteger32getUnsignedInteger32 (int index)
BxUnsignedLong64getUnsignedLong64 (int index)
BxFloat32getFloat32 (int index)
BxDouble64getDouble64 (int index)
BxDatasetgetDataset (int index)
BxArraygetArray (int index)
BxUniongetUnion (int index)
BxStringgetString (int index)
bool isByte8 (int index) const
bool isCharacter8 (int index) const
bool isShort16 (int index) const
bool isInteger32 (int index) const
bool isLong64 (int index) const
bool isUnsignedShort16 (int index) const
bool isUnsignedInteger32 (int index) const
bool isUnsignedLong64 (int index) const
bool isFloat32 (int index) const
bool isDouble64 (int index) const
bool isDataset (int index) const
bool isArray (int index) const
bool isUnion (int index) const
bool isString (int index) const
BxByte8getByte8 (const char *vname)
BxCharacter8getCharacter8 (const char *vname)
BxShort16getShort16 (const char *vname)
BxInteger32getInteger32 (const char *vname)
BxLong64getLong64 (const char *vname)
BxUnsignedShort16getUnsignedShort16 (const char *vname)
BxUnsignedInteger32getUnsignedInteger32 (const char *vname)
BxUnsignedLong64getUnsignedLong64 (const char *vname)
BxFloat32getFloat32 (const char *vname)
BxDouble64getDouble64 (const char *vname)
BxDatasetgetDataset (const char *vname)
BxArraygetArray (const char *vname)
BxUniongetUnion (const char *vname)
BxStringgetString (const char *vname)
bool isByte8 (const char *vname) const
bool isCharacter8 (const char *vname) const
bool isShort16 (const char *vname) const
bool isInteger32 (const char *vname) const
bool isLong64 (const char *vname) const
bool isUnsignedShort16 (const char *vname) const
bool isUnsignedInteger32 (const char *vname) const
bool isUnsignedLong64 (const char *vname) const
bool isFloat32 (const char *vname) const
bool isDouble64 (const char *vname) const
bool isDataset (const char *vname) const
bool isArray (const char *vname) const
bool isUnion (const char *vname) const
bool isString (const char *vname) const
bool addDataObject (BxDataObject *)

Detailed Description

BxDataset implements a user-defined, ordered collection of objects of various BinX data types. Such a collection is typically called a structure. An instance of the class BxDataset is also a struct and its member elements can be of any data type. BxDataset serves as a container, child data elements can be added to it and the once added they will be managed by the container and released when the container is released.
The child elements in the dataset can be accessed in several different ways.
  1. By relative position number in the list. The position must be specified as a zero-based offset into the collection list.
           Example: BxInteger32 * pi = p->getInteger32(2);
       
  2. By specifying the value of a user-defined type name associated with an instance in the collection.
           Example: BxShort16 * ps = p->getShort16("X");
       
  3. By using the enumeration method BxDataset::next() to interatively step through the ordered collection and use the method BxDataset::getDataObject to get the instance currently selected by the next() method. This process can be repeated until all instances have been scanned and obtained. Example:
       while (p->next()) {
          BxDataObject * pd = p->getDataObject();
       
The selected instance is returned as an instance of class BxDataObject or an instance of a class derived from BxDataObject.
Since: BinX version 1.0.


Constructor & Destructor Documentation

BxDataset::BxDataset  ) 
 

Default constructor.

Constructs an empty instance of the class BxDataset. There are no objects in the dataset collection. Default attribute values are assigned as follows:

       pBuffer_ = NULL;
       nCurrentObject_ = -1;
   

BxDataset::BxDataset const BxDataset copy  ) 
 

Construct a BxDataset instance by copying a specified BxDataset instance.

Attributes of the new dataset instance are initialized by copying attribute values from the specified input dataset. Uninitialized attribute values in the input dataset result in NULL valued attributes in the new dataset instance. If the attributes of the input dataset have been initialized and the instance is populated with references to other objects, then the referenced objects are copied or cloned and the structure of the new instance will reference the newly cloned objects, following the same structure as the input instance.
Upon completion of the copy operation, the two dataset instances are independent. They do not share contained objects and they must be individually destructed.

Parameters:
copy The BxDataset instance whose attribute values are to be copied.


Member Function Documentation

bool BxDataset::addDataObject BxDataObject pdo  ) 
 

Append a specified instance of BxDataObject to a dataset.

The elements within a dataset are ordered. The input object is appended to the end of the dataset by reference. The input object must be of type BxDataObject or one of its derived types. Attributes of the newly appended object will be set or reset to be consistent with its membership in the dataset. Significant object attributes that may be reset by this method include:

  • The binary file associated with this object
  • The binary file byte offset for locating the corresponding application data value for this object. The byte offset is calculated from the byte offset to the beginning of the dataset object plus the byte size of all dataset members preceeding the newly appended object.
Because the input object is added by reference, the input object remains under the management of this dataset object. The caller must not delete the input object.
Parameters:
pdo A pointer to an object to append to the dataset.
Returns:
true If the input object is appended to the dataset
false If the input can not be appended to the dataset.

int BxDataset::count  )  const
 

Get the number of object members in a dataset.

Compound objects, such as arrays, unions, and other datasets, count as a single object within the dataset.

Returns:
The number of object elements in this dataset.

BxArray * BxDataset::getArray const char *  vname  ) 
 

Get a reference to a BxArray object contained in a dataset, based on its variable name.

This method assumes that an object of type BxArray (or any of its derived types BxArrayFixed, BxArrayVariable, and BxArrayStreamed) has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxArray each having the same user-defined variable name, then the first object of type BxArray having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxArray contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxArray object.
If unsuccessful, a NULL pointer.

BxArray * BxDataset::getArray int  index  ) 
 

Get a reference to a BxArray object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxArray (or any of its derived types BxArrayFixed, BxArrayVariable, and BxArrayStreamed) is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxArray exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxArray, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxArray object.
If unsuccessful, a NULL pointer.

BxArray * BxDataset::getArray  ) 
 

Get a reference to the BxArray instance in the current position of the ordered list of dataset members.

This method assumes that an object of type BxArray (or any of its derived types BxArrayFixed, BxArrayVariable, and BxArrayStreamed) is contained at a current position within a dataset object. A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxArray or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxArray at the current position is returned.

BxByte8 * BxDataset::getByte8 const char *  vname  ) 
 

Get a reference to a BxByte8 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxByte8 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxByte8 each having the same user-defined variable name, then the first object of type BxByte8 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxByte8 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxByte8 object.
If unsuccessful, a NULL pointer.

BxByte8 * BxDataset::getByte8 int  index  ) 
 

Get a reference to a BxByte8 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxByte8 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxByte8 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxByte8, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxByte8 object.
If unsuccessful, a NULL pointer.

BxByte8 * BxDataset::getByte8  ) 
 

Get a reference to the BxByte8 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxByte8 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxByte8 at the current position is returned.

Returns:
If successful, a pointer to the BxByte8 object.
If unsuccessful, a NULL pointer.

BxCharacter8 * BxDataset::getCharacter8 const char *  vname  ) 
 

Get a reference to a BxCharacter8 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxCharacter8 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxCharacter8 each having the same user-defined variable name, then the first object of type BxCharacter8 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxCharacter8 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxCharacter8 object.
If unsuccessful, a NULL pointer.

BxCharacter8 * BxDataset::getCharacter8 int  index  ) 
 

Get a reference to a BxCharacter8 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxCharacter8 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxCharacter8 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxCharacter8, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxCharacter8 object.
If unsuccessful, a NULL pointer.

BxCharacter8 * BxDataset::getCharacter8  ) 
 

Get a reference to the BxCharacter8 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxCharacter8 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxCharacter8 at the current position is returned.

Returns:
If successful, a pointer to the BxCharacter8 object.
If unsuccessful, a NULL pointer.

BxDataObject * BxDataset::getDataObject const char *  name  )  const
 

Get a reference to an object in a dataset, based on the user-defined variable name of that object.

The user-defined variable name was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references having the same user-defined variable name, then the first object having the specified variable name is selected and a reference to that object is returned to the caller.

Parameters:
name A character string containing the user-defined variable name to search for.
Returns:
A pointer to the first BxDataobject instance having the specified type name.

BxDataObject * BxDataset::getDataObject int  index  )  const
 

Get a reference to an object in the dataset, based on its relative position in the dataset.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, then a null pointer is returned. If an object reference is selected, the reference is returned to the caller.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
A pointer to the BxDataobject instance that was referenced from the specified position in the dataset.

BxDataObject * BxDataset::getDataObject  )  const
 

Get a reference to the BxDataObject instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxDataObject or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxDataObject at the current position is returned.

Returns:
If successful, a pointer to the BxDataObject object.
If unsuccessful, a NULL pointer.

BxDataset * BxDataset::getDataset const char *  vname  ) 
 

Get a reference to a BxDataset object contained in a dataset, based on its variable name.

This method assumes that an object of type BxDataset has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxDataset each having the same user-defined variable name, then the first object of type BxDataset having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxDataset contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxDataset object.
If unsuccessful, a NULL pointer.

BxDataset * BxDataset::getDataset int  index  ) 
 

Get a reference to a BxDataset object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxDataset is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxDataset exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxDataset, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxDataset object.
If unsuccessful, a NULL pointer.

BxDataset * BxDataset::getDataset  ) 
 

Get a reference to the BxDataset instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxDataset or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxDataset at the current position is returned.

Returns:
If successful, a pointer to the BxDataset object.
If unsuccessful, a NULL pointer.

BxDouble64 * BxDataset::getDouble64 const char *  vname  ) 
 

Get a reference to a BxDouble64 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxDouble64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxDouble64 each having the same user-defined variable name, then the first object of type BxDouble64 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxDouble64 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxDouble64 object.
If unsuccessful, a NULL pointer.

BxDouble64 * BxDataset::getDouble64 int  index  ) 
 

Get a reference to a BxDouble64 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxDouble64 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxDouble64 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxDouble64, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxDouble64 object.
If unsuccessful, a NULL pointer.

BxDouble64 * BxDataset::getDouble64  ) 
 

Get a reference to the BxDouble64 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxDouble64 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxDouble64 at the current position is returned.

Returns:
If successful, a pointer to the BxDouble64 object.
If unsuccessful, a NULL pointer.

BxFloat32 * BxDataset::getFloat32 const char *  vname  ) 
 

Get a reference to a BxFloat32 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxFloat32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxFloat32 each having the same user-defined variable name, then the first object of type BxFloat32 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxFloat32 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxFloat32 object.
If unsuccessful, a NULL pointer.

BxFloat32 * BxDataset::getFloat32 int  index  ) 
 

Get a reference to a BxFloat32 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxFloat32 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxFloat32 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxFloat32, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxFloat32 object.
If unsuccessful, a NULL pointer.

BxFloat32 * BxDataset::getFloat32  ) 
 

Get a reference to the BxFloat32 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxFloat32 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxFloat32 at the current position is returned.

Returns:
If successful, a pointer to the BxFloat32 object.
If unsuccessful, a NULL pointer.

BxInteger32 * BxDataset::getInteger32 const char *  vname  ) 
 

Get a reference to a BxInteger32 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxInteger32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxInteger32 each having the same user-defined variable name, then the first object of type BxInteger32 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxInteger32 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxInteger32 object.
If unsuccessful, a NULL pointer.

BxInteger32 * BxDataset::getInteger32 int  index  ) 
 

Get a reference to a BxInteger32 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxInteger32 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxInteger32 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxInteger32, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxInteger32 object.
If unsuccessful, a NULL pointer.

BxInteger32 * BxDataset::getInteger32  ) 
 

Get a reference to the BxInteger32 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxInteger32 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxInteger32 at the current position is returned.

Returns:
If successful, a pointer to the BxInteger32 object.
If unsuccessful, a NULL pointer.

BxLong64 * BxDataset::getLong64 const char *  vname  ) 
 

Get a reference to a BxLong64 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxLong64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxLong64 each having the same user-defined variable name, then the first object of type BxLong64 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxLong64 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxLong64 object.
If unsuccessful, a NULL pointer.

BxLong64 * BxDataset::getLong64 int  index  ) 
 

Get a reference to a BxLong64 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxLong64 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxLong64 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxLong64, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxLong64 object.
If unsuccessful, a NULL pointer.

BxLong64 * BxDataset::getLong64  ) 
 

Get a reference to the BxLong64 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxLong64 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxLong64 at the current position is returned.

BxShort16 * BxDataset::getShort16 const char *  vname  ) 
 

Get a reference to a BxShort16 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxShort16 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxShort16 each having the same user-defined variable name, then the first object of type BxShort16 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxShort16 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxShort16 object.
If unsuccessful, a NULL pointer.

BxShort16 * BxDataset::getShort16 int  index  ) 
 

Get a reference to a BxShort16 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxShort16 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxShort16 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxShort16, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxShort16 object.
If unsuccessful, a NULL pointer.

BxShort16 * BxDataset::getShort16  ) 
 

Get a reference to the BxShort16 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxShort16 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxShort16 at the current position is returned.

Returns:
If successful, a pointer to the BxShort16 object.
If unsuccessful, a NULL pointer.

BxString * BxDataset::getString const char *  vname  ) 
 

Get a reference to a BxString object contained in a dataset, based on its variable name.

This method assumes that an object of type BxString has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxString each having the same user-defined variable name, then the first object of type BxString having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxString contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxString object.
If unsuccessful, a NULL pointer.

BxString * BxDataset::getString int  index  ) 
 

Get a reference to a BxString object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxString is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxString exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxString, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxString object.
If unsuccessful, a NULL pointer.

BxString * BxDataset::getString  ) 
 

Get a reference to the BxString instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxString or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxString at the current position is returned.

Returns:
If successful, a pointer to the BxString object.
If unsuccessful, a NULL pointer.

BxUnion * BxDataset::getUnion const char *  vname  ) 
 

Get a reference to a BxUnion object contained in a dataset, based on its variable name.

This method assumes that an object of type BxUnion has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxUnion each having the same user-defined variable name, then the first object of type BxUnion having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxUnion contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxUnion object.
If unsuccessful, a NULL pointer.

BxUnion * BxDataset::getUnion int  index  ) 
 

Get a reference to a BxUnion object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxUnion is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxUnion exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxUnion, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxUnion object.
If unsuccessful, a NULL pointer.

BxUnion * BxDataset::getUnion  ) 
 

Get a reference to the BxUnion instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxUnion or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxUnion at the current position is returned.

BxUnsignedInteger32 * BxDataset::getUnsignedInteger32 const char *  vname  ) 
 

Get a reference to a BxUnsignedInteger32 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxUnsignedInteger32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxUnsignedInteger32 each having the same user-defined variable name, then the first object of type BxUnsignedInteger32 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxUnsignedInteger32 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxUnsignedInteger32 object.
If unsuccessful, a NULL pointer.

BxUnsignedInteger32 * BxDataset::getUnsignedInteger32 int  index  ) 
 

Get a reference to a BxUnsignedInteger32 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxUnsignedInteger32 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxUnsignedInteger32 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxUnsignedInteger32, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxUnsignedInteger32 object.
If unsuccessful, a NULL pointer.

BxUnsignedInteger32 * BxDataset::getUnsignedInteger32  ) 
 

Get a reference to the BxUnsignedInteger32 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxUnsignedInteger32 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxUnsignedInteger32 at the current position is returned.

Returns:
If successful, a pointer to the BxUnsignedInteger32 object.
If unsuccessful, a NULL pointer.

BxUnsignedLong64 * BxDataset::getUnsignedLong64 const char *  vname  ) 
 

Get a reference to a BxUnsignedLong64 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxUnsignedLong64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxUnsignedLong64 each having the same user-defined variable name, then the first object of type BxUnsignedLong64 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxUnsignedLong64 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxUnsignedLong64 object.
If unsuccessful, a NULL pointer.

BxUnsignedLong64 * BxDataset::getUnsignedLong64 int  index  ) 
 

Get a reference to a BxUnsignedLong64 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxUnsignedLong64 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxUnsignedLong64 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxUnsignedLong64, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxUnsignedLong64 object.
If unsuccessful, a NULL pointer.

BxUnsignedLong64 * BxDataset::getUnsignedLong64  ) 
 

Get a reference to the BxUnsignedLong64 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxUnsignedLong64 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxUnsignedLong64 at the current position is returned.

Returns:
If successful, a pointer to the BxUnsignedLong64 object.
If unsuccessful, a NULL pointer.

BxUnsignedShort16 * BxDataset::getUnsignedShort16 const char *  vname  ) 
 

Get a reference to a BxUnsignedShort16 object contained in a dataset, based on its variable name.

This method assumes that an object of type BxUnsignedShort16 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object having the specified variable name, then a null pointer is returned. If the dataset contains multiple object references of type BxUnsignedShort16 each having the same user-defined variable name, then the first object of type BxUnsignedShort16 having the specified variable name is selected and a reference to that object is returned to the caller.

Exceptions:
NO_VAR If the specified variable name is not associated with any of the objects of type BxUnsignedShort16 contained in the dataset, then the NO_VAR error is logged and a NULL pointer is returned.
Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
If successful, a pointer to the BxUnsignedShort16 object.
If unsuccessful, a NULL pointer.

BxUnsignedShort16 * BxDataset::getUnsignedShort16 int  index  ) 
 

Get a reference to a BxUnsignedShort16 object contained in a dataset, based on its relative position in the dataset.

This method assumes that an object of type BxUnsignedShort16 is contained at a specific position within a dataset object. Index positions within a dataset are specified by a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If an object of type BxUnsignedShort16 exists at the specified position, then that object is returned to the caller.

Exceptions:
DATARANGE If the specified index position is larger than the collection size minus one, then the DATARANGE error is logged and a NULL pointer is returned.
DATATYPE If the object contained in the dataset at the specified position is not of type BxUnsignedShort16, then the DATATYPE error is logged and a NULL pointer is returned.
Parameters:
index Specifies the relative position of an object contained in the dataset.
Returns:
If successful, a pointer to the BxUnsignedShort16 object.
If unsuccessful, a NULL pointer.

BxUnsignedShort16 * BxDataset::getUnsignedShort16  ) 
 

Get a reference to the BxUnsignedShort16 instance in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the dataset member at the current position in the ordered list of members is not of type BxUnsignedShort16 or there are no member objects in this dataset, then a NULL pointer is returned, otherwise the member object of type BxUnsignedShort16 at the current position is returned.

Returns:
If successful, a pointer to the BxUnsignedShort16 object.
If unsuccessful, a NULL pointer.

bool BxDataset::isArray const char *  vname  )  const
 

Test for a member object of type BxArray having a specified variable name.

This method assumes that an object of type BxArray or one of its derived types BxArrayFixed, BxArray Variable, or BxArrayStreamed, has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxArray having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxArray each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxArray
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isArray int  index  )  const
 

Test for a member object of type BxArray in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxArray or any of its derived types BxArrayFixed, BxArrayVariable, and BxArrayStreamed, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxArray
false If the member object at the specified position is of another type.

bool BxDataset::isArray  )  const
 

Test for a member object of type BxArray in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxArray or any of its derived types BxArrayFixed, BxArrayVariable, and BxArrayStreamed, or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxArray
false If the member object at the current position is of another type.

bool BxDataset::isByte8 const char *  vname  )  const
 

Test for a member object of type BxByte8 having a specified variable name.

This method assumes that an object of type BxByte8 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxByte8 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxByte8 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxByte8
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isByte8 int  index  )  const
 

Test for a member object of type BxByte8 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxByte8, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxByte8
false If the member object at the specified position is of another type.

bool BxDataset::isByte8  )  const
 

Test for a member object of type BxByte8 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxByte8 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxByte8
false If the member object at the current position is of another type.

bool BxDataset::isCharacter8 const char *  vname  )  const
 

Test for a member object of type BxCharacter8 having a specified variable name.

This method assumes that an object of type BxCharacter8 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxCharacter8 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxCharacter8 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxCharacter8
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isCharacter8 int  index  )  const
 

Test for a member object of type BxCharacter8 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxCharacter8, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxCharacter8
false If the member object at the specified position is of another type.

bool BxDataset::isCharacter8  )  const
 

Test for a member object of type BxCharacter8 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxCharacter8 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxCharacter8
false If the member object at the current position is of another type.

bool BxDataset::isDataset const char *  vname  )  const
 

Test for a member object of type BxDataset having a specified variable name.

This method assumes that an object of type BxDataset has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxDataset having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxDataset each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxDataset
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isDataset int  index  )  const
 

Test for a member object of type BxDataset in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxDataset, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxDataset
false If the member object at the specified position is of another type.

bool BxDataset::isDataset  )  const
 

Test for a member object of type BxDataset in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxDataset or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxDataset
false If the member object at the current position is of another type.

bool BxDataset::isDouble64 const char *  vname  )  const
 

Test for a member object of type BxDouble64 having a specified variable name.

This method assumes that an object of type BxDouble64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxDouble64 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxDouble64 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxDouble64
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isDouble64 int  index  )  const
 

Test for a member object of type BxDouble64 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxDouble64, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxDouble64
false If the member object at the specified position is of another type.

bool BxDataset::isDouble64  )  const
 

Test for a member object of type BxDouble64 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxDouble64 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxDouble64
false If the member object at the current position is of another type.

bool BxDataset::isFloat32 const char *  vname  )  const
 

Test for a member object of type BxFloat32 having a specified variable name.

This method assumes that an object of type BxFloat32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxFloat32 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxFloat32 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxFloat32
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isFloat32 int  index  )  const
 

Test for a member object of type BxFloat32 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxFloat32, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxFloat32
false If the member object at the specified position is of another type.

bool BxDataset::isFloat32  )  const
 

Test for a member object of type BxFloat32 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxFloat32 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxFloat32
false If the member object at the current position is of another type.

bool BxDataset::isInteger32 const char *  vname  )  const
 

Test for a member object of type BxInteger32 having a specified variable name.

This method assumes that an object of type BxInteger32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxInteger32 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxInteger32 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxInteger32
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isInteger32 int  index  )  const
 

Test for a member object of type BxInteger32 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxInteger32, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxInteger32
false If the member object at the specified position is of another type.

bool BxDataset::isInteger32  )  const
 

Test for a member object of type BxInteger32 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxInteger32 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxInteger32
false If the member object at the current position is of another type.

bool BxDataset::isLong64 const char *  vname  )  const
 

Test for a member object of type BxLong64 having a specified variable name.

This method assumes that an object of type BxLong64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxLong64 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxLong64 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxLong64
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isLong64 int  index  )  const
 

Test for a member object of type BxLong64 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxLong64, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxLong64
false If the member object at the specified position is of another type.

bool BxDataset::isLong64  )  const
 

Test for a member object of type BxLong64 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxLong64 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxLong64
false If the member object at the current position is of another type.

bool BxDataset::isShort16 const char *  vname  )  const
 

Test for a member object of type BxShort16 having a specified variable name.

This method assumes that an object of type BxShort16 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxShort16 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxShort16 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxShort16
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isShort16 int  index  )  const
 

Test for a member object of type BxShort16 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxShort16, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxShort16
false If the member object at the specified position is of another type.

bool BxDataset::isShort16  )  const
 

Test for a member object of type BxShort16 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxShort16 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxShort16
false If the member object at the current position is of another type.

bool BxDataset::isString const char *  vname  )  const
 

Test for a member object of type BxString having a specified variable name.

This method assumes that an object of type BxString has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxString having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxString each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxString
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isString int  index  )  const
 

Test for a member object of type BxString in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxString, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxString
false If the member object at the specified position is of another type.

bool BxDataset::isString  )  const
 

Test for a member object of type BxString in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxString or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxString
false If the member object at the current position is of another type.

bool BxDataset::isUnion const char *  vname  )  const
 

Test for a member object of type BxUnion having a specified variable name.

This method assumes that an object of type BxUnion has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxUnion having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxUnion each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxUnion
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isUnion int  index  )  const
 

Test for a member object of type BxUnion in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxUnion, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxUnion
false If the member object at the specified position is of another type.

bool BxDataset::isUnion  )  const
 

Test for a member object of type BxUnion in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxUnion or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxUnion
false If the member object at the current position is of another type.

bool BxDataset::isUnsignedInteger32 const char *  vname  )  const
 

Test for a member object of type BxUnsignedInteger32 having a specified variable name.

This method assumes that an object of type BxUnsignedInteger32 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxUnsignedInteger32 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxUnsignedInteger32 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxUnsignedInteger32
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isUnsignedInteger32 int  index  )  const
 

Test for a member object of type BxUnsignedInteger32 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxUnsignedInteger32, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxUnsignedInteger32
false If the member object at the specified position is of another type.

bool BxDataset::isUnsignedInteger32  )  const
 

Test for a member object of type BxUnsignedInteger32 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxUnsignedInteger32 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxUnsignedInteger32
false If the member object at the current position is of another type.

bool BxDataset::isUnsignedLong64 const char *  vname  )  const
 

Test for a member object of type BxUnsignedLong64 having a specified variable name.

This method assumes that an object of type BxUnsignedLong64 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxUnsignedLong64 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxUnsignedLong64 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxUnsignedLong64
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isUnsignedLong64 int  index  )  const
 

Test for a member object of type BxUnsignedLong64 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxUnsignedLong64, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxUnsignedLong64
false If the member object at the specified position is of another type.

bool BxDataset::isUnsignedLong64  )  const
 

Test for a member object of type BxUnsignedLong64 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxUnsignedLong64 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxUnsignedLong64
false If the member object at the current position is of another type.

bool BxDataset::isUnsignedShort16 const char *  vname  )  const
 

Test for a member object of type BxUnsignedShort16 having a specified variable name.

This method assumes that an object of type BxUnsignedShort16 has a specific variable name and that the object is contained in a dataset object. The user-defined variable name for an object was declared in the BinX document associated with the dataset object. Each object contained in the dataset may have a unique variable name, which is stored as an attribute value of that object. If the dataset does not contain an object of type BxUnsignedShort16 having the specified variable name, then the value false is returned. If the dataset contains one or more object references of type BxUnsignedShort16 each having the same user-defined variable name, then the value true is returned.

Parameters:
vname A character string containing the user-defined variable name to search for.
Returns:
true If at least one member object has the specified variable name and is of type BxUnsignedShort16
false If no member objects have the specified variable name or are of another type.

bool BxDataset::isUnsignedShort16 int  index  )  const
 

Test for a member object of type BxUnsignedShort16 in a specified position of the ordered list of dataset members.

The position must be specified as a zero-based offset into the dataset list. Compound objects, such as arrays, unions, and other datasets, count as a single object in this indexing scheme. If the position number is greater than the dataset size minus one, or the member object at the specified position is not of type BxUnsignedShort16, then the value false is returned.

Parameters:
index Specifies a position in the ordered dataset, zero-based.
Returns:
true If the member object at the specified position is of type BxUnsignedShort16
false If the member object at the specified position is of another type.

bool BxDataset::isUnsignedShort16  )  const
 

Test for a member object of type BxUnsignedShort16 in the current position of the ordered list of dataset members.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. The current position value must be set before this method is invoked.
If the current position is not set (meaning the dataset contains no member objects, or the scan position has been reset to minus one), then the value false is returned. If the dataset member at the current position in the ordered list of members is not of type BxUnsignedShort16 or there are no member objects in this dataset, then the value false is returned,

Returns:
true If the member object at the current position is of type BxUnsignedShort16
false If the member object at the current position is of another type.

bool BxDataset::next  ) 
 

Advance the current scan position within the ordered member objects of a dataset object.

Set current data element pointer to the next member object in this dataset. If the current scan position is minus one (meaning the reset method has been invoked), then the scan position is set to the first member object in the dataset. If the curren scan position indicates the last member object in the dataset, then the scan position is reset to minus one.

Returns:
true If the scan position was set to indicates a member object in the dataset.
false If there is not "next" member and the scan position was reset to minus one.

void BxDataset::reset  ) 
 

Reset the scanning position within a dataset object.

A current position within the ordered list of objects referenced by this dataset is established by invoking the parameterized get() methods and the next() method implemented by this class. This method resets the current position to minus one, allowing callers to initiate a new scan operation using the next() method.

Warning:
After executing this reset method, the next() method must be invoked to set the current position to the first element in the dataset, before invoking any of the BxDataset::get<object-type>() methods that do not require an input parameter. Invoking this king of get method after a reset without an intervening call to the next() method results in an error. Get methods that require an input parameter, such as position or variable name may be invoked following a reset without an intervening invocation of the next() method.

bool BxDataset::toStream FILE *  stream  )  [virtual]
 

Write a string containing the DataBinX representation of all members of a dataset object to a specified file.

The DataBinx representation of a BinX primitive data type is a printable representation of the object and it includes the following elements:

  • The BinX XML schema tags (begin and end tags) for a dataset
  • For each member object, the BinX XML begin and end tags for that object type
  • For each member object, a printable representation of the application data value for that object
This method writes a stream of consecutive bytes formed by the concatenation of the above substrings. The dataset object may contain simple BinX data types or compound BinX data types such as arrays, unions, and other dataset objects.
The file must be open for writing in text mode.
Parameters:
stream A file pointer to a file open for writing in text mode.
Returns:
true If no file I/O error occurs,
false If any file I/O errors occur.

Reimplemented from BxDataObject.

bool BxDataset::toStreamBinary FILE *  stream  )  [virtual]
 

Write the application data value of each of the dataset member obejcts to a specified binary file.

The file must be open for writing in binary mode.

Parameters:
stream A file pointer to a file open for writing in binary mode.
Returns:
true If no file I/O error occurs,
false If any file I/O errors occur.

Reimplemented from BxDataObject.

char * BxDataset::toString bool  xml  )  [virtual]
 

Return a string containing the DataBinX XML elements (or printable value only ) for all of the member objects in a dataset object.

The DataBinx representation of a BxDataset object is

       <struct>
           DataBinX-elements-and-attributes-for-each-member-object
       </struct>
   

This method allocates memory to hold the returned string. The caller is responsible for releasing the memory when the string is no longer needed.
If the BinX XML tags are not required, then the input boolean flag can be used to request that only the application data values for each member object be included in the null-terminated result string.
Parameters:
xml A boolean indicating whether to include BinX XML tags or not.
Returns:
A string buffer containing the DataBinX representation of the value of this object, if the input flag is true,
A string buffer containing only the application data values for this object, if the input flag is false.

Reimplemented from BxDataObject.


The documentation for this class was generated from the following files:
Generated on Fri May 6 13:36:19 2005 for edikt::BinX by doxygen 1.3.3