Entity.h

Go to the documentation of this file.

/*
 * ALMA - Atacama Large Millimeter Array
 * (c) European Southern Observatory, 2002
 * (c) Associated Universities Inc., 2002
 * Copyright by ESO (in the framework of the ALMA collaboration),
 * Copyright by AUI (in the framework of the ALMA collaboration),
 * All rights reserved.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY, without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307  USA
 *
 * File Entity.h
 */

#ifndef Entity_CLASS
#define Entity_CLASS

#include <iostream>
#include <string>
using namespace std;

#ifndef WITHOUT_ACS
#include <asdmIDLTypesC.h>
using asdmIDLTypes::IDLEntity;
#endif

#include <EntityId.h>

#include <StringTokenizer.h>
#include <InvalidArgumentException.h>
#include <InvalidDataException.h>
using asdm::StringTokenizer;
using asdm::InvalidArgumentException;
using asdm::InvalidDataException;

#include "EndianStream.h"
using asdm::EndianOSStream;
using asdm::EndianISStream;

namespace asdm {

class Entity;
ostream & operator << ( ostream &, const Entity & );

class Entity {
    friend ostream & operator << ( ostream &, const Entity & );
        friend istream & operator >> ( istream &, Entity&);

public:
        static Entity getEntity(StringTokenizer &t) throw(InvalidArgumentException);

        Entity();
        Entity(const string &s);
#ifndef WITHOUT_ACS
        Entity(IDLEntity &);
#endif
        Entity(string entityId, string entityIdEncrypted, string entityTypeName,
                        string entityVersion, string instanceVersion);
        virtual ~Entity();

        bool operator == (const Entity &) const;
        bool equals(const Entity &) const;
        bool operator != (const Entity &) const;

        bool isNull() const;

        string toString() const;
        string toXML() const throw(InvalidDataException);
#ifndef WITHOUT_ACS
        IDLEntity toIDLEntity() const;
#endif
        void setFromXML(string xml) throw(InvalidArgumentException);
        
        void toBin(EndianOSStream& eoss);
        
        static Entity fromBin(EndianISStream& eiss);
        
        EntityId getEntityId() const;
        string getEntityIdEncrypted() const;
        string getEntityTypeName() const;
        string getEntityVersion() const;
        string getInstanceVersion() const;
        void setEntityId(EntityId e);
        void setEntityIdEncrypted(string s);
        void setEntityTypeName(string s);
        void setEntityVersion(string s);
        void setInstanceVersion(string s);

private:
        EntityId entityId;
        string entityIdEncrypted;
        string entityTypeName;
        string entityVersion;
        string instanceVersion;

        string getXMLValue(string xml, string parm) const;
        string validXML() const;

};



} // End namespace asdm

#endif /* Entity_CLASS */