class gdsDataReference

Class to store a data reference.

Inheritance:

Public Classes

enum	byteorder Byte order of binary data. BE big endian LE little endian

Public Fields

bool	reference valid reference if true
bool	selfref self reference (needed for attaching data to the save file)
string	fileref referenced filename
int	offset offset of binary data within the file (in bytes)
int	selfofs offset for self reference */
int	length length of binary data (in bytes)
byteorder	encoding byte order of binary data

Public Methods

friend std::ostream&	operator << (std::ostream&, const gdsDataReference&) Output operator.
	gdsDataReference () Default constructor.
	~gdsDataReference () Destructor.
explicit	gdsDataReference (const string& Filename, bool Self = true, int Offset = 0, int Length = 0) Constructor.
	gdsDataReference (const gdsDataReference& dref) Copy constructor.
gdsDataReference&	operator= (const gdsDataReference& ref) Assignment oparator.
bool	setMapping (gdsDataObject& dat) Sets mapping for to binary data.

Public

typedef enum byteorder

byteorder byte order type

friend std::ostream& operator << (std::ostream&, const gdsDataReference&)

This function writes a data reference to an output stream following the LigoLW XML specification.

Returns:

input stream

Parameters:

ostream - output stream
gdsDataReference - class

enum byteorder

Byte order of binary data (enumerated type).

BE

big endian

LE

little endian

typedef enum byteorder byteorder

byte order type

bool reference

valid reference if true

bool selfref

self reference (needed for attaching data to the save file)

string fileref

referenced filename

int offset

offset of binary data within the file (in bytes)

int selfofs

offset for self reference */

int length

length of binary data (in bytes)

byteorder encoding

byte order of binary data

gdsDataReference()

Constructs a data reference object with no actual reference.

Returns:

void

~gdsDataReference()

Destructs the data reference.

Returns:

void

explicit gdsDataReference(const string& Filename, bool Self = true, int Offset = 0, int Length = 0)

Constructs a data reference object with a refrence to a file.

Returns:

void

gdsDataReference(const gdsDataReference& dref)

Constructs a data reference from another one.

Returns:

void

gdsDataReference& operator= (const gdsDataReference& ref)

Copies a data reference. This function does not establish a new mapping! Call setMapping to point the data value to the new reference if necessary.

Returns:

this data reference

Parameters:

ref - data reference which will be copied

bool setMapping(gdsDataObject& dat)

Sets the value pointer to the file data if the data object is a reference to a file. Returns true if successful. This function always returns true, if the data object has no external link.

Returns:

true if mapping successful or not needed

This class has no child classes.

Author:

DS, November 98

See Also:

Diagnostics storage API

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++