OEStructureMetadata

Attention

This API 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() -> OEStructureMetadata
OEStructureMetadata(hetData: OEHeterogenMetadataVector) -> OEStructureMetadata
OEStructureMetadata(hetData: OEHeterogenMetadataVector,
                    seqData: OESequenceMetadataVector) -> OEStructureMetadata
OEStructureMetadata(arg2: OEStructureMetadata) -> OEStructureMetadata

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.

AddHeterogenMetadata

AddHeterogenMetadata(hetData: OEHeterogenMetadataVector) -> None
AddHeterogenMetadata(hetData: OEHeterogenMetadata) -> None

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

AddKeyword

AddKeyword(keyword: str) -> None

Adds a string keyword.

AddKeywords

AddKeywords(keywords: OEStringVector) -> None

Adds a std::vector of string keywords.

AddSequenceMetadata

AddSequenceMetadata(seqData: OESequenceMetadataVector) -> None
AddSequenceMetadata(seqData: OESequenceMetadata) -> None

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

ClearHeterogenMetadata

ClearHeterogenMetadata() -> None

Clears all heterogen metadata.

ClearKeywords

ClearKeywords() -> None

Clears all keywords.

ClearSequenceMetadata

ClearSequenceMetadata() -> None

Clears all sequence metadata.

GetAuthor

GetAuthor() -> str

Returns the name of the author.

GetExperimentDate

GetExperimentDate() -> str

Returns the string version of the experiment date.

GetExperimentType

GetExperimentType() -> int

Returns the experiment type as defined by the OEExperimentType namespace.

GetHeterogenMetadata

GetHeterogenMetadata() -> OEHeterogenMetadataVector

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

GetIridiumData

GetIridiumData() -> OEIridiumData

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

GetKeywords

GetKeywords() -> OEStringVector

Returns a reference to the vector of keyword strings.

GetRevision

GetRevision() -> str

Returns the revision.

GetRevisionDate

GetRevisionDate() -> str

Returns the string version of the revision date.

GetSequenceMetadata

GetSequenceMetadata() -> OESequenceMetadataVector

GetStructureID

GetStructureID() -> str

Returns the structure’s ID.

SetAuthor

SetAuthor(author: str) -> None

Sets the author’s name.

SetExperimentDate

SetExperimentDate(exptDate: str) -> None

Sets the string version of the experiment date.

SetExperimentType

SetExperimentType(exprType: int) -> None

Sets the experiment type as defined by the OEExperimentType namespace.

SetIridiumData

SetIridiumData(iridData: OEIridiumData) -> None

Sets the Iridium data from an OEIridiumData object.

SetRevision

SetRevision(revVersion: str) -> None

Sets the revision.

SetRevisionDate

SetRevisionDate(revDate: str) -> None

Sets the string version of the revision date.

SetStructureID

SetStructureID(structureID: str) -> None

Sets the string version of the structure’s ID.