COPASI API  4.16.103
CBiologicalDescription.h
Go to the documentation of this file.
1 // Copyright (C) 2010 - 2013 by Pedro Mendes, Virginia Tech Intellectual
2 // Properties, Inc., University of Heidelberg, and The University
3 // of Manchester.
4 // All rights reserved.
5 
6 // Copyright (C) 2008 - 2009 by Pedro Mendes, Virginia Tech Intellectual
7 // Properties, Inc., EML Research, gGmbH, University of Heidelberg,
8 // and The University of Manchester.
9 // All rights reserved.
10 
11 #ifndef COPASI_CBiologicalDescription
12 #define COPASI_CBiologicalDescription
13 
14 #include <string>
15 
18 
20 
22 {
23  // Attributes
24 private:
25  /**
26  * Triplet in the RDF graph representing the description.
27  */
29 
30  /**
31  * The key of the object needed for the COPASI tables.
32  */
33  std::string mKey;
34 
35  /**
36  * MIRIAM resource for holding the database and Id.
37  */
39 
40 public:
41  // Operations
42  /**
43  * Default constructor
44  * @param const std::string & objectName
45  * @param const CCopasiContainer * pParent (default: NULL)
46  */
47  CBiologicalDescription(const std::string & objectName,
48  const CCopasiContainer * pParent = NULL);
49 
50  /**
51  * Specific constructor
52  * @param const CRDFTriplet & triplet
53  * @param const std::string & objectName (default: "")
54  * @param const CCopasiContainer * pParent (default: NULL)
55  */
56  CBiologicalDescription(const CRDFTriplet & triplet,
57  const std::string & objectName = "",
58  const CCopasiContainer * pParent = NULL);
59 
60  /**
61  * Copy constructor
62  * @param "const CBiologicalDescription &" src
63  * @param const CCopasiContainer * pParent (default: NULL)
64  */
66  const CCopasiContainer * pParent = NULL);
67 
68  /**
69  * Destructor
70  */
72 
73  /**
74  * Retrieve the MIRIAM resource object for this reference
75  */
77 
78  /**
79  * Retrieve the RDF triplet holding the description.
80  * @return const CRDFTriplet & triplet
81  */
82  const CRDFTriplet & getTriplet() const;
83 
84  /**
85  * Retrieve the key of the object.
86  * @return const std::string & key
87  */
88  virtual const std::string & getKey() const;
89 
90  /**
91  * Retrieve the predicate, i.e. the relationship between the subject.
92  * and the MIRIAM resource.
93  * @return std::string predicate
94  */
95  std::string getPredicate() const;
96 
97  /**
98  * Retrieve the MIRIAM resource (database) describing the subject.
99  * @return std::string resource
100  */
101  std::string getResource() const;
102 
103  /**
104  * Retrieve the identifier of the subject in the MIRIAM resource.
105  * @return const std::string id
106  */
107  const std::string & getId() const;
108 
109  /**
110  * Retrieve the URI comprised of MIRIAM resource and id.
111  * @return std::string uri
112  */
113  std::string getURI() const;
114 
115  /**
116  * Set the predicate, i.e., relationship between the subject and the
117  * MIRIAM resource.
118  * @param const std::string & predicate
119  */
120  void setPredicate(const std::string & predicate);
121 
122  /**
123  * Set the MIRIAM resource (database) describing the subject.
124  * @param const std::string & predicate
125  */
126  void setResource(const std::string & resource);
127 
128  /**
129  * Set the identifier of the subject in the MIRIAM resource.
130  * @param const std::string & id
131  */
132  void setId(const std::string & id);
133 
134  /**
135  * Convenience method removing invalid predicate, resource, and id combinations
136  */
137  void clearInvalidEntries();
138 };
139 
140 #endif //COPASI_CBiologicalDescription
virtual const std::string & getKey() const
void setResource(const std::string &resource)
CMIRIAMResourceObject mResource
const std::string & getId() const
void setPredicate(const std::string &predicate)
Header file of class CCopasiContainer.
CBiologicalDescription(const std::string &objectName, const CCopasiContainer *pParent=NULL)
std::string getPredicate() const
const CMIRIAMResourceObject & getMIRIAMResourceObject() const
const CRDFTriplet & getTriplet() const
std::string getResource() const
void setId(const std::string &id)