blob: 1b52288940478e769b4945d18f6cf707ef1f4f3f [file] [log] [blame] [edit]
//===========================================================================//
// Purpose : Declaration and inline definitions for a TNO_InstPin 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)
// - GetInstName,
// - GetPortName, GetPortIndex,
// - GetPinName, GetPinIndex
// - GetType
// - SetType
// - Clear
// - 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 TNO_INST_PIN_H
#define TNO_INST_PIN_H
#include <cstdio>
#include <string>
using namespace std;
#include "TC_Typedefs.h"
//===========================================================================//
// Purpose : Class declaration
// Author : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/15/12 jeffr : Original
//===========================================================================//
class TNO_InstPin_c
{
public:
TNO_InstPin_c( void );
TNO_InstPin_c( const string& srInstName,
const string& srPortName,
size_t portIndex,
const string& srPinName,
size_t pinIndex,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const char* pszInstName,
const char* pszPortName,
size_t portIndex,
const char* pszPinName,
size_t pinIndex,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const string& srInstName,
const string& srPortName,
const string& srPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const char* pszInstName,
const char* pszPortName,
const char* pszPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const string& srInstName,
const string& srPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const char* pszInstName,
const char* pszPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
TNO_InstPin_c( const TNO_InstPin_c& instPin );
~TNO_InstPin_c( void );
TNO_InstPin_c& operator=( const TNO_InstPin_c& instPin );
bool operator<( const TNO_InstPin_c& instPin ) const;
bool operator==( const TNO_InstPin_c& instPin ) const;
bool operator!=( const TNO_InstPin_c& instPin ) const;
void Print( FILE* pfile = stdout, size_t spaceLen = 0 ) const;
void ExtractString( string* psrInstPin ) const;
void SetName( const string& srName );
void SetName( const char* pszName );
const char* GetName( void ) const;
const char* GetCompare( void ) const;
const char* GetInstName( void ) const;
const char* GetPortName( void ) const;
const char* GetPinName( void ) const;
size_t GetPortIndex( void ) const;
size_t GetPinIndex( void ) const;
TC_TypeMode_t GetType( void ) const;
void SetType( TC_TypeMode_t type );
void Set( const string& srInstName,
const string& srPortName,
size_t portIndex,
const string& srPinName,
size_t pinIndex,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Set( const char* pszInstName,
const char* pszPortName,
size_t portIndex,
const char* pszPinName,
size_t pinIndex,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Set( const string& srInstName,
const string& srPortName,
const string& srPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Set( const char* pszInstName,
const char* pszPortName,
const char* pszPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Set( const string& srInstName,
const string& srPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Set( const char* pszInstName,
const char* pszPinName,
TC_TypeMode_t type = TC_TYPE_UNDEFINED );
void Clear( void );
bool IsValid( void ) const;
private:
string srName_; // Defines instance|port|pin name string
string srInstName_; // Defines instance name string
string srPortName_; // Defines port name string
string srPinName_; // Defines pin name string
size_t portIndex_; // Defines port index (optional)
size_t pinIndex_; // Defines pin index (optional)
TC_TypeMode_t type_; // Defines type mode
// (eg. input, output, signal, clock, reset, power)
};
//===========================================================================//
// Purpose : Class inline definition(s)
// Author : Jeff Rudolph
//---------------------------------------------------------------------------//
// Version history
// 05/15/12 jeffr : Original
//===========================================================================//
inline void TNO_InstPin_c::SetName(
const string& srName )
{
this->srName_ = srName;
}
//===========================================================================//
inline void TNO_InstPin_c::SetName(
const char* pszName )
{
this->srName_ = TIO_PSZ_STR( pszName );
}
//===========================================================================//
inline const char* TNO_InstPin_c::GetName(
void ) const
{
return( TIO_SR_STR( this->srName_ ));
}
//===========================================================================//
inline const char* TNO_InstPin_c::GetCompare(
void ) const
{
return( TIO_SR_STR( this->srName_ ));
}
//===========================================================================//
inline const char* TNO_InstPin_c::GetInstName(
void ) const
{
return( TIO_SR_STR( this->srInstName_ ));
}
//===========================================================================//
inline const char* TNO_InstPin_c::GetPortName(
void ) const
{
return( TIO_SR_STR( this->srPortName_ ));
}
//===========================================================================//
inline const char* TNO_InstPin_c::GetPinName(
void ) const
{
return( TIO_SR_STR( this->srPinName_ ));
}
//===========================================================================//
inline size_t TNO_InstPin_c::GetPortIndex(
void ) const
{
return( this->portIndex_ );
}
//===========================================================================//
inline size_t TNO_InstPin_c::GetPinIndex(
void ) const
{
return( this->pinIndex_ );
}
//===========================================================================//
inline TC_TypeMode_t TNO_InstPin_c::GetType(
void ) const
{
return( this->type_ );
}
//===========================================================================//
inline void TNO_InstPin_c::SetType(
TC_TypeMode_t type )
{
this->type_ = type;
}
//===========================================================================//
inline bool TNO_InstPin_c::IsValid(
void ) const
{
return( this->srInstName_.length( ) &&
this->srPinName_.length( ) ?
true : false );
}
#endif