2011-05-25 14:13:17 +04:00
/* -------------------------------------------------------------------------- */
2020-04-30 16:00:02 +03:00
/* Copyright 2002-2020, OpenNebula Project, OpenNebula Systems */
2011-05-25 14:13:17 +04:00
/* */
/* 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>
2011-06-03 14:11:33 +04:00
# include "PoolObjectSQL.h"
2011-05-25 14:13:17 +04:00
using namespace std ;
/**
* Class to store a set of PoolObjectSQL IDs .
*/
class ObjectCollection
{
2012-02-27 17:55:43 +04:00
public :
2011-05-25 14:13:17 +04:00
ObjectCollection ( const string & _collection_name )
2011-06-03 14:11:33 +04:00
: collection_name ( _collection_name ) { } ;
2011-05-25 14:13:17 +04:00
2016-03-20 01:13:10 +03:00
ObjectCollection ( const string & cname , const set < int > & cset )
: collection_name ( cname ) , collection_set ( cset ) { } ;
2011-05-25 14:13:17 +04:00
~ ObjectCollection ( ) { } ;
/**
2011-06-03 15:31:11 +04:00
* Adds an ID to the set .
* @ param id The new id
2011-05-25 14:13:17 +04:00
*
* @ return 0 on success , - 1 if the ID was already in the set
*/
2016-03-02 01:31:31 +03:00
int add ( int id ) ;
2011-05-25 14:13:17 +04:00
/**
2011-06-03 15:31:11 +04:00
* Deletes an ID from the set .
* @ param id The id
2011-05-25 14:13:17 +04:00
*
* @ return 0 on success , - 1 if the ID was not in the set
*/
2016-03-02 01:31:31 +03:00
int del ( int id ) ;
/**
* Deletes all IDs from the set .
*/
void clear ( )
{
collection_set . clear ( ) ;
}
2011-05-25 14:13:17 +04:00
/**
* Returns how many IDs are there in the set .
* @ return how many IDs are there in the set .
*/
2016-03-02 01:31:31 +03:00
int size ( ) const
2011-05-25 14:13:17 +04:00
{
return collection_set . size ( ) ;
} ;
2016-03-10 18:28:33 +03:00
/**
* Rebuilds the object from an xml object
* @ param xml xml object
* @ param xpath_prefix Parent nodes , e . g . " /DATASTORE/ "
*
* @ return 0 on success , - 1 otherwise
*/
int from_xml ( const ObjectXML * xml , const string & xpath_prefix ) ;
2011-05-25 14:13:17 +04:00
/**
* 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
*/
2011-06-03 14:11:33 +04:00
string & to_xml ( string & xml ) const ;
2011-05-25 14:13:17 +04:00
/**
* Returns a copy of the IDs set
*/
2016-03-02 01:31:31 +03:00
set < int > clone ( ) const
2011-05-25 14:13:17 +04:00
{
2016-03-02 01:31:31 +03:00
return set < int > ( collection_set ) ;
2011-05-25 14:13:17 +04:00
} ;
2016-01-15 18:42:51 +03:00
/**
* Returns a reference to the IDs set
*/
const set < int > & get_collection ( ) const
{
return collection_set ;
} ;
2015-02-02 17:38:42 +03:00
/**
* Returns true if the collection contains the given id
* @ param id ID to search
* @ return true if the collection contains the given id
*/
2016-08-31 19:24:15 +03:00
bool contains ( int id ) const
2015-02-02 17:38:42 +03:00
{
return collection_set . count ( id ) > 0 ;
}
2016-03-02 01:31:31 +03:00
/**
* Returns and deletes the first element from the set
* @ param the element
* @ return 0 on success - 1 if the set was empty
*/
int pop ( int & elem ) ;
/**
* Adds to the collection the contents of other collection
*
*/
ObjectCollection & operator < < ( const ObjectCollection & r ) ;
2011-05-25 14:13:17 +04:00
private :
/**
* The collection ' s name
*/
string collection_name ;
/**
* Set containing the relations IDs
*/
set < int > collection_set ;
2016-03-17 20:17:37 +03:00
/**
* 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 ) ;
2011-05-25 14:13:17 +04:00
} ;
# endif /*OBJECT_COLLECTION_H_*/