witsml2_1::ChannelSet Class Reference

#include <ChannelSet.h>

Inheritance diagram for witsml2_1::ChannelSet:

Public Member Functions
	ChannelSet (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelSet (common ::DataObjectRepository *repo, const std::string &guid, const std::string &title, bool isActive)
	ChannelSet (gsoap_eml2_3::witsml21__ChannelSet *fromGsoap)
	~ChannelSet ()=default
void	pushBackChannelIndex (gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string &mnemonic, bool isIncreasing=true) final
void	pushBackChannel (class Channel *channel)
void	setDataAsJsonArray (const std::string &jsonArray)
void	setDataAsFileUri (const std::string &fileUri)
bool	hasDataAsJsonArray () const
bool	hasDataAsFileUri () const
const std::string &	getDataAsJsonArray () const
const std::string &	getDataAsFileUri () const
std::vector< class Log * >	getLogs () const
std::vector< class Channel * >	getChannels () const
virtual std::string	getXmlTag () const
void	loadTargetRelationships () final
std::string	getXmlNamespace () const final
Public Member Functions inherited from witsml2_1::ChannelIndexDataObject< gsoap_eml2_3::witsml21__ChannelSet >
	ChannelIndexDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelIndexDataObject ()
	ChannelIndexDataObject (gsoap_eml2_3::eml23__AbstractObject *fromGsoap)
virtual	~ChannelIndexDataObject ()=default
unsigned int	getChannelIndexCount () const
gsoap_eml2_3::eml23__DataIndexKind	getChannelIndexKind (unsigned int index)
std::string	getChannelIndexUom (unsigned int index)
bool	getChannelIndexIsIncreasing (unsigned int index)
std::string	getChannelIndexMnemonic (unsigned int index)
Public Member Functions inherited from witsml2_1::ChannelMetaDataObject< T >
	ChannelMetaDataObject (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)
	ChannelMetaDataObject ()
	ChannelMetaDataObject (gsoap_eml2_3::eml23__AbstractObject *fromGsoap)
virtual	~ChannelMetaDataObject ()=default
common::DataObjectReference	getWellboreDor () const final
	Gets wellbore dor.
void	setWellbore (WITSML2_NS::Wellbore *witsmlWellbore) final
Public Member Functions inherited from WITSML2_NS::WellboreObject
virtual	~WellboreObject ()=default
Wellbore *	getWellbore () const

Static Public Attributes
static const char *	XML_TAG
static constexpr char const *	XML_NS = "witsml21"

Detailed Description

Grouping of Channels with a compatible index for some purpose. By compatible index, we simply mean that all of the Channels are either in time or in depth using a common datum

Constructor & Destructor Documentation

ChannelSet() [1/3]

witsml2_1::ChannelSet::ChannelSet ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Constructor for partial transfer

Parameters

[in,out]

partialObject

If non-null, the partial object.

ChannelSet() [2/3]

witsml2_1::ChannelSet::ChannelSet	(	common ::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		bool	isActive )

Constructor

Parameters

[in,out]	repo	If non-null, the repo.
	guid	Unique identifier.
	title	The title.
	isActive	True if is active, false if not.

ChannelSet() [3/3]

witsml2_1::ChannelSet::ChannelSet ( gsoap_eml2_3::witsml21__ChannelSet * fromGsoap )

inline

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

Parameters

[in,out]

fromGsoap

If non-null, from gsoap.

~ChannelSet()

witsml2_1::ChannelSet::~ChannelSet ( )

default

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

Member Function Documentation

getChannels()

std::vector< class Channel * > witsml2_1::ChannelSet::getChannels

(

)

const

Gets the channels

Returns

Null if it fails, else the channels.

getDataAsFileUri()

const std::string & witsml2_1::ChannelSet::getDataAsFileUri

(

)

const

Gets data as file URI

Returns

The data as file URI.

getDataAsJsonArray()

const std::string & witsml2_1::ChannelSet::getDataAsJsonArray

(

)

const

Gets data as JSON array

Returns

The data as JSON array.

getLogs()

std::vector< class Log * > witsml2_1::ChannelSet::getLogs

(

)

const

Gets the logs

Returns

Null if it fails, else the logs.

getXmlNamespace()

std::string witsml2_1::ChannelSet::getXmlNamespace ( ) const

inlinefinal

Get the standard XML namespace for serializing this data object.

getXmlTag()

virtual std::string witsml2_1::ChannelSet::getXmlTag ( ) const

inlinevirtual

Get the standard XML tag without XML namespace for serializing this data object.

Returns

The XML tag.

hasDataAsFileUri()

bool witsml2_1::ChannelSet::hasDataAsFileUri

(

)

const

Query if this object has data as file URI

Returns

True if data as file uri, false if not.

hasDataAsJsonArray()

bool witsml2_1::ChannelSet::hasDataAsJsonArray

(

)

const

Query if this object has data as JSON array

Returns

True if data as JSON array, false if not.

loadTargetRelationships()

void witsml2_1::ChannelSet::loadTargetRelationships ( )

finalvirtual

Loads target relationships

Reimplemented from WITSML2_NS::WellboreObject.

pushBackChannel()

void witsml2_1::ChannelSet::pushBackChannel

(

class Channel *

channel

)

Pushes a back channel

Parameters

[in,out]

channel

If non-null, the channel.

pushBackChannelIndex()

void witsml2_1::ChannelSet::pushBackChannelIndex ( gsoap_eml2_3::eml23__DataIndexKind indexKind, gsoap_eml2_3::eml23__UnitOfMeasure uom, const std::string & mnemonic, bool isIncreasing = true )

finalvirtual

Pushes a back channel index

Parameters

indexKind	Kind of the index.
uom	The uom.
mnemonic	The mnemonic.
isIncreasing	(Optional) True if is increasing, false if not.
datum	(Optional) The datum.

Implements witsml2_1::ChannelIndexDataObject< gsoap_eml2_3::witsml21__ChannelSet >.

setDataAsFileUri()

void witsml2_1::ChannelSet::setDataAsFileUri

(

const std::string &

fileUri

)

Sets data as file URI

Parameters

fileUri

URI of the file.

setDataAsJsonArray()

void witsml2_1::ChannelSet::setDataAsJsonArray

(

const std::string &

jsonArray

)

Sets data as JSON array

Parameters

jsonArray

Array of jsons.

Member Data Documentation

XML_NS

constexpr char const* witsml2_1::ChannelSet::XML_NS = "witsml21"

staticconstexpr

The standard XML namespace for serializing this data object.

XML_TAG

const char* witsml2_1::ChannelSet::XML_TAG

static

The standard XML tag without XML namespace for serializing this data object.

Returns

The XML tag.

---

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

• C:/Users/philippe/dev/fesapiEnv/fesapi-2.9.0.1/src/witsml2_1/ChannelSet.h