Inheritance diagram for prodml2_0::DasAcquisition:

Public Member Functions
	DasAcquisition ()

	DasAcquisition (class FiberOpticalPath fiberOpticalPath, class DasInstrumentBox dasInstrumentBox, const std::string &guid, const std::string &title, const std::string &jobUuid, const std::string &facilityId, const std::string &vendorName, const double &pulseRate, const gsoap_eml2_1::eml21__FrequencyUom &pulseRateUom, const double &pulseWidth, const gsoap_eml2_1::eml21__TimeUom &pulseWidthUom, const double &gaugeLength, const gsoap_eml2_1::eml21__LengthUom &gaugeLengthUom, const double &spatialSamplingInterval, const gsoap_eml2_1::eml21__LengthUom &spatialSamplingIntervalUom, const double &minimumFrequency, const gsoap_eml2_1::eml21__FrequencyUom &minimumFrequencyUom, const double &maximumFrequency, const gsoap_eml2_1::eml21__FrequencyUom &maximumFrequencyUom, const ULONG64 &lociCount, const ULONG64 &startLocusIndex, const std::string &measurementStartIsoTime, bool triggeredMeasurement)

	DasAcquisition (class FiberOpticalPath fiberOpticalPath, class DasInstrumentBox dasInstrumentBox, prodml2_0::HdfProxy *proxy)

	DasAcquisition (gsoap_eml2_1::_prodml2__DasAcquisition *fromGsoap)

	~DasAcquisition ()

virtual std::string	getXmlTag () const

void	setHdfProxy (common::AbstractHdfProxy *proxy)

gsoap_eml2_1::eml21__DataObjectReference *	getFiberOpticalPathDor () const

class FiberOpticalPath *	getFiberOpticalPath () const

void	setFiberOpticalPath (class FiberOpticalPath *fiberOpticalPath)

gsoap_eml2_1::eml21__DataObjectReference *	getDasInstrumentBoxDor () const

class DasInstrumentBox *	getDasInstrumentBox () const

void	setDasInstrumentBox (class DasInstrumentBox *dasInstrumentBox)

std::string	getJobUuid () const

std::string	getFacilityUuid () const

std::string	getVendorName () const

double	getPulseRate () const

gsoap_eml2_1::eml21__FrequencyUom	getPulseRateUom () const

double	getPulseWidth () const

gsoap_eml2_1::eml21__TimeUom	getPulseWidthUom () const

double	getGaugeLength () const

gsoap_eml2_1::eml21__LengthUom	getGaugeLengthUom () const

double	getSpatialSamplingInterval () const

gsoap_eml2_1::eml21__LengthUom	getSpatialSamplingIntervalUom () const

double	getMinimumFrequency () const

gsoap_eml2_1::eml21__FrequencyUom	getMinimumFrequencyUom () const

double	getMaximumFrequency () const

gsoap_eml2_1::eml21__FrequencyUom	getMaximumFrequencyUom () const

ULONG64	getLociCount () const

LONG64	getStartLocusIndex () const

std::string	getMeasurementStartIsoTime () const

bool	isTriggeredMeasurement () const

void	pushBackRaw (const std::string &guid, bool datatypeIsInteger, const char &datatypeByteCount, const std::string &rawDataUnit, LONG64 timeArray, const ULONG64 &timeCount, common::AbstractHdfProxy proxy)

void	writeIntoDataset (float *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

void	writeIntoDataset (double *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

void	writeIntoDataset (LONG64 *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

void	writeIntoDataset (int *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

void	writeIntoDataset (short *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

void	writeIntoDataset (char *data, unsigned long numSampleForAllLoci, unsigned long timeStepIndex)

unsigned int	getRawCount () const

gsoap_eml2_1::prodml2__DasDimensions	getRawDataSlowestDimension (const unsigned int &rawIndex) const

gsoap_eml2_1::prodml2__DasDimensions	getRawDataFastestDimension (const unsigned int &rawIndex) const

std::string	getRawDataUnit (const unsigned int &rawIndex) const

LONG64	getStartLocusIndex (const unsigned int &rawIndex) const

ULONG64	getNumberOfLoci (const unsigned int &rawIndex) const

ULONG64	getRawDataTimeCount (const unsigned int &rawIndex) const

resqml2::AbstractValuesProperty::hdfDatatypeEnum	getRawDataHdfDatatype (const unsigned int &rawIndex) const

void	getRawDataAsDoubleValues (const unsigned int &rawIndex, double *values)

void	getRawDataAsFloatValues (const unsigned int &rawIndex, float *values)

void	getRawDataAsLongValues (const unsigned int &rawIndex, LONG64 *values)

void	getRawDataAsIntValues (const unsigned int &rawIndex, int *values)

void	getRawDataAsShortValues (const unsigned int &rawIndex, short *values)

void	getRawDataAsCharValues (const unsigned int &rawIndex, char *values)

void	getRawDataTime (const unsigned int &rawIndex, LONG64 *values)

common::AbstractHdfProxy *	getHdfProxy () const

std::string	getHdfProxyUuid () const

Public Member Functions inherited from prodml2_0::AbstractObject
	~AbstractObject ()

std::string	getXmlNamespace () const

std::string	getContentType () const

std::string	getPartNameInEpcDocument () const

Public Member Functions inherited from common::AbstractObject
bool	isPartial () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (const time_t &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (const time_t &lastUpdate)

void	setFormat (const std::string &format)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setMetadata (const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getGsoapProxy () const

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_resqml2_0_1::resqml2__ContactElementReference *	newResqmlContactElementReference () const

common::EpcDocument *	getEpcDocument () const

virtual std::string	getResqmlVersion () const

std::string	serializeIntoString ()

void	addAlias (const std::string &authority, const std::string &title)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (const unsigned int &index) const

std::string	getAliasTitleAtIndex (const unsigned int &index) const

const std::vector< resqml2::Activity * > &	getActivitySet () const

unsigned int	getActivityCount () const

resqml2::Activity *	getActivity (const unsigned int &index) const

void	pushBackExtraMetadata (const std::string &key, const std::string &value)

std::tr1::unordered_map< std::string, std::string >	getExtraMetadataSet () const

std::vector< std::string >	getExtraMetadata (const std::string &key) const

unsigned int	getExtraMetadataCount () const

std::string	getExtraMetadataKeyAtIndex (const unsigned int &index) const

std::string	getExtraMetadataStringValueAtIndex (const unsigned int &index) const

Static Public Attributes
static const char *	XML_TAG = "DasAcquisition"

Additional Inherited Members
Protected Types inherited from common::AbstractObject
enum	EmlVersion { TWO_DOT_ZERO = 0, TWO_DOT_ONE = 1 }

Protected Member Functions inherited from prodml2_0::AbstractObject
	AbstractObject ()

	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)

Protected Member Functions inherited from common::AbstractObject
	AbstractObject ()
	Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.

	AbstractObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	AbstractObject (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *proxy)

	AbstractObject (gsoap_eml2_1::eml21__AbstractObject *proxy)

void	initMandatoryMetadata ()

void	setMetadata (const std::string &guid, const std::string &title, const std::string &editor, const time_t &creation, const std::string &originator, const std::string &description, const time_t &lastUpdate, const std::string &format, const std::string &descriptiveKeywords)

void	cannotBePartial () const

void	changeToPartialObject ()

Static Protected Member Functions inherited from common::AbstractObject
static void	addActivityToResqmlObject (resqml2::Activity activity, AbstractObject resqmlObject)

Protected Attributes inherited from common::AbstractObject
gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	gsoapProxy2_0_1

gsoap_eml2_1::eml21__AbstractObject *	gsoapProxy2_1

common::EpcDocument *	epcDocument

std::vector< resqml2::Activity * >	activitySet

bool	updateXml

Constructor & Destructor Documentation

prodml2_0::DasAcquisition::DasAcquisition ( )

inline

Default constructor

prodml2_0::DasAcquisition::DasAcquisition	(	class FiberOpticalPath *	fiberOpticalPath,
		class DasInstrumentBox *	dasInstrumentBox,
		const std::string &	guid,
		const std::string &	title,
		const std::string &	jobUuid,
		const std::string &	facilityId,
		const std::string &	vendorName,
		const double &	pulseRate,
		const gsoap_eml2_1::eml21__FrequencyUom &	pulseRateUom,
		const double &	pulseWidth,
		const gsoap_eml2_1::eml21__TimeUom &	pulseWidthUom,
		const double &	gaugeLength,
		const gsoap_eml2_1::eml21__LengthUom &	gaugeLengthUom,
		const double &	spatialSamplingInterval,
		const gsoap_eml2_1::eml21__LengthUom &	spatialSamplingIntervalUom,
		const double &	minimumFrequency,
		const gsoap_eml2_1::eml21__FrequencyUom &	minimumFrequencyUom,
		const double &	maximumFrequency,
		const gsoap_eml2_1::eml21__FrequencyUom &	maximumFrequencyUom,
		const ULONG64 &	lociCount,
		const ULONG64 &	startLocusIndex,
		const std::string &	measurementStartIsoTime,
		bool	triggeredMeasurement
	)

Creates an instance of this class in a gsoap context.

Parameters

soap	A gsoap context wihch will manage the memory and the serialization/deserialization of this instance.
guid	The guid to set to this instance. If empty then a new guid will be generated.
title	A title for the instance to create.

DasAcquisition::DasAcquisition	(	class FiberOpticalPath *	fiberOpticalPath,
		class DasInstrumentBox *	dasInstrumentBox,
		prodml2_0::HdfProxy *	proxy
	)

Creates an instance of this class by parsing an HDF5 file.

prodml2_0::DasAcquisition::DasAcquisition ( gsoap_eml2_1::_prodml2__DasAcquisition * fromGsoap )

inline

Creates an instance of this class by wrapping a gsoap instance.

prodml2_0::DasAcquisition::~DasAcquisition ( )

inline

Destructor does nothing since the memory is managed by the gsoap context.

Member Function Documentation

unsigned int DasAcquisition::getRawCount ( ) const

Get the count of raw in this data instance

void DasAcquisition::getRawDataAsCharValues	(	const unsigned int &	rawIndex,
		char *	values
	)

Get all the values of a particular raw of the instance which are supposed to be int 8 bits ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

void DasAcquisition::getRawDataAsDoubleValues	(	const unsigned int &	rawIndex,
		double *	values
	)

Get all the values of a particular raw of the instance which are supposed to be double ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

void DasAcquisition::getRawDataAsFloatValues	(	const unsigned int &	rawIndex,
		float *	values
	)

Get all the values of a particular raw of the instance which are supposed to be float ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

void DasAcquisition::getRawDataAsIntValues	(	const unsigned int &	rawIndex,
		int *	values
	)

Get all the values of a particular raw of the instance which are supposed to be int 32 bits ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

void DasAcquisition::getRawDataAsLongValues	(	const unsigned int &	rawIndex,
		LONG64 *	values
	)

Get all the values of a particular raw of the instance which are supposed to be int 64 bits ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

void DasAcquisition::getRawDataAsShortValues	(	const unsigned int &	rawIndex,
		short *	values
	)

Get all the values of a particular raw of the instance which are supposed to be int 16 bits ones.

Parameters

rawIndex	The index of the raw we want the values from.
values	The array (pointer) of values must be preallocated regarding getRawDataSlowestDimension and getRawDataFastestDimension and their respective count.

gsoap_eml2_1::prodml2__DasDimensions DasAcquisition::getRawDataFastestDimension ( const unsigned int & rawIndex ) const

Get the fastest (generally called second) dimension desription of the raw.

Parameters

rawIndex The index of the raw we want the values from.

resqml2::AbstractValuesProperty::hdfDatatypeEnum DasAcquisition::getRawDataHdfDatatype ( const unsigned int & rawIndex ) const

Get the values datatype in the HDF dataset

gsoap_eml2_1::prodml2__DasDimensions DasAcquisition::getRawDataSlowestDimension ( const unsigned int & rawIndex ) const

Get the slowest (generally called first) dimension desription of the raw.

Parameters

rawIndex The index of the raw we want the values from.

void DasAcquisition::getRawDataTime	(	const unsigned int &	rawIndex,
		LONG64 *	values
	)

Get all the time of a particular raw of the instance.

Parameters

rawIndex The index of the raw we want the values from.

virtual std::string prodml2_0::DasAcquisition::getXmlTag ( ) const

inlinevirtual

Get the XML tag for the XML serialization of this instance

Implements common::AbstractObject.

void DasAcquisition::pushBackRaw	(	const std::string &	guid,
		bool	datatypeIsInteger,
		const char &	datatypeByteCount,
		const std::string &	rawDataUnit,
		LONG64 *	timeArray,
		const ULONG64 &	timeCount,
		common::AbstractHdfProxy *	proxy
	)

Push back a raw das acquisition Initiate the hdf dataset but do not write data in it.

Parameters

guid	The guid for this raw acquisition
datatypeIsInteger	True if the raw data to be written are integers. Fale if they are floating point values.
datatypeByteCount	Count of bytes necessary to represent one single raw data. For example : 2 means short if datatypeIsInteger == true. 4 means float if datatypeIsInteger == false. etc...
rawDataUnit	Data unit for the DAS measurement instrument.
timeArray	Unix timestamps in micro seconds
timeCount	The count of time in time array
proxy	The hdf proxy where the data will be stored.

void DasAcquisition::writeIntoDataset	(	float *	data,
		unsigned long	numSampleForAllLoci,
		unsigned long	timeStepIndex
	)

Parameters

data	The measured data. A linearized array of a 2d one where loci go fastest and time slowest.

The documentation for this class was generated from the following files:

C:/Users/Philippe/dev/fesapiEnv/fesapi/src/prodml2_0/DasAcquisition.h
C:/Users/Philippe/dev/fesapiEnv/fesapi/src/prodml2_0/DasAcquisition.cpp

Public Member Functions

Static Public Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation