A representation made up of a single polyline or "polygonal chain", which may be closed or not. See definition here: http://en.wikipedia.org/wiki/Piecewise_linear_curve. More...

#include <PolylineRepresentation.h>

Inheritance diagram for resqml2::PolylineRepresentation:

Public Member Functions
virtual	~PolylineRepresentation ()=default

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

virtual bool	isClosed () const =0

virtual bool	hasALineRole () const =0

bool	isASeismicLine () const

bool	isAFaciesLine () const

virtual gsoap_eml2_3::resqml22__LineRole	getLineRole () const =0

virtual void	setLineRole (gsoap_eml2_3::resqml22__LineRole lineRole)=0

unsigned int	getPatchCount () const final

virtual std::string	getXmlTag () const final

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

class AbstractLocal3dCrs *	getLocalCrs (unsigned int patchIndex) const

virtual common::DataObjectReference	getLocalCrsDor (unsigned int patchIndex) const

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

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

void	setInterpretation (class AbstractFeatureInterpretation *interp)

class AbstractFeatureInterpretation *	getInterpretation () const

common::DataObjectReference	getInterpretationDor () const

virtual uint64_t	getXyzPointCountOfPatch (unsigned int patchIndex) const =0

uint64_t	getXyzPointCountOfAllPatches () const

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

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

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

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, unsigned int 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 ()

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)

void	setGsoapProxy (gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *gsoapProxy)

void	setGsoapProxy (gsoap_eml2_1::eml21__AbstractObject *gsoapProxy)

gsoap_resqml2_0_1::eml20__AbstractCitedDataObject *	getEml20GsoapProxy () const

gsoap_eml2_1::eml21__AbstractObject *	getEml21GsoapProxy () const

gsoap_eml2_2::eml22__AbstractObject *	getEml22GsoapProxy () const

void	setGsoapProxy (gsoap_eml2_2::eml22__AbstractObject *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_1::eml21__DataObjectReference *	newEmlReference () const

gsoap_eml2_2::eml22__DataObjectReference *	newEml22Reference () 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	getXmlNamespace () const =0

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)

unsigned int	getAliasCount () const

std::string	getAliasAuthorityAtIndex (unsigned int index) const

std::string	getAliasTitleAtIndex (unsigned int index) const

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

unsigned int	getActivityCount () const

eml2::Activity *	getActivity (unsigned int 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

Static Public Attributes
static const char *	XML_TAG

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

Additional Inherited Members
Public Types inherited from resqml2::AbstractRepresentation
enum	indexableElement { NODE = 0 , EDGE = 1 , FACE = 2 , VOLUME = 3 , PILLAR = 4 }

Public Types inherited from common::AbstractObject
enum	hdfDatatypeEnum { UNKNOWN = 0 , DOUBLE = 1 , FLOAT = 2 , LONG_64 = 3 , ULONG_64 = 4 , INT = 5 , UINT = 6 , SHORT = 7 , USHORT = 8 , CHAR = 9 , UCHAR = 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 representation made up of a single polyline or "polygonal chain", which may be closed or not. See definition here: http://en.wikipedia.org/wiki/Piecewise_linear_curve.

BUSINESS RULE: To record a polyline the writer software must give the values of the geometry of each node in an order corresponding to the logical series of segments (edges). The geometry of a polyline must be a 1D array of points.

A simple polygonal chain is one in which only consecutive (or the first and the last) segments intersect and only at their endpoints.

Constructor & Destructor Documentation

◆ ~PolylineRepresentation()

virtual resqml2::PolylineRepresentation::~PolylineRepresentation ( )

virtualdefault

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

Reimplemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

Member Function Documentation

◆ getLineRole()

virtual gsoap_eml2_3::resqml22__LineRole resqml2::PolylineRepresentation::getLineRole ( ) const

pure virtual

Gets the line role of this polyline.

Exceptions

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

Returns: The line role.

Implemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

◆ getPatchCount()

unsigned int resqml2::PolylineRepresentation::getPatchCount ( ) const

inlinefinalvirtual

Gets the patch count.

Returns: The patch count.

Implements resqml2::AbstractRepresentation.

◆ getXmlTag()

virtual std::string resqml2::PolylineRepresentation::getXmlTag ( ) const

inlinefinalvirtual

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

Returns: The XML tag.

Implements common::AbstractObject.

◆ hasALineRole()

virtual bool resqml2::PolylineRepresentation::hasALineRole ( ) const

pure virtual

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

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

Implemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

◆ isAFaciesLine()

bool resqml2::PolylineRepresentation::isAFaciesLine ( ) const

Indicates whether this instance corresponds to a facies 2d line or not.

Returns: True if it is a facies line, false if not.

◆ isASeismicLine()

bool resqml2::PolylineRepresentation::isASeismicLine ( ) const

Indicates whether this instance corresponds to a seismic 2d line or not.

Returns: True if is a seismic line, false if not.

◆ isClosed()

virtual bool resqml2::PolylineRepresentation::isClosed ( ) const

pure virtual

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.

Implemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

◆ setGeometry()

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

pure virtual

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.

Implemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

◆ setLineRole()

virtual void resqml2::PolylineRepresentation::setLineRole ( gsoap_eml2_3::resqml22__LineRole lineRole )

pure virtual

Sets the line role of this instance.

Parameters

lineRole The line role.

Implemented in resqml2_2::PolylineRepresentation, and resqml2_0_1::PolylineRepresentation.

Member Data Documentation

◆ XML_TAG

const char* resqml2::PolylineRepresentation::XML_TAG

static

The standard XML tag without 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.0.0.0/src/resqml2/PolylineRepresentation.h

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~PolylineRepresentation()

Member Function Documentation

◆ getLineRole()

◆ getPatchCount()

◆ getXmlTag()

◆ hasALineRole()

◆ isAFaciesLine()

◆ isASeismicLine()

◆ isClosed()

◆ setGeometry()

◆ setLineRole()

Member Data Documentation

◆ XML_TAG