toro/TPO_PhysicalObjects/TPO_HierMap.h

//===========================================================================//
// Purpose : Declaration and inline definitions for a TPO_HierMap class.
//
//           Inline methods include:
//           - GetInstName
//           - GetHierNameList
//           - SetInstName
//           - SetHierNameList
//           - IsValid
//
//===========================================================================//

//---------------------------------------------------------------------------//
// Copyright (C) 2012-2013 Jeff Rudolph, Texas Instruments (jrudolph@ti.com) //
//                                                                           //
// This program is free software; you can redistribute it and/or modify it   //
// under the terms of the GNU General Public License as published by the     //
// Free Software Foundation; version 3 of the License, or any later version. //
//                                                                           //
// This program is distributed in the hope that it will be useful, but       //
// WITHOUT ANY WARRANTY; without even an implied warranty of MERCHANTABILITY //
// or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License   //
// for more details.                                                         //
//                                                                           //
// You should have received a copy of the GNU General Public License along   //
// with this program; if not, see <http://www.gnu.org/licenses>.             //
//---------------------------------------------------------------------------//

#ifndef TPO_HIER_MAP_H
#define TPO_HIER_MAP_H

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

#include "TC_Typedefs.h"
#include "TC_Name.h"

#include "TPO_Typedefs.h"

//===========================================================================//
// Purpose        : Class declaration
// Author         : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/15/12 jeffr : Original
//===========================================================================//

class TPO_HierMap_c
{
public:

   TPO_HierMap_c( void );
   TPO_HierMap_c( const string& srInsName,
                  const TPO_NameList_t& hierNameList );
   TPO_HierMap_c( const char* pszInsName,
                  const TPO_NameList_t& hierNameList );
   TPO_HierMap_c( const TPO_HierMap_c& hierMap );
   ~TPO_HierMap_c( void );

   TPO_HierMap_c& operator=( const TPO_HierMap_c& hierMap );
   bool operator==( const TPO_HierMap_c& hierMap ) const;
   bool operator!=( const TPO_HierMap_c& hierMap ) const;

   void Print( FILE* pfile = stdout, size_t spaceLen = 0 ) const;

   const char* GetInstName( void ) const;
   const TPO_NameList_t& GetHierNameList( void ) const;

   void SetInstName( const string& srInstName );
   void SetInstName( const char* pszInstName );
   void SetHierNameList( const TPO_NameList_t& hierNameList );

   bool IsValid( void ) const;

private:

   string srInstName_; // Defines instance name to be packed (per BLIF)
   TPO_NameList_t hierNameList_;
                       // Defines a hierarchical architecture PB name list

private:

   enum TPO_DefCapacity_e 
   { 
      TPO_HIER_NAME_LIST_DEF_CAPACITY = 1
   };
};

//===========================================================================//
// Purpose        : Class inline definition(s)
// Author         : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/15/12 jeffr : Original
//===========================================================================//
inline const char* TPO_HierMap_c::GetInstName( 
      void ) const 
{
   return( TIO_SR_STR( this->srInstName_ ));
}

//===========================================================================//
inline const TPO_NameList_t& TPO_HierMap_c::GetHierNameList( 
      void ) const
{
   return( this->hierNameList_ );
}

//===========================================================================//
inline void TPO_HierMap_c::SetInstName( 
      const string& srInstName )
{
   this->srInstName_ = srInstName;
}

//===========================================================================//
inline void TPO_HierMap_c::SetInstName( 
      const char* pszInstName )
{
   this->srInstName_ = TIO_PSZ_STR( pszInstName );
}

//===========================================================================//
inline void TPO_HierMap_c::SetHierNameList(
      const TPO_NameList_t& hierNameList )
{
   this->hierNameList_ = hierNameList;
}

//===========================================================================//
inline bool TPO_HierMap_c::IsValid( 
      void ) const
{
   return( this->srInstName_.length( ) ? true : false );
}

#endif