Inherits IRequiredMetaData.
Inheritance diagram for RequiredMetaData:
Public Member Functions | |
virtual | ~RequiredMetaData () |
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) |
Sets all the required meta data. | |
void | setResearcherName (const std::string &researcherName) |
Sets the Researcher's name or who is generating the data set. | |
std::string | getResearcherName () |
Returns the Researcher name value. | |
void | setDateTimeCreated (const std::string &dateTime) |
Sets the date and time the data set was created. The preferable format for the date time is "yyyy/MM/dd HH:mm:ss". | |
std::string | getDateTimeCreated () |
Returns the date/time the dataset was created. | |
void | setDatasetName (const std::string &datasetName) |
Provides a descriptive name for the dataset. | |
std::string | getDatasetName () |
Returns the name given to the data set. | |
void | setDescription (const std::string &description) |
Provides a description for the data in the data file. | |
std::string | getDescription () |
Returns the description of the dataset. | |
void | setDistributionRights (const std::string &distributionRights) |
Sets the Distribution rights for the data and should be either "Unlimited" or "Limited". | |
std::string | getDistributionRights () |
Returns the distribution rights of the dataset. | |
void | setReleaseNumber (const std::string &releaseNumber) |
Sets the release number or other tracking number/code that is used to track the dataset. | |
std::string | getReleaseNumber () |
Returns the Release number or tracking number for the dataset. | |
void | setPedigree (const std::string &pedigree) |
Sets the Pedigree of the data which is either one of "Derived" or "Original". | |
std::string | getPedigree () |
Returns the pedigree of the dataset and is either "Derived" or "Original". | |
void | setDerivedSourceFile (const std::string &derivedSourceFile) |
Sets the Derived Source file meta data. Use "Not Applicable" if that is appropriate to your data set. | |
std::string | getDerivedSourceFile () |
Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used. | |
int32 | setValueForKey (const std::string &key, const std::string &value) |
Sets the value for a given meta data key. | |
std::string | getValueForKey (const std::string &key) |
Returns the value for a given key. | |
int32 | writeToFile (IDataFile::Pointer dataFile) |
int32 | readFromFile (IDataFile::Pointer dataFile) |
bool | isValid (std::string message) |
Validates the Required Meta Data. | |
void | printSelf (std::ostream &os, int32 indent) |
prints a debugging type diagnostic description of the contents of this class | |
void | generateKeyValueMap (std::map< std::string, std::string > &mdMap) |
Generates a std::map of the meta data key to its associated value. | |
Static Public Member Functions | |
static IRequiredMetaData::Pointer | New (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile) |
Static method to create a new IRequiredMetaData object that is wrapped in a Boost Shared Pointer. | |
static IRequiredMetaData::Pointer | New (IRequiredMetaData::Pointer md) |
Creates a copy of the object from another object. | |
static IRequiredMetaData::Pointer | DefaultMetaData () |
Creates a new IRequiredMetaData::Pointer object that has all empty values. Note that this will make it INVALID. You are required to fill in the appropriate values to make it valid. This is provided as a convenience. | |
Protected Member Functions | |
RequiredMetaData (std::string researcherName, std::string dateCreated, std::string datasetName, std::string description, std::string distributionRights, std::string releaseNumber, std::string pedigree, std::string derivedSrcFile) | |
Private Member Functions | |
MXA_SHARED_POINTERS (RequiredMetaData) | |
MXA_TYPE_MACRO (RequiredMetaData) | |
RequiredMetaData (const RequiredMetaData &) | |
void | operator= (const RequiredMetaData &) |
Private Attributes | |
std::string | _researcherName |
std::string | _dateCreated |
std::string | _datasetName |
std::string | _description |
std::string | _distributionRights |
std::string | _releaseNumber |
std::string | _pedigree |
std::string | _derivedSrcFile |
RequiredMetaData::~RequiredMetaData | ( | ) | [virtual] |
RequiredMetaData::RequiredMetaData | ( | std::string | researcherName, | |
std::string | dateCreated, | |||
std::string | datasetName, | |||
std::string | description, | |||
std::string | distributionRights, | |||
std::string | releaseNumber, | |||
std::string | pedigree, | |||
std::string | derivedSrcFile | |||
) | [protected] |
RequiredMetaData::RequiredMetaData | ( | const RequiredMetaData & | ) | [private] |
RequiredMetaData::MXA_SHARED_POINTERS | ( | RequiredMetaData | ) | [private] |
RequiredMetaData::MXA_TYPE_MACRO | ( | RequiredMetaData | ) | [private] |
IRequiredMetaData::Pointer RequiredMetaData::New | ( | std::string | researcherName, | |
std::string | dateCreated, | |||
std::string | datasetName, | |||
std::string | description, | |||
std::string | distributionRights, | |||
std::string | releaseNumber, | |||
std::string | pedigree, | |||
std::string | derivedSrcFile | |||
) | [static] |
Static method to create a new IRequiredMetaData object that is wrapped in a Boost Shared Pointer.
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 |
IRequiredMetaData::Pointer RequiredMetaData::New | ( | IRequiredMetaData::Pointer | md | ) | [static] |
Creates a copy of the object from another object.
md | The object to make a copy from |
IRequiredMetaData::Pointer RequiredMetaData::DefaultMetaData | ( | ) | [static] |
Creates a new IRequiredMetaData::Pointer object that has all empty values. Note that this will make it INVALID. You are required to fill in the appropriate values to make it valid. This is provided as a convenience.
void RequiredMetaData::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 | |||
) | [virtual] |
Sets all the required meta data.
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 |
Implements IRequiredMetaData.
void RequiredMetaData::setResearcherName | ( | const std::string & | researcherName | ) | [virtual] |
Sets the Researcher's name or who is generating the data set.
researcherName |
Implements IRequiredMetaData.
std::string RequiredMetaData::getResearcherName | ( | ) | [virtual] |
void RequiredMetaData::setDateTimeCreated | ( | const std::string & | dateTime | ) | [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 |
Implements IRequiredMetaData.
std::string RequiredMetaData::getDateTimeCreated | ( | ) | [virtual] |
void RequiredMetaData::setDatasetName | ( | const std::string & | datasetName | ) | [virtual] |
Provides a descriptive name for the dataset.
datasetName | The name of the dataset |
Implements IRequiredMetaData.
std::string RequiredMetaData::getDatasetName | ( | ) | [virtual] |
void RequiredMetaData::setDescription | ( | const std::string & | description | ) | [virtual] |
Provides a description for the data in the data file.
description | The description of the data |
Implements IRequiredMetaData.
std::string RequiredMetaData::getDescription | ( | ) | [virtual] |
void RequiredMetaData::setDistributionRights | ( | const std::string & | distributionRights | ) | [virtual] |
Sets the Distribution rights for the data and should be either "Unlimited" or "Limited".
distributionRights | The distribution Rights for the dataset. |
Implements IRequiredMetaData.
std::string RequiredMetaData::getDistributionRights | ( | ) | [virtual] |
void RequiredMetaData::setReleaseNumber | ( | const std::string & | releaseNumber | ) | [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" |
Implements IRequiredMetaData.
std::string RequiredMetaData::getReleaseNumber | ( | ) | [virtual] |
Returns the Release number or tracking number for the dataset.
Implements IRequiredMetaData.
void RequiredMetaData::setPedigree | ( | const std::string & | pedigree | ) | [virtual] |
Sets the Pedigree of the data which is either one of "Derived" or "Original".
pedigree | The pedigree of the data |
Implements IRequiredMetaData.
std::string RequiredMetaData::getPedigree | ( | ) | [virtual] |
Returns the pedigree of the dataset and is either "Derived" or "Original".
Implements IRequiredMetaData.
void RequiredMetaData::setDerivedSourceFile | ( | const std::string & | derivedSourceFile | ) | [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 |
Implements IRequiredMetaData.
std::string RequiredMetaData::getDerivedSourceFile | ( | ) | [virtual] |
Returns the value of the Derived source file meta data. Returns "Not Applicable" if no derived source file was used.
Implements IRequiredMetaData.
int32 RequiredMetaData::setValueForKey | ( | const std::string & | key, | |
const std::string & | value | |||
) | [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 |
Implements IRequiredMetaData.
std::string RequiredMetaData::getValueForKey | ( | const std::string & | key | ) | [virtual] |
Returns the value for a given key.
key | The key to retrieve the value for |
Implements IRequiredMetaData.
int32 RequiredMetaData::writeToFile | ( | IDataFile::Pointer | dataFile | ) |
int32 RequiredMetaData::readFromFile | ( | IDataFile::Pointer | dataFile | ) |
bool RequiredMetaData::isValid | ( | std::string | message | ) | [virtual] |
Validates the Required Meta Data.
message | A std::string to store error messages |
Implements IRequiredMetaData.
void RequiredMetaData::printSelf | ( | std::ostream & | os, | |
int32 | indent | |||
) | [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 |
Implements IRequiredMetaData.
void RequiredMetaData::generateKeyValueMap | ( | std::map< std::string, std::string > & | mdMap | ) | [virtual] |
Generates a std::map of the meta data key to its associated value.
mdMap | The map to store the values into. |
Implements IRequiredMetaData.
void RequiredMetaData::operator= | ( | const RequiredMetaData & | ) | [private] |
std::string RequiredMetaData::_researcherName [private] |
std::string RequiredMetaData::_dateCreated [private] |
std::string RequiredMetaData::_datasetName [private] |
std::string RequiredMetaData::_description [private] |
std::string RequiredMetaData::_distributionRights [private] |
std::string RequiredMetaData::_releaseNumber [private] |
std::string RequiredMetaData::_pedigree [private] |
std::string RequiredMetaData::_derivedSrcFile [private] |