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.
armarx::VariantTypeId	getType (const Ice::Current &c=Ice::emptyCurrent) const override
Ice::ObjectPtr	ice_clone () const override
	MongoDBRef ()
	Construct an empty MongoDBRef.
	MongoDBRef (const ::std::string &dbName, const ::std::string &docId)
	Construct a MongoDBRef.
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.
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.

Constructor & Destructor Documentation

MongoDBRef() [1/2]

MongoDBRef ( )

default

Construct an empty MongoDBRef.

MongoDBRef() [2/2]

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

Construct a MongoDBRef.

Parameters

dbName	mongo database name
docId	document ID

~MongoDBRef()

~MongoDBRef ( )

overridedefault

Member Function Documentation

clone()

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

inlineoverride

deserialize()

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

override

Read DBRef from serializer.

getType()

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

inlineoverride

ice_clone()

Ice::ObjectPtr ice_clone ( ) const

inlineoverride

output()

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

inlineoverride

serialize()

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

override

Write this DBRef into serializer.

validate()

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

inlineoverride

---

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

• MemoryX/core/MongoDBRef.h
• MemoryX/core/MongoDBRef.cpp