Inherits IDataFileIO.
Inherited by H5MXARequiredMetaData, and RequiredMetaData.
Inheritance diagram for IRequiredMetaData:
Public Member Functions | |
IRequiredMetaData () | |
virtual | ~IRequiredMetaData () |
virtual void | setAll (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile)=0 |
Sets all the required meta data objects. | |
virtual void | setResearcherName (const std::string &researcherName)=0 |
Sets the Researcher's name or who is generating the data set. | |
virtual std::string | getResearcherName ()=0 |
Returns the Researcher name value. | |
virtual void | setDateTimeCreated (const std::string &dateTime)=0 |
Sets the date and time the data set was created. The preferable format for the date time is "yyyy/MM/dd HH:mm:ss". | |
virtual std::string | getDateTimeCreated ()=0 |
Returns the date/time the dataset was created. | |
virtual void | setDatasetName (const std::string &datasetName)=0 |
Provides a descriptive name for the dataset. | |
virtual std::string | getDatasetName ()=0 |
Returns the name given to the data set. | |
virtual void | setDescription (const std::string &description)=0 |
Provides a description for the data in the data file. | |
virtual std::string | getDescription ()=0 |
Returns the description of the dataset. | |
virtual void | setDistributionRights (const std::string &distributionRights)=0 |
Sets the Distribution rights for the data and should be either "Unlimited" or "Limited". | |
virtual std::string | getDistributionRights ()=0 |
Returns the distribution rights of the dataset. | |
virtual void | setReleaseNumber (const std::string &releaseNumber)=0 |
Sets the release number or other tracking number/code that is used to track the dataset. | |
virtual std::string | getReleaseNumber ()=0 |
Returns the Release number or tracking number for the dataset. | |
virtual void | setPedigree (const std::string &pedigree)=0 |
Sets the Pedigree of the data which is either one of "Derived" or "Original". | |
virtual std::string | getPedigree ()=0 |
Returns the pedigree of the dataset and is either "Derived" or "Original". | |
virtual void | setDerivedSourceFile (const std::string &derivedSourceFile)=0 |
Sets the Derived Source file meta data. Use "Not Applicable" if that is appropriate to your data set. | |
virtual std::string | getDerivedSourceFile ()=0 |
Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used. | |
virtual int32 | setValueForKey (const std::string &key, const std::string &value)=0 |
Sets the value for a given meta data key. | |
virtual std::string | getValueForKey (const std::string &key)=0 |
Returns the value for a given key. | |
virtual bool | isValid (std::string message)=0 |
Validates the Required Meta Data. | |
virtual void | printSelf (std::ostream &os, int32 indent)=0 |
prints a debugging type diagnostic description of the contents of this class | |
virtual void | generateKeyValueMap (std::map< std::string, std::string > &mdMap)=0 |
Generates a std::map of the meta data key to its associated value. | |
Private Member Functions | |
IRequiredMetaData (const IRequiredMetaData &) | |
void | operator= (const IRequiredMetaData &) |
IRequiredMetaData::IRequiredMetaData | ( | ) | [inline] |
virtual IRequiredMetaData::~IRequiredMetaData | ( | ) | [inline, virtual] |
IRequiredMetaData::IRequiredMetaData | ( | const IRequiredMetaData & | ) | [private] |
virtual void IRequiredMetaData::setAll | ( | std::string | researcherName, | |
std::string | dateCreated, | |||
std::string | datasetName, | |||
std::string | description, | |||
std::string | distributionRights, | |||
std::string | releaseNumber, | |||
std::string | pedigree, | |||
std::string | derivedSrcFile | |||
) | [pure virtual] |
Sets all the required meta data objects.
researcherName | The name of the researcher | |
dateCreated | The date the data was created | |
datasetName | The name of the dataset or experiment | |
description | A short description of the experiment | |
distributionRights | How is the data to be distributed. | |
releaseNumber | If the data is publicly releasable was there a tracking number for the release | |
pedigree | More detailed information about the data/experiment | |
derivedSrcFile | Did the data come from a data file |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setResearcherName | ( | const std::string & | researcherName | ) | [pure virtual] |
Sets the Researcher's name or who is generating the data set.
researcherName |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getResearcherName | ( | ) | [pure virtual] |
Returns the Researcher name value.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setDateTimeCreated | ( | const std::string & | dateTime | ) | [pure virtual] |
Sets the date and time the data set was created. The preferable format for the date time is "yyyy/MM/dd HH:mm:ss".
dateTime |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getDateTimeCreated | ( | ) | [pure virtual] |
Returns the date/time the dataset was created.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setDatasetName | ( | const std::string & | datasetName | ) | [pure virtual] |
Provides a descriptive name for the dataset.
datasetName | The name of the dataset |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getDatasetName | ( | ) | [pure virtual] |
Returns the name given to the data set.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setDescription | ( | const std::string & | description | ) | [pure virtual] |
Provides a description for the data in the data file.
description | The description of the data |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getDescription | ( | ) | [pure virtual] |
Returns the description of the dataset.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setDistributionRights | ( | const std::string & | distributionRights | ) | [pure virtual] |
Sets the Distribution rights for the data and should be either "Unlimited" or "Limited".
distributionRights | The distribution Rights for the dataset. |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getDistributionRights | ( | ) | [pure virtual] |
Returns the distribution rights of the dataset.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setReleaseNumber | ( | const std::string & | releaseNumber | ) | [pure virtual] |
Sets the release number or other tracking number/code that is used to track the dataset.
releaseNumber | The release number/code or "Not Applicable" |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getReleaseNumber | ( | ) | [pure virtual] |
Returns the Release number or tracking number for the dataset.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setPedigree | ( | const std::string & | pedigree | ) | [pure virtual] |
Sets the Pedigree of the data which is either one of "Derived" or "Original".
pedigree | The pedigree of the data |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getPedigree | ( | ) | [pure virtual] |
Returns the pedigree of the dataset and is either "Derived" or "Original".
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::setDerivedSourceFile | ( | const std::string & | derivedSourceFile | ) | [pure virtual] |
Sets the Derived Source file meta data. Use "Not Applicable" if that is appropriate to your data set.
derivedSourceFile | Value of the Derived Source File |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getDerivedSourceFile | ( | ) | [pure virtual] |
Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used.
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual int32 IRequiredMetaData::setValueForKey | ( | const std::string & | key, | |
const std::string & | value | |||
) | [pure virtual] |
Sets the value for a given meta data key.
key | The meta data key to set | |
value | The value of meta data to set |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual std::string IRequiredMetaData::getValueForKey | ( | const std::string & | key | ) | [pure virtual] |
Returns the value for a given key.
key | The key to retrieve the value for |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual bool IRequiredMetaData::isValid | ( | std::string | message | ) | [pure virtual] |
Validates the Required Meta Data.
message | A std::string to store error messages |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::printSelf | ( | std::ostream & | os, | |
int32 | indent | |||
) | [pure virtual] |
prints a debugging type diagnostic description of the contents of this class
os | An output stream to write to. | |
indent | The number of spaces to use for indentation |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
virtual void IRequiredMetaData::generateKeyValueMap | ( | std::map< std::string, std::string > & | mdMap | ) | [pure virtual] |
Generates a std::map of the meta data key to its associated value.
mdMap | The map to store the values into. |
Implemented in RequiredMetaData, and H5MXARequiredMetaData.
void IRequiredMetaData::operator= | ( | const IRequiredMetaData & | ) | [private] |