Alias.hh

Go to the documentation of this file.

#ifndef ALIAS_HH
#define ALIAS_HH

//---------------------------------------------------------------------------
// Copyright (c) 2003-2005 Clifton Labs, Inc.  All Rights Reserved.

// You may modify, distribute, and use the software contained in this package
// under the terms of the "GNU LIBRARY GENERAL PUBLIC LICENSE" version 2,
// June 1991. A copy of this license agreement can be found in the file
// "LGPL", distributed with this archive.
//---------------------------------------------------------------------------


#include <iostream>
using std::ostream;
#include <string>
using std::string;

#include "tyvis/LValue.hh"

class TypeInfo;
class EnumerationLiteral;

class Alias : public LValue {
public:
  Alias( const RValue &initObject );
  Alias( const Alias &that );
  virtual ~Alias();

  const RValue &readVal() const;
  RValue &readVal();
  void updateVal( const RValue &newVal );
  int getIntValue() const;
  LONG getInt64Value() const;
  double getDoubleValue() const;
  LONG getValue() const;
  
  RValue &operator=( const RValue &that ) ;
  Alias &operator=( const Alias &that ) ;

  bool operator==( const RValue &compareTo ) const;
  bool operator!=( const RValue &compareTo ) const;
  bool operator>( const RValue &compareTo ) const;
  bool operator>=( const RValue &compareTo ) const;
  bool operator<( const RValue &compareTo ) const;
  bool operator<=( const RValue &compareTo ) const;

  void print( ostream &os ) const;
  string toString() const;

  bool isCompositeType() const;
  bool isScalarType() const;
  bool isPhysicalType() const;

  Value left( const RValue &param = defaultIndex() ) const;
  Value right( const RValue &param = defaultIndex() ) const;
  Value high( const RValue &param = defaultIndex() ) const;
  Value low( const RValue &param = defaultIndex() ) const;
  const ScalarTypeInfo &range( const RValue &index = defaultIndex() ) const;
  const ScalarTypeInfo &reverse_range( const RValue &index = defaultIndex() ) const;
  Value length( const RValue &index = defaultIndex() ) const;
  Value ascending( const RValue &index = defaultIndex() ) const;


  const RValue &operator[]( int index ) const;
  RValue &operator[]( int index ) ;
  const RValue &operator[]( const RValue &index ) const;
  RValue &operator[]( const RValue &index ) ;
  Value getSlice( const ScalarTypeInfo &sliceSpecifier ) const;


  const RValue &getField( int index ) const;
  RValue &getField( int index ) ;

  const RValue &getField( const RValue &index ) const;

  RValue &getField( const RValue &index ) ;

  const string &getUnit() const;

  RValue *clone() const;

  LONG getAlias() const;
  int getUnits() const;

  const TypeInfo &getTypeInfo() const;

  const EnumerationLiteral &vhdlEqual( const RValue & ) const;
  const EnumerationLiteral &vhdlNotEqual( const RValue & ) const;
  const EnumerationLiteral &vhdlGreaterThan( const RValue & ) const;
  const EnumerationLiteral &vhdlGreaterThanEqual( const RValue & ) const;
  const EnumerationLiteral &vhdlLessThan( const RValue & ) const;
  const EnumerationLiteral &vhdlLessThanEqual( const RValue & ) const;
  Value vhdlConcatenate( const RValue & ) const;

  Value vhdlPlus( const RValue & ) const;
  Value vhdlMinus( const RValue & ) const;
  Value vhdlMultiply( const RValue & ) const;
  Value vhdlDivide( const RValue & ) const;
  Value vhdlMod( const RValue & ) const;
  Value vhdlRem( const RValue & ) const;
  Value vhdlPow( const RValue & ) const;

  RValue &all();
  const RValue &all() const;

  SignalNetinfo &addToFanOut( VHDLKernel * );
  //DRH
  SignalNetinfo &addChild( SignalNetinfo &, VHDLKernel * );
protected:

private:
  RValue &realObject;
};

#endif

---