My Project
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Friends | List of all members
resqml2::AbstractObject Class Referenceabstract
Inheritance diagram for resqml2::AbstractObject:
resqml2::AbstractFeature resqml2::AbstractFeatureInterpretation resqml2::AbstractLocal3dCrs resqml2::AbstractProperty resqml2::AbstractRepresentation resqml2::Activity resqml2::ActivityTemplate resqml2::EpcExternalPartReference resqml2::MdDatum resqml2::PropertyKind resqml2::TimeSeries resqml2_0_1::StratigraphicColumn resqml2_0_1::StringTableLookup resqml2_0_1::WellboreMarker

Public Member Functions

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::eml__AbstractCitedDataObject * getGsoapProxy () const
 
soap * getGsoapContext () const
 
int getGsoapType () const
 
gsoap_resqml2_0_1::eml__DataObjectReference * newResqmlReference () const
 
gsoap_resqml2_0_1::resqml2__ContactElementReference * newResqmlContactElementReference () const
 
common::EpcDocument * getEpcDocument () const
 
virtual std::string getXmlNamespace () const
 
virtual std::string getXmlTag () const =0
 
virtual std::string getResqmlVersion () const
 
std::string getContentType () const
 
std::string getPartNameInEpcDocument () 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
 
void addOrSetExtraMetadata (const std::string &key, const std::string &value)
 
std::tr1::unordered_map< std::string, std::string > getExtraMetadataSet () const
 
std::string getExtraMetadata (const std::string &key)
 
unsigned int getExtraMetadataCount () const
 
std::string getExtraMetadataKeyAtIndex (const unsigned int &index) const
 
std::string getExtraMetadataStringValueAtIndex (const unsigned int &index) const
 

Protected Member Functions

 AbstractObject (common::EpcDocument *epcDoc, gsoap_resqml2_0_1::eml__DataObjectReference *partialObject)
 Indicate whether methods update the XML (gSoap) or only the C++ classes of the API. More...
 
 AbstractObject (gsoap_resqml2_0_1::eml__AbstractCitedDataObject *proxy=nullptr)
 
void initMandatoryMetadata ()
 
virtual void importRelationshipSetFromEpc (common::EpcDocument *epcDoc)=0
 
virtual std::vector< epc::Relationship > getAllEpcRelationships () const =0
 
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)
 

Static Protected Member Functions

static void addActivityToResqmlObject (resqml2::Activity *activity, AbstractObject *resqmlObject)
 

Protected Attributes

gsoap_resqml2_0_1::eml__AbstractCitedDataObject * gsoapProxy2_0_1
 
common::EpcDocument * epcDocument
 
std::vector< resqml2::Activity * > activitySet
 
bool updateXml
 

Friends

void common::EpcDocument::addGsoapProxy (AbstractObject *proxy)
 
void common::EpcDocument::updateAllRelationships ()
 
void common::EpcDocument::serialize (bool useZip64)
 

Constructor & Destructor Documentation

AbstractObject::AbstractObject ( common::EpcDocument *  epcDoc,
gsoap_resqml2_0_1::eml__DataObjectReference *  partialObject 
)
protected

Indicate whether methods update the XML (gSoap) or only the C++ classes of the API.

Constructor for partial transfer

Only for partial transfer

Member Function Documentation

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

Add an alias for this object

void AbstractObject::addOrSetExtraMetadata ( const std::string &  key,
const std::string &  value 
)

Add or set (if already exists) an extra metadata (not a standard one)

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

Get all the activities where the instance is involved.

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

Get the alias authority at a particular index in the aliases set.

unsigned int AbstractObject::getAliasCount ( ) const

Get the count of aliases in the instance.

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

Get the alias title at a particular index in the aliases set.

virtual std::vector<epc::Relationship> resqml2::AbstractObject::getAllEpcRelationships ( ) const
protectedpure virtual

Return all relationships (backward and forward ones) of the instance using EPC format.

Implemented in resqml2::AbstractGridRepresentation, resqml2::AbstractRepresentation, resqml2_0_1::WellboreTrajectoryRepresentation, resqml2::AbstractProperty, resqml2::AbstractLocal3dCrs, resqml2_0_1::PolylineRepresentation, resqml2_0_1::WellboreFrameRepresentation, resqml2_0_1::CategoricalProperty, resqml2::PropertyKind, resqml2::AbstractFeatureInterpretation, resqml2::Activity, resqml2_0_1::StringTableLookup, resqml2::MdDatum, resqml2::RepresentationSetRepresentation, resqml2_0_1::WellboreMarkerFrameRepresentation, resqml2_0_1::AbstractSurfaceRepresentation, resqml2::TimeSeries, resqml2::AbstractFeature, resqml2_0_1::WellboreFeature, resqml2_0_1::BoundaryFeatureInterpretation, resqml2::AbstractColumnLayerGridRepresentation, resqml2::EpcExternalPartReference, and resqml2_0_1::AbstractStratigraphicOrganizationInterpretation.

string AbstractObject::getContentType ( ) const

Get the content type of the instance according to EPC recommendation

common::EpcDocument* resqml2::AbstractObject::getEpcDocument ( ) const
inline

Return the EPC document which contains this gsoap wrapper.

std::string AbstractObject::getExtraMetadata ( const std::string &  key)

Get an extra metadata according its key.

Returns
An empty string if the extra metadata does not exist. Or the extra metadata value if it exists
unsigned int AbstractObject::getExtraMetadataCount ( ) const

Get the count of extra metadata in the instance.

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

Get the key of a string value pair at a particular index in the extra metadata set

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

Getter (in read only mode) of all the extra metadata

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

Get the string value of a string value pair at a particular index in the extra metadata set

soap * AbstractObject::getGsoapContext ( ) const

Get the gsoap context where the underlying gsoap proxy is defined.

gsoap_resqml2_0_1::eml__AbstractCitedDataObject* resqml2::AbstractObject::getGsoapProxy ( ) const
inline

Get the gsoap proxy which is wrapped by this entity

int AbstractObject::getGsoapType ( ) const

Get the Gsoap type of the wrapped element

std::string AbstractObject::getPartNameInEpcDocument ( ) const

Get part name of this XML top level instance in the EPC document

std::string AbstractObject::getResqmlVersion ( ) const
virtual

Get the XML tag for the XML serialization of this instance

Reimplemented in resqml2_0_1::Activity, resqml2_0_1::ActivityTemplate, resqml2_0_1::CategoricalPropertySeries, resqml2_0_1::ContinuousPropertySeries, and resqml2_0_1::DiscretePropertySeries.

std::string AbstractObject::getXmlNamespace ( ) const
virtual

Get the XML namespace for the tags for the XML serialization of this instance

virtual std::string resqml2::AbstractObject::getXmlTag ( ) const
pure virtual

Get the XML tag for the XML serialization of this instance

Implemented in resqml2_0_1::UnstructuredGridRepresentation, resqml2_0_1::AbstractIjkGridRepresentation, resqml2_0_1::LocalTime3dCrs, resqml2_0_1::WellboreFrameRepresentation, resqml2_0_1::LocalDepth3dCrs, resqml2_0_1::StratigraphicColumnRankInterpretation, resqml2_0_1::SealedSurfaceFrameworkRepresentation, resqml2_0_1::PolylineRepresentation, resqml2_0_1::ContinuousProperty, resqml2_0_1::TriangulatedSetRepresentation, resqml2::Activity, resqml2_0_1::ActivityTemplate, resqml2::PropertyKind, resqml2_0_1::WellboreMarker, resqml2_0_1::WellboreMarkerFrameRepresentation, resqml2_0_1::PolylineSetRepresentation, resqml2_0_1::SeismicLatticeFeature, resqml2::ActivityTemplate, resqml2_0_1::CategoricalPropertySeries, resqml2_0_1::ContinuousPropertySeries, resqml2_0_1::SeismicLineFeature, resqml2_0_1::DiscretePropertySeries, resqml2_0_1::NonSealedSurfaceFrameworkRepresentation, resqml2_0_1::CategoricalProperty, resqml2_0_1::DiscreteProperty, resqml2_0_1::StratigraphicOccurrenceInterpretation, resqml2_0_1::CommentProperty, resqml2_0_1::Grid2dRepresentation, resqml2_0_1::WellboreTrajectoryRepresentation, resqml2_0_1::FaultInterpretation, resqml2_0_1::GeneticBoundaryFeature, resqml2_0_1::HorizonInterpretation, resqml2_0_1::StratigraphicColumn, resqml2_0_1::StratigraphicUnitInterpretation, resqml2_0_1::WellboreInterpretation, resqml2_0_1::BlockedWellboreRepresentation, resqml2_0_1::WellboreFeature, resqml2::GridConnectionSetRepresentation, resqml2_0_1::EarthModelInterpretation, resqml2::RepresentationSetRepresentation, resqml2_0_1::PlaneSetRepresentation, resqml2_0_1::PointSetRepresentation, resqml2_0_1::BoundaryFeatureInterpretation, resqml2::SubRepresentation, resqml2_0_1::StringTableLookup, resqml2::MdDatum, resqml2::TimeSeries, resqml2_0_1::FluidBoundaryFeature, resqml2_0_1::Grid2dSetRepresentation, resqml2_0_1::StructuralOrganizationInterpretation, resqml2_0_1::TectonicBoundaryFeature, resqml2_0_1::OrganizationFeature, resqml2_0_1::FrontierFeature, resqml2_0_1::SeismicLineSetFeature, resqml2_0_1::StratigraphicUnitFeature, resqml2::EpcExternalPartReference, resqml2_0_1::BoundaryFeature, resqml2_0_1::GeologicUnitFeature, and resqml2_0_1::GenericFeatureInterpretation.

virtual void resqml2::AbstractObject::importRelationshipSetFromEpc ( common::EpcDocument *  epcDoc)
protectedpure virtual

Resolve all relationships of the object in an epc document

Implemented in resqml2::AbstractGridRepresentation, resqml2::AbstractRepresentation, resqml2_0_1::WellboreTrajectoryRepresentation, resqml2::AbstractProperty, resqml2::AbstractLocal3dCrs, resqml2_0_1::WellboreFrameRepresentation, resqml2_0_1::CategoricalProperty, resqml2::PropertyKind, resqml2::AbstractFeatureInterpretation, resqml2_0_1::StringTableLookup, resqml2::MdDatum, resqml2::RepresentationSetRepresentation, resqml2_0_1::WellboreMarkerFrameRepresentation, resqml2_0_1::AbstractSurfaceRepresentation, resqml2::TimeSeries, resqml2_0_1::CategoricalPropertySeries, resqml2_0_1::ContinuousPropertySeries, resqml2_0_1::DiscretePropertySeries, resqml2::AbstractFeature, resqml2_0_1::WellboreFeature, resqml2::EpcExternalPartReference, and resqml2::AbstractColumnLayerGridRepresentation.

bool resqml2::AbstractObject::isPartial ( ) const
inline

Indicate if the instance is actually a partial object. A partial object just contains a mime type, an uuid and a title as a minimum amount of information. A partial object is never explicit in an EPC document : it is not a file.

void resqml2::AbstractObject::serializeIntoStream ( std::ostream *  stream)

Serialize the instance into a stream.

Parameters
streamThe stream must be opened for writing and won't be closed.
string AbstractObject::serializeIntoString ( )

Serialize the gsoap proxy into a string

void AbstractObject::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 
)
protected

It is too dangerous for now to modify the uuid because too much things depend on it. That's why this method is only portected : it is only used by derived class constructor. Set a title and other common metadata for the resqml instance. Set to empty string or zero if you don't want to use.

Parameters
titleThe title to set to the resqml instance. Set to empty string if you don't want to set it.
void AbstractObject::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 
)

Set a title and other common metadata for the resqml instance. Set to empty string or zero if you don't want to use.

Parameters
titleThe title to set to the resqml instance. Set to empty string if you don't want to set it.
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.11