---

CoordinateSpace.h

Go to the documentation of this file.

//
//    Title     :  CoordinateSpace.h
//    Project     :  OSCAR Version 2.0
//    Created     :  7/10/2002
//    Author      :  Chetan Kapoor
//    Platforms   :  All
//    Copyright   :  The University of Texas at Austin, 2002. All rights reserved.
//
//          This software and documentation constitute an unpublished work
//          and contain valuable trade secrets and proprietary information
//          belonging to the University. None of the foregoing material may be
//          copied or duplicated or disclosed without the express, written
//          permission of University. THE UNIVERSITY EXPRESSLY DISCLAIMS ANY
//          AND ALL WARRANTIES CONCERNING THIS SOFTWARE AND DOCUMENTATION,
//          INCLUDING ANY WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
//          PARTICULAR PURPOSE, AND WARRANTIES OF PERFORMANCE, AND ANY WARRANTY
//          THAT MIGHT OTHERWISE ARISE FROM COURSE OF DEALING OR USAGE OF TRADE.
//          NO WARRANTY IS EITHER EXPRESS OR IMPLIED WITH RESPECT TO THE USE OF
//          THE SOFTWARE OR DOCUMENTATION. Under no circumstances shall the
//          University be liable for incidental, special, indirect, direct or
//          consequential damages or loss of profits, interruption of business,
//          or related expenses which may arise from use of software or documentation,
//          including but not limited to those resulting from defects in software
//          and/or documentation, or loss or inaccuracy of data of any kind.
//
//    Purpose     :  CoordinateSpace declares the class CoordinateSpace.
//
//-----------------------------------------------------------------------------
//
//    $Revisions$
//
//    $Log: CoordinateSpace.h,v $
//    Revision 1.10  2005/03/18 23:05:22  chetan
//    Fixed g++ compile warnings. Removed virtual inheritance from Base, added initialization of base class in copy constructors, added newline at EOF
//
//    Revision 1.9  2005/03/14 22:04:13  pmarch
//    Added to namespace OSCAR and removed "RR" from front of class names.
//
//    Revision 1.8  2004/07/19 16:37:05  edjung
//    -made fix to constructors for ANSI C++ compliance with temporary OSCARError objects
//    -added DUMMY_ERROR class
//
//    Revision 1.7  2004/06/10 19:11:57  aspencer
//    Added /ingroup tags.
//
//    Revision 1.6  2004/06/08 22:58:05  chetan
//    Added the Grow method
//
//    Revision 1.5  2004/05/26 20:02:03  pmarch
//    Added /defgroup and /ingroup tags.
//
//    Revision 1.4  2003/09/09 17:13:14  eswint
//    - Changed #include "Math/..." to #include "..."
//
//    Revision 1.3  2003/09/05 16:56:31  eswint
//    - Eliminated unused member variable spaceDim
//
//    Revision 1.2  2003/09/04 22:48:00  eswint
//    - Change default arguments: OSCARError(0,"No Error"...) to OSCARError(noError) and String(" ") to String("")
//
//    Revision 1.1  2003/08/18 15:23:43  eswint
//    Initial Commit
//
//
#ifndef CoordinateSpace_h
#define CoordinateSpace_h

#include "Base/Base.h"
#include "Base/BaseError.h"
#include "Array.h"  //for RRCoordinateStatusArray

namespace OSCAR {

  enum CoordinateStatus { Active = true, Inactive = false};


  typedef Array<enum CoordinateStatus> CoordinateStatusArray;

  class CoordinateSpace : public Base {
  public:

    CoordinateSpace(unsigned int spaceDim, OSCARError& err = DUMMY_ERROR(noError));

    CoordinateSpace(const CoordinateStatusArray& coordinateStatus);

    CoordinateSpace(const CoordinateSpace& rhs);

    virtual ~CoordinateSpace();

    CoordinateSpace& operator=(const CoordinateSpace& rhs);

    unsigned int GetActiveDimensionSize() const;

    unsigned int GetDimensionSize() const;

    bool SetCoordinateStatus(unsigned int coordNo, CoordinateStatus status);

    bool SetCoordinateStatus(const CoordinateStatusArray& statusArray);

    void SetAllCoordinateStatus(const CoordinateStatus& status);

    bool GetCoordinateStatus(unsigned int coordNo, CoordinateStatus& status);

    CoordinateStatus GetCoordinateStatus(unsigned int coordNo) const;

    bool GetCoordinateStatus(CoordinateStatusArray& statusArray);

    const CoordinateStatusArray& GetCoordinateStatus() const;

      bool Grow(unsigned int growth);

  protected:

    //holds the Active/InActive status of each coordinate
    CoordinateStatusArray *coordinateStatus;
    //number of dimensions that are active
    unsigned int activeSpaceDim;

    void updateActiveDimSize();

  };  //End of CoordinateSpace

  #include "CoordinateSpace.ipp"
}
#endif //CoordinateSpace_h

RRG Homepage

OSCAR Overview

OSCAR Tutorials

Simulations