MongoDBRef Class Reference

Represents a cross-database reference to a document in MongoDB. More...

#include <MemoryX/core/MongoDBRef.h>

+ Inheritance diagram for MongoDBRef:

Public Member Functions

armarx::VariantDataClassPtr clone (const Ice::Current &c=Ice::emptyCurrent) const override
 
void deserialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &c=Ice::emptyCurrent) override
 Read DBRef from serializer. More...
 
armarx::VariantTypeId getType (const Ice::Current &c=Ice::emptyCurrent) const override
 
Ice::ObjectPtr ice_clone () const override
 
 MongoDBRef ()
 Construct an empty MongoDBRef. More...
 
 MongoDBRef (const ::std::string &dbName, const ::std::string &docId)
 Construct a MongoDBRef. More...
 
std::string output (const Ice::Current &c=Ice::emptyCurrent) const override
 
void serialize (const armarx::ObjectSerializerBasePtr &serializer, const ::Ice::Current &c=Ice::emptyCurrent) const override
 Write this DBRef into serializer. More...
 
bool validate (const Ice::Current &c=Ice::emptyCurrent) override
 
 ~MongoDBRef () override
 

Detailed Description

Represents a cross-database reference to a document in MongoDB.

The MongoDBRef holds a pair of (database_name, document_id). It is currently used to store references to GridFS files in EntityAttribute.

Definition at line 45 of file MongoDBRef.h.

Constructor & Destructor Documentation

◆ MongoDBRef() [1/2]

MongoDBRef ( )
default

Construct an empty MongoDBRef.

+ Here is the caller graph for this function:

◆ MongoDBRef() [2/2]

MongoDBRef ( const ::std::string &  dbName,
const ::std::string &  docId 
)

Construct a MongoDBRef.

Parameters
dbNamemongo database name
docIddocument ID

◆ ~MongoDBRef()

~MongoDBRef ( )
overridedefault

Member Function Documentation

◆ clone()

armarx::VariantDataClassPtr clone ( const Ice::Current &  c = Ice::emptyCurrent) const
inlineoverride

Definition at line 71 of file MongoDBRef.h.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ deserialize()

void deserialize ( const armarx::ObjectSerializerBasePtr &  serializer,
const ::Ice::Current &  c = Ice::emptyCurrent 
)
override

Read DBRef from serializer.

Definition at line 47 of file MongoDBRef.cpp.

◆ getType()

armarx::VariantTypeId getType ( const Ice::Current &  c = Ice::emptyCurrent) const
inlineoverride

Definition at line 81 of file MongoDBRef.h.

◆ ice_clone()

Ice::ObjectPtr ice_clone ( ) const
inlineoverride

Definition at line 67 of file MongoDBRef.h.

+ Here is the call graph for this function:

◆ output()

std::string output ( const Ice::Current &  c = Ice::emptyCurrent) const
inlineoverride

Definition at line 75 of file MongoDBRef.h.

+ Here is the call graph for this function:

◆ serialize()

void serialize ( const armarx::ObjectSerializerBasePtr &  serializer,
const ::Ice::Current &  c = Ice::emptyCurrent 
) const
override

Write this DBRef into serializer.

Definition at line 38 of file MongoDBRef.cpp.

◆ validate()

bool validate ( const Ice::Current &  c = Ice::emptyCurrent)
inlineoverride

Definition at line 85 of file MongoDBRef.h.


The documentation for this class was generated from the following files: