blob: 46f20adf6f163f918976bb7a576bc94fac2eaa15 [file] [log] [blame] [edit]
//===========================================================================//
// Purpose : Declaration and inline definitions for a TFM_Channel class.
//
// Inline methods include:
// - SetName (required for TCT_SortedNameDynamicVector_c class)
// - GetName (required for TCT_SortedNameDynamicVector_c class)
// - GetCompare (required for TCT_BSearch and TCT_QSort classes)
// - IsValid
//
//===========================================================================//
//---------------------------------------------------------------------------//
// Copyright (C) 2012-2013 Jeff Rudolph, Texas Instruments (jrudolph@ti.com) //
// //
// Permission is hereby granted, free of charge, to any person obtaining a //
// copy of this software and associated documentation files (the "Software"),//
// to deal in the Software without restriction, including without limitation //
// the rights to use, copy, modify, merge, publish, distribute, sublicense, //
// and/or sell copies of the Software, and to permit persons to whom the //
// Software is furnished to do so, subject to the following conditions: //
// //
// The above copyright notice and this permission notice shall be included //
// in all copies or substantial portions of the Software. //
// //
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS //
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF //
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN //
// NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, //
// DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR //
// OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE //
// USE OR OTHER DEALINGS IN THE SOFTWARE. //
//---------------------------------------------------------------------------//
#ifndef TFM_CHANNEL_H
#define TFM_CHANNEL_H
#include <cstdio>
#include <string>
using namespace std;
#include "TGS_Typedefs.h"
#include "TGS_Region.h"
//===========================================================================//
// Purpose : Class declaration
// Author : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/20/12 jeffr : Original
//===========================================================================//
class TFM_Channel_c
{
public:
TFM_Channel_c( void );
TFM_Channel_c( const string& srName,
const TGS_Region_c& region,
TGS_OrientMode_t orient,
unsigned int index,
unsigned int count );
TFM_Channel_c( const char* pszName,
const TGS_Region_c& region,
TGS_OrientMode_t orient,
unsigned int index,
unsigned int count );
TFM_Channel_c( const string& srName );
TFM_Channel_c( const char* pszName );
TFM_Channel_c( const TFM_Channel_c& channel );
~TFM_Channel_c( void );
TFM_Channel_c& operator=( const TFM_Channel_c& channel );
bool operator==( const TFM_Channel_c& channel ) const;
bool operator!=( const TFM_Channel_c& channel ) const;
void Print( FILE* pfile = stdout, size_t spaceLen = 0 ) const;
void SetName( const string& srName );
void SetName( const char* pszName );
const char* GetName( void ) const;
const char* GetCompare( void ) const;
bool IsValid( void ) const;
public:
string srName; // Unique identifier
TGS_Region_c region; // Specifies routing channel region within a floorplan
TGS_OrientMode_t orient;
// Defines channel orientation (ie. horizontal | vertical)
unsigned int index; // Defines channel index (unique identifier)
unsigned int count; // Defines #of routing segments available within channel
};
//===========================================================================//
// Purpose : Class inline definition(s)
// Author : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/20/12 jeffr : Original
//===========================================================================//
inline void TFM_Channel_c::SetName(
const string& srName_ )
{
this->srName = srName_;
}
//===========================================================================//
inline void TFM_Channel_c::SetName(
const char* pszName )
{
this->srName = TIO_PSZ_STR( pszName );
}
//===========================================================================//
inline const char* TFM_Channel_c::GetName(
void ) const
{
return( TIO_SR_STR( this->srName ));
}
//===========================================================================//
inline const char* TFM_Channel_c::GetCompare(
void ) const
{
return( TIO_SR_STR( this->srName ));
}
//===========================================================================//
inline bool TFM_Channel_c::IsValid(
void ) const
{
return( this->srName.length( ) ? true : false );
}
#endif