#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< gsoap_eml2_3::witsml21__ChannelSet >
	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

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

virtual bool	isTopLevelElement () const

std::string	getUuid () const

std::string	getTitle () const

std::string	getEditor () const

time_t	getCreation () const

tm	getCreationAsTimeStructure () const

std::string	getOriginator () const

std::string	getDescription () const

time_t	getLastUpdate () const

tm	getLastUpdateAsTimeStructure () const

std::string	getFormat () const

std::string	getDescriptiveKeywords () const

std::string	getVersion () const

void	setTitle (const std::string &title)

void	setEditor (const std::string &editor)

void	setCreation (time_t creation)

void	setCreation (const tm &creation)

void	setOriginator (const std::string &originator)

void	setDescription (const std::string &description)

void	setLastUpdate (time_t lastUpdate)

void	setLastUpdate (const tm &lastUpdate)

void	setDescriptiveKeywords (const std::string &descriptiveKeywords)

void	setVersion (const std::string &version)

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

void	serializeIntoStream (std::ostream *stream)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

gsoap_eml2_3::eml23__AbstractObject *	getEml23GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_3::eml23__AbstractObject *gsoapProxy)

soap *	getGsoapContext () const

int	getGsoapType () const

gsoap_resqml2_0_1::eml20__DataObjectReference *	newResqmlReference () const

gsoap_eml2_3::eml23__DataObjectReference *	newEml23Reference () const

gsoap_resqml2_0_1::resqml20__ContactElementReference *	newContactElementReference2_0_1 () const

gsoap_eml2_3::resqml22__ContactElement *	newContactElementReference2_2 () const

common::DataObjectRepository *	getRepository () const

virtual std::string	getXmlNamespaceVersion () const

virtual std::string	getContentType () const

virtual std::string	getQualifiedType () const

virtual std::string	getPartNameInEpcDocument () const

std::string	serializeIntoString ()

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

uint64_t	getAliasCount () const

std::string	getAliasAuthorityAtIndex (uint64_t index) const

std::string	getAliasTitleAtIndex (uint64_t index) const

std::vector< eml2::Activity * >	getActivitySet () const

uint64_t	getActivityCount () const

eml2::Activity *	getActivity (uint64_t index) const

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

std::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 (unsigned int index) const

std::string	getExtraMetadataStringValueAtIndex (unsigned int index) const

std::string	buildEtp12Uri () const

void	setUriSource (const std::string &uriSource)

const std::string &	getUriSource () const

std::string	getEpcSourceFolder () const

void	changeToPartialObject ()

Static Public Attributes
static const char *	XML_TAG

static constexpr char const *	XML_NS = "witsml21"

Additional Inherited Members
Public Types inherited from common::AbstractObject
enum class	numericalDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , INT64 = 3 , UINT64 = 4 , INT32 = 5 , UINT32 = 6 , INT16 = 7 , UINT16 = 8 , INT8 = 9 , UINT8 = 10 }

Static Public Member Functions inherited from common::AbstractObject
static void	setFormat (const std::string &vendor, const std::string &applicationName, const std::string &applicationVersionNumber)

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

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ 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.

Implements common::AbstractObject.

◆ 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

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.10.1.0/src/witsml2_1/ChannelSet.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ChannelSet() [1/3]

◆ ChannelSet() [2/3]

◆ ChannelSet() [3/3]

◆ ~ChannelSet()

Member Function Documentation

◆ getChannels()

◆ getDataAsFileUri()

◆ getDataAsJsonArray()

◆ getLogs()

◆ getXmlNamespace()

◆ getXmlTag()

◆ hasDataAsFileUri()

◆ hasDataAsJsonArray()

◆ loadTargetRelationships()

◆ pushBackChannel()

◆ pushBackChannelIndex()

◆ setDataAsFileUri()

◆ setDataAsJsonArray()

Member Data Documentation

◆ XML_NS

◆ XML_TAG