1
0
mirror of https://github.com/OpenNebula/one.git synced 2024-12-24 21:34:01 +03:00
one/include/ObjectCollection.h

103 lines
2.9 KiB
C++

/* -------------------------------------------------------------------------- */
/* Copyright 2002-2011, OpenNebula Project Leads (OpenNebula.org) */
/* */
/* Licensed under the Apache License, Version 2.0 (the "License"); you may */
/* not use this file except in compliance with the License. You may obtain */
/* a copy of the License at */
/* */
/* http://www.apache.org/licenses/LICENSE-2.0 */
/* */
/* Unless required by applicable law or agreed to in writing, software */
/* distributed under the License is distributed on an "AS IS" BASIS, */
/* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. */
/* See the License for the specific language governing permissions and */
/* limitations under the License. */
/* -------------------------------------------------------------------------- */
#ifndef OBJECT_COLLECTION_H_
#define OBJECT_COLLECTION_H_
#include <set>
#include "PoolObjectSQL.h"
using namespace std;
/**
* Class to store a set of PoolObjectSQL IDs.
*/
class ObjectCollection
{
protected:
ObjectCollection(const string& _collection_name)
:collection_name(_collection_name){};
~ObjectCollection(){};
/**
* Adds an ID to the set.
* @param id The new id
*
* @return 0 on success, -1 if the ID was already in the set
*/
int add_collection_id(int id);
/**
* Deletes an ID from the set.
* @param id The id
*
* @return 0 on success, -1 if the ID was not in the set
*/
int del_collection_id(int id);
/**
* Returns how many IDs are there in the set.
* @return how many IDs are there in the set.
*/
int get_collection_size()
{
return collection_set.size();
};
/**
* Rebuilds the object from an xml node
* @param node The xml node pointer
*
* @return 0 on success, -1 otherwise
*/
int from_xml_node(const xmlNodePtr node);
/**
* Function to print the Collection object into a string in
* XML format
* @param xml the resulting XML string
* @return a reference to the generated string
*/
string& to_xml(string& xml) const;
/**
* Returns a copy of the IDs set
*/
set<int> get_collection_copy()
{
return set<int> (collection_set);
};
private:
/**
* The collection's name
*/
string collection_name;
/**
* Set containing the relations IDs
*/
set<int> collection_set;
};
#endif /*OBJECT_COLLECTION_H_*/