NCBI C++ ToolKit
|
Search Toolkit Book for CRelation::SObject
struct SObject provides an interface for defining what is returned from object conversion. More...
#include <gui/objutils/relation.hpp>
Public Member Functions | |
SObject () | |
SObject (const CObject &obj) | |
SObject (const CObject &obj, const string &comm) | |
const CObject & | GetSource () const |
retrieve the source for this object this is the original object that was used to generate this object More... | |
const string & | GetComment () const |
retrieve a comment concerning what this object means this may be, for example, a description of the relationship of the object to its source More... | |
const CObject & | operator* () const |
return the object through a couple of equivalent functions: More... | |
operator const CObject & (void) const | |
cast operator More... | |
const CObject & | GetObject (void) const |
named function More... | |
const CObject * | GetObjectPtr (void) const |
named function More... | |
Private Attributes | |
CConstRef< CObject > | object |
the converted object More... | |
CConstRef< CObject > | source |
the source object More... | |
string | comment |
a comment concerning this object's origin More... | |
Friends | |
class | CObjectConverter |
struct SObject provides an interface for defining what is returned from object conversion.
Rather than simply provide the object, we can provide some contextual information as well.
Definition at line 70 of file relation.hpp.
CRelation::SObject::SObject | ( | ) |
Definition at line 102 of file relation.cpp.
Definition at line 106 of file relation.cpp.
Definition at line 111 of file relation.cpp.
retrieve a comment concerning what this object means this may be, for example, a description of the relationship of the object to its source
Definition at line 87 of file relation.hpp.
References comment.
retrieve the source for this object this is the original object that was used to generate this object
Definition at line 79 of file relation.hpp.
References source.
return the object through a couple of equivalent functions:
dereference operator
Definition at line 95 of file relation.hpp.
References object.
|
friend |
Definition at line 119 of file relation.hpp.
|
private |
a comment concerning this object's origin
Definition at line 128 of file relation.hpp.
Referenced by GetComment().
the converted object
Definition at line 122 of file relation.hpp.
Referenced by GetObject(), GetObjectPtr(), operator const CObject &(), and operator*().