EntityId.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 EntityId.h
 */

#ifndef EntityId_CLASS
#define EntityId_CLASS

#include <iostream>
#include <string>

#ifndef WITHOUT_ACS
#include <asdmIDLTypesC.h>
#endif

#include <alma/ASDM/StringTokenizer.h>
#include <alma/ASDM/InvalidArgumentException.h>

#include <alma/ASDM/EndianStream.h>

namespace asdm {

class EntityId;
std::ostream & operator << ( std::ostream &, const EntityId & );
std::istream & operator >> ( std::istream &, EntityId&);

class EntityId {
    friend std::ostream & operator << ( std::ostream &, const EntityId & );
        friend std::istream & operator >> ( std::istream &, EntityId&);

public:
        static EntityId getEntityId(StringTokenizer &t) 
                throw (InvalidArgumentException) ;
        static std::string validate(std::string x);

        EntityId();
        EntityId(const EntityId &);
        EntityId(const std::string &id) throw (InvalidArgumentException);
#ifndef WITHOUT_ACS
        EntityId(asdmIDLTypes::IDLEntityId &) throw (InvalidArgumentException);
#endif
        virtual ~EntityId();

        EntityId& operator = (const EntityId &);

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

        std::string toString() const;
#ifndef WITHOUT_ACS
    asdmIDLTypes::IDLEntityId toIDLEntityId() const;
#endif

        void toBin(EndianOSStream& eoss) const;
        
        static EntityId fromBin(EndianIStream& eis);
        
        bool isNull() const;

        std::string getId() const;
        void setId(std::string e);

private:
        std::string id;

};

// EntityId constructors
inline EntityId::EntityId() : id("") { }

inline EntityId::EntityId(const EntityId &t) : id(t.id) { }

// EntityId destructor
inline EntityId::~EntityId() { }

inline EntityId& EntityId::operator = ( const EntityId &x ) {
        id = x.id;
        return *this;
}

inline bool EntityId::isNull() const {
        return id.length() == 0;        
}

inline bool EntityId::equals(const EntityId &x) const {
        return id == x.id;
}

inline bool EntityId::operator == (const EntityId &x) const {
        return id == x.id;      
}

inline bool EntityId::operator != (const EntityId &x) const {
        return id != x.id;      
}

inline std::string EntityId::toString() const {
        return id;
}

#ifndef WITHOUT_ACS
inline asdmIDLTypes::IDLEntityId EntityId::toIDLEntityId() const {
    asdmIDLTypes::IDLEntityId x;
        x.value = CORBA::string_dup(id.c_str());
        return x;
}
#endif

inline std::string EntityId::getId() const {
        return id;
}

inline void EntityId::setId(std::string s) {
        id = s;
}

// Friend functions

inline std::ostream & operator << ( std::ostream &o, const EntityId &x ) {
        o << x.id;
        return o;
}

inline std::istream & operator >> ( std::istream &i, EntityId &x ) {
        i >> x.id;
        return i;
}

} // End namespace asdm

#endif /* EntityId_CLASS */