NCBI C++ ToolKit
Public Member Functions | Private Attributes | Friends | List of all members
CRelation::SObject Struct Reference

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>

+ Collaboration diagram for CRelation::SObject:

Public Member Functions

 SObject ()
 
 SObject (const CObject &obj)
 
 SObject (const CObject &obj, const string &comm)
 
const CObjectGetSource () const
 retrieve the source for this object this is the original object that was used to generate this object More...
 
const stringGetComment () 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 CObjectoperator* () const
 return the object through a couple of equivalent functions: More...
 
 operator const CObject & (void) const
 cast operator More...
 
const CObjectGetObject (void) const
 named function More...
 
const CObjectGetObjectPtr (void) const
 named function More...
 

Private Attributes

CConstRef< CObjectobject
 the converted object More...
 
CConstRef< CObjectsource
 the source object More...
 
string comment
 a comment concerning this object's origin More...
 

Friends

class CObjectConverter
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SObject() [1/3]

CRelation::SObject::SObject ( )

Definition at line 102 of file relation.cpp.

◆ SObject() [2/3]

CRelation::SObject::SObject ( const CObject obj)

Definition at line 106 of file relation.cpp.

◆ SObject() [3/3]

CRelation::SObject::SObject ( const CObject obj,
const string comm 
)

Definition at line 111 of file relation.cpp.

Member Function Documentation

◆ GetComment()

const string& CRelation::SObject::GetComment ( void  ) const
inline

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.

◆ GetObject()

const CObject& CRelation::SObject::GetObject ( void  ) const
inline

named function

Definition at line 107 of file relation.hpp.

References object.

◆ GetObjectPtr()

const CObject* CRelation::SObject::GetObjectPtr ( void  ) const
inline

named function

Definition at line 113 of file relation.hpp.

References object.

◆ GetSource()

const CObject& CRelation::SObject::GetSource ( void  ) const
inline

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.

◆ operator const CObject &()

CRelation::SObject::operator const CObject & ( void  ) const
inline

cast operator

Definition at line 101 of file relation.hpp.

References object.

◆ operator*()

const CObject& CRelation::SObject::operator* ( void  ) const
inline

return the object through a couple of equivalent functions:

dereference operator

Definition at line 95 of file relation.hpp.

References object.

Friends And Related Function Documentation

◆ CObjectConverter

friend class CObjectConverter
friend

Definition at line 119 of file relation.hpp.

Member Data Documentation

◆ comment

string CRelation::SObject::comment
private

a comment concerning this object's origin

Definition at line 128 of file relation.hpp.

Referenced by GetComment().

◆ object

CConstRef<CObject> CRelation::SObject::object
private

the converted object

Definition at line 122 of file relation.hpp.

Referenced by GetObject(), GetObjectPtr(), operator const CObject &(), and operator*().

◆ source

CConstRef<CObject> CRelation::SObject::source
private

the source object

Definition at line 125 of file relation.hpp.

Referenced by GetSource().


The documentation for this struct was generated from the following files:
Modified on Tue Feb 27 05:55:18 2024 by modify_doxy.py rev. 669887