OEStructureMetadata

Attention

PRELIMINARY-IMAGE This is a preliminary API until 2020.Oct and may be improved based on user feedback. It is currently available in C++ and Python.

class OEStructureMetadata

This class stores structural information used in design unit preparation within the OEMakeDesignUnits function.

Constructors

OEStructureMetadata()=default
OEStructureMetadata(const OEStructureMetadata &)=default
OEStructureMetadata(const std::vector<OEHeterogenMetadata> &hetData)
OEStructureMetadata(const std::vector<OEHeterogenMetadata> &hetData,
                    const std::vector<OESequenceMetadata> &seqData)

Default, copy, and advanced constructor that constructs an OEStructureMetadata object. The advanced constructor takes a combination of two separate data classes as arguments: a class that stores the structural metadata (OEStructureMetadata), and a class that stores the heterogen metadata (OEHeterogenMetadata). A separate overload that takes a std::vector of each of those data classes is also available.

operator=

OEStructureMetadata &operator=(const OEStructureMetadata &)=default

Assignment operator.

AddHeterogenMetadata

void AddHeterogenMetadata(const OEHeterogenMetadata &hetData)
void AddHeterogenMetadata(const std::vector<OEHeterogenMetadata> &hetData)

Adds the heterogen metadata (OEHeterogenMetadata) as a single object or as a std::vector of objects.

AddKeyword

void AddKeyword(const std::string keyword)

Adds a string keyword.

AddKeywords

void AddKeywords(const std::vector<std::string> keywords)

Adds a std::vector of string keywords.

AddSequenceMetadata

void AddSequenceMetadata(const OESequenceMetadata &seqData)
void AddSequenceMetadata(const std::vector<OESequenceMetadata> &seqData)

Adds the sequence metadata (OESequenceMetadata) as a single object or as a std::vector of objects.

ClearHeterogenMetadata

void ClearHeterogenMetadata()

Clears all heterogen metadata.

ClearKeywords

void ClearKeywords()

Clears all keywords.

ClearSequenceMetadata

void ClearSequenceMetadata()

Clears all sequence metadata.

GetAuthor

std::string GetAuthor() const

Returns the name of the author.

GetExperimentDate

std::string GetExperimentDate() const

Returns the string version of the experiment date.

GetExperimentType

unsigned GetExperimentType() const

Returns the experiment type as defined by the OEExperimentType namespace.

GetHeterogenMetadata

std::vector<OEHeterogenMetadata> &GetHeterogenMetadata()
const std::vector<OEHeterogenMetadata> &GetHeterogenMetadata() const

Returns a reference to the std::vector of stored heterogen metadata (OEHeterogenMetadata) objects.

GetIridiumData

OEBio::OEIridiumData &GetIridiumData()
const OEBio::OEIridiumData &GetIridiumData() const

Returns a reference to the Iridium data (OEIridiumData) object.

GetKeywords

std::vector<std::string> &GetKeywords()
const std::vector<std::string> &GetKeywords() const

Returns a reference to the vector of keyword strings.

GetRevision

std::string GetRevision() const

Returns the revision.

GetRevisionDate

std::string GetRevisionDate() const

Returns the string version of the revision date.

GetSequenceMetadata

std::vector<OESequenceMetadata> &GetSequenceMetadata()
const std::vector<OESequenceMetadata> &GetSequenceMetadata() const

GetStructureID

std::string GetStructureID() const

Returns the structure’s ID.

SetAuthor

void SetAuthor(const std::string author)

Sets the author’s name.

SetExperimentDate

void SetExperimentDate(const std::string exptDate)

Sets the string version of the experiment date.

SetExperimentType

void SetExperimentType(unsigned exprType)

Sets the experiment type as defined by the OEExperimentType namespace.

SetIridiumData

void SetIridiumData(const OEBio::OEIridiumData &iridData)

Sets the Iridium data from an OEIridiumData object.

SetRevision

void SetRevision(const std::string revVersion)

Sets the revision.

SetRevisionDate

void SetRevisionDate(const std::string revDate)

Sets the string version of the revision date.

SetStructureID

void SetStructureID(const std::string structureID)

Sets the string version of the structure’s ID.