#include <PolylineRepresentation.h>

Inheritance diagram for resqml2_0_1::PolylineRepresentation:

Public Member Functions
	PolylineRepresentation (gsoap_resqml2_0_1::eml20__DataObjectReference *partialObject)

	PolylineRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, gsoap_eml2_3::resqml22__LineRole roleKind, bool isClosed=false)
	Creates an instance of this class in a gsoap context.

	PolylineRepresentation (common::DataObjectRepository *repo, const std::string &guid, const std::string &title, bool isClosed=false)

	PolylineRepresentation (resqml2::AbstractFeatureInterpretation *interp, const std::string &guid, const std::string &title, bool isClosed=false)
	Creates an instance of this class in a gsoap context.

	PolylineRepresentation (gsoap_resqml2_0_1::_resqml20__PolylineRepresentation *fromGsoap)

	~PolylineRepresentation ()=default

common::DataObjectReference	getHdfProxyDor () const final
	Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const final

void	getXyzPointsOfPatch (unsigned int patchIndex, double *xyzPoints) const final
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

void	setGeometry (double const points, unsigned int pointCount, eml2::AbstractHdfProxy proxy=nullptr, eml2::AbstractLocal3dCrs *localCrs=nullptr) final

bool	isClosed () const final

bool	hasALineRole () const final

gsoap_eml2_3::resqml22__LineRole	getLineRole () const final

void	setLineRole (gsoap_eml2_3::resqml22__LineRole lineRole) final

std::string	getXmlNamespace () const final

Public Member Functions inherited from resqml2::PolylineRepresentation
bool	isASeismicLine () const

bool	isAFaciesLine () const

uint64_t	getPatchCount () const final

virtual std::string	getXmlTag () const final

Public Member Functions inherited from resqml2::AbstractRepresentation
virtual	~AbstractRepresentation ()=default

eml2::AbstractLocal3dCrs *	getLocalCrs (uint64_t patchIndex) const

virtual common::DataObjectReference	getLocalCrsDor (uint64_t patchIndex) const

void	setTimeIndex (uint64_t timeIndex, eml2::TimeSeries *timeSeries)

uint64_t	getTimeIndex () const
	Gets the time index of this representation in the associated TimeSeries. Be sure to first check that a TimeSeries is associated this representation by calling getTimeSeriesDor or getTimeSeries;.

eml2::TimeSeries *	getTimeSeries () const

common::DataObjectReference	getTimeSeriesDor () const
	Gets the data object reference of the TimeSeries containing the time of this representation at a particular index. For now, this method only look for a TimeSeries at the first patch containing a point geometry.

std::vector< class AbstractProperty * >	getPropertySet () const

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

uint64_t	getXyzPointCountOfAllPatches () const

void	getXyzPointsOfPatchInGlobalCrs (unsigned int patchIndex, double *xyzPoints) const
	Gets all the xyz points of a particular patch of this representation. xyz points are given in the global CRS.

void	getXyzPointsOfAllPatches (double *xyzPoints) const
	Gets all the xyz points of all patches of this representation. xyz points are given in the local CRS.

bool	isInSingleLocalCrs () const

bool	isInSingleGlobalCrs () const

void	getXyzPointsOfAllPatchesInGlobalCrs (double *xyzPoints) const

AbstractRepresentation *	getSeismicSupportOfPatch (const unsigned int &patchIndex) const

std::set< AbstractRepresentation * >	getAllSeismicSupport () const

void	pushBackIntoRepresentationSet (class RepresentationSetRepresentation *repSet)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double inlines, double crosslines, uint64_t pointCount, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy proxy)

void	addSeismic3dCoordinatesToPatch (unsigned int patchIndex, double startInline, double incrInline, unsigned int countInline, double startCrossline, double incrCrossline, unsigned int countCrossline, resqml2::AbstractRepresentation *seismicSupport)

void	addSeismic2dCoordinatesToPatch (unsigned int patchIndex, double lineAbscissa, resqml2::AbstractRepresentation seismicSupport, eml2::AbstractHdfProxy *proxy)

void	getSeismicLineAbscissaOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getInlinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

void	getCrosslinesOfPointsOfPatch (unsigned int patchIndex, double *values) const

virtual void	loadTargetRelationships () override

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_NS

Static Public Attributes inherited from resqml2::PolylineRepresentation
static const char *	XML_TAG

Static Public Attributes inherited from resqml2::AbstractRepresentation
static constexpr char const *	XML_TAG = "AbstractRepresentation"

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

A polyline representation.

Constructor & Destructor Documentation

◆ PolylineRepresentation() [1/5]

resqml2_0_1::PolylineRepresentation::PolylineRepresentation ( gsoap_resqml2_0_1::eml20__DataObjectReference * partialObject )

inline

Only to be used in partial transfer context

Parameters

[in,out] partialObject If non-null, the partial object.

◆ PolylineRepresentation() [2/5]

resqml2_0_1::PolylineRepresentation::PolylineRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		gsoap_eml2_3::resqml22__LineRole	roleKind,
		bool	isClosed = false )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If interp == nullptr.

Parameters

[in]	interp	The interpretation which this representation represents.
	guid	The guid to set to the new instance. If empty then a new guid will be generated.
	title	A title for the instance to create.
	roleKind	Indicates the role of this representation.
	isClosed	(Optional) Indicates wether this line representaiton is closed or not.

◆ PolylineRepresentation() [3/5]

resqml2_0_1::PolylineRepresentation::PolylineRepresentation	(	common::DataObjectRepository *	repo,
		const std::string &	guid,
		const std::string &	title,
		bool	isClosed = false )

Creates an instance of this class in a gsoap context.

Parameters

[in,out]	repo	If non-null, the repo.
	guid	The guid to set to the new instance. If empty then a new guid will be generated.
	title	A title for the instance to create.
	isClosed	(Optional) Indicates wether this line representaiton is closed or not.

◆ PolylineRepresentation() [4/5]

resqml2_0_1::PolylineRepresentation::PolylineRepresentation	(	resqml2::AbstractFeatureInterpretation *	interp,
		const std::string &	guid,
		const std::string &	title,
		bool	isClosed = false )

Creates an instance of this class in a gsoap context.

Exceptions

std::invalid_argument If interp == nullptr.

Parameters

[in]	interp	The interpretation which this representation represents.
	guid	The guid to set to the new instance. If empty then a new guid will be generated.
	title	A title for the instance to create.
	isClosed	(Optional) Indicates wether this line representaiton is closed or not.

◆ PolylineRepresentation() [5/5]

resqml2_0_1::PolylineRepresentation::PolylineRepresentation ( gsoap_resqml2_0_1::_resqml20__PolylineRepresentation * fromGsoap )

inline

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

Parameters

[in,out] fromGsoap If non-null, from gsoap.

◆ ~PolylineRepresentation()

resqml2_0_1::PolylineRepresentation::~PolylineRepresentation ( )

virtualdefault

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

Reimplemented from resqml2::PolylineRepresentation.

Member Function Documentation

◆ getHdfProxyDor()

common::DataObjectReference resqml2_0_1::PolylineRepresentation::getHdfProxyDor ( ) const

finalvirtual

Gets the data object reference of the HDF proxy which is used for storing the numerical values of this representation (i.e. its geometry).

Exceptions

std::logic_error If this representation is partial.

Returns: The data object reference of the HDF proxy used for storing the geometry, or empty data object reference if it fails.

Implements resqml2::AbstractRepresentation.

◆ getLineRole()

gsoap_eml2_3::resqml22__LineRole resqml2_0_1::PolylineRepresentation::getLineRole ( ) const

finalvirtual

Gets the line role of this polyline.

Exceptions

std::logic_error If this polyline has no line role (see hasALineRole()).

Returns: The line role.

Implements resqml2::PolylineRepresentation.

◆ getXmlNamespace()

std::string resqml2_0_1::PolylineRepresentation::getXmlNamespace ( ) const

inlinefinalvirtual

Get the standard XML namespace for serializing this data object.

Implements common::AbstractObject.

◆ getXyzPointCountOfPatch()

uint64_t resqml2_0_1::PolylineRepresentation::getXyzPointCountOfPatch ( unsigned int patchIndex ) const

finalvirtual

Get the xyz point count in a given patch of this representation.

Exceptions

std::out_of_range	If `patchIndex` is out of range.
std::logic_error	If this representation is partial.

Parameters

patchIndex Zero-based index of the patch from which we look for the xyz points.

Returns: The xyz point count of the patch at position patchIndex.

Implements resqml2::AbstractRepresentation.

◆ getXyzPointsOfPatch()

void resqml2_0_1::PolylineRepresentation::getXyzPointsOfPatch	(	unsigned int	patchIndex,
		double *	xyzPoints ) const

finalvirtual

Gets all the xyz points of a particular patch of this representation. xyz points are given in the local CRS.

Exceptions

std::out_of_range	If `patchIndex` is out of range.
std::logic_error	If this representation is partial.

Parameters

	patchIndex	Zero-based index of the patch from which we look for the xyz points.
[out]	xyzPoints	A linearized 2d array where the first (quickest) dimension is the coordinate dimension (x, y or z) and second dimension is vertex dimension. It must be preallocated with a size of `3 * getXyzPointCountOfPatch(patchIndex)`.

Implements resqml2::AbstractRepresentation.

◆ hasALineRole()

bool resqml2_0_1::PolylineRepresentation::hasALineRole ( ) const

finalvirtual

Indicates if this polyline is associated to a particular line role.

Returns: True if this polyline has a line role, false if not.

Implements resqml2::PolylineRepresentation.

◆ isClosed()

bool resqml2_0_1::PolylineRepresentation::isClosed ( ) const

finalvirtual

Indicates if this representation is a closed polyline or a non closed polyline. A closed polyline is one in which the first vertex coincides with the last one, or the first and the last vertices are connected by a line segment.

Returns: True if this polyline representation is closed, false if not.

Implements resqml2::PolylineRepresentation.

◆ setGeometry()

void resqml2_0_1::PolylineRepresentation::setGeometry	(	double const *	points,
		unsigned int	pointCount,
		eml2::AbstractHdfProxy *	proxy = nullptr,
		eml2::AbstractLocal3dCrs *	localCrs = nullptr )

finalvirtual

Sets the geometry of this polyline representation.

Exceptions

std::invalid_argument	If `proxy == nullptr` and no default HDF proxy is defined in the repository.
std::invalid_argument	If `localCrs == nullptr` and no default local CRS id defined in the repository.

Parameters

[in]	points	The points which constitute the polyline. Ordered by xyz and then points. Size is `3 * pointCount`.
	pointCount	The count of points in the polyline.
[in,out]	proxy	(Optional) The HDF proxy which defines where the xyz points will be stored. If `nullptr` (default), then the repository default HDF proxy will be used.
[in]	localCrs	(Optional) The local CRS where the points are given. If `nullptr` (default), then the repository default local CRS will be used.

Implements resqml2::PolylineRepresentation.

◆ setLineRole()

void resqml2_0_1::PolylineRepresentation::setLineRole ( gsoap_eml2_3::resqml22__LineRole lineRole )

finalvirtual

Sets the line role of this instance.

Parameters

lineRole The line role.

Implements resqml2::PolylineRepresentation.

Member Data Documentation

◆ XML_NS

const char* resqml2_0_1::PolylineRepresentation::XML_NS

static

The standard XML namespace for serializing this data object.

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

C:/Users/philippe/dev/fesapiEnv/fesapi-2.10.1.0/src/resqml2_0_1/PolylineRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PolylineRepresentation() [1/5]

◆ PolylineRepresentation() [2/5]

◆ PolylineRepresentation() [3/5]

◆ PolylineRepresentation() [4/5]

◆ PolylineRepresentation() [5/5]

◆ ~PolylineRepresentation()

Member Function Documentation

◆ getHdfProxyDor()

◆ getLineRole()

◆ getXmlNamespace()

◆ getXyzPointCountOfPatch()

◆ getXyzPointsOfPatch()

◆ hasALineRole()

◆ isClosed()

◆ setGeometry()

◆ setLineRole()

Member Data Documentation

◆ XML_NS