node.h

这是一个从音频信号里提取特征参量的程序

//      
//-----------------------------------------------------------------------------

// constants: required constants such as the class name
//
template <class TObject>
const String Node<TObject>::CLASS_NAME(L"Node");

// constants: required constants for i/o methods
//
template <class TObject>
const String Node<TObject>::DEF_PARAM(L"item");

// static instantiations: debug level and memory manager
//
template <class TObject>
Integral::DEBUG Node<TObject>::debug_level_d = Integral::NONE;

template <class TObject>
MemoryManager Node<TObject>::mgr_d(sizeof(Node<TObject>), CLASS_NAME);

// below are all the methods for the Node template class
//

//-----------------------------------------------------------------------------
//
// required static methods
//
//-----------------------------------------------------------------------------

// method: name
//
// arguments: none
//
// return: a static String& containing the class name
//
// this method returns the class name
//
template<class TObject>
const String& Node<TObject>::name() {

  // create the static name string for this class and return it
  //
  static String cname(CLASS_NAME);
  cname.clear();
  cname.concat(CLASS_NAME);
  cname.concat(L"<");
  cname.concat(TObject::name());
  cname.concat(L">");

  // return the name
  //
  return cname;
}

//-----------------------------------------------------------------------------
//
// required debug methods
//
//-----------------------------------------------------------------------------

// method: debug
//
// arguments:
//  const unichar* message: (input) information message
//
// return: a boolean value indicating status
//
// this method dumps the contents of an object to the console
// 
template<class TObject>
boolean Node<TObject>::debug(const unichar* message_a) const {

  // declare local variables
  //
  String output;
  String value;

  // call the debug method of the item
  //
  if (item_d != (TObject*)NULL) {
    item_d->debug(message_a);
  }
  else {
    value.assign(item_d);
    output.debugStr(name(), message_a, L"item_d", value);
    Console::put(output);
  }
  
  // exit gracefully
  // 
  return true;
}

//-----------------------------------------------------------------------------
//
// required i/o methods
//
//-----------------------------------------------------------------------------

// method: sofSize
//
// arguments: none
//
// return: size of object as written to disk via the i/o methods
//
// this method determines the size of the object on disk
//
template<class TObject>
long Node<TObject>::sofSize() const {

  // temporary size variable
  //
  if (item_d != NULL) {
    return item_d->sofSize();
  }
  else {
    Error::handle(name(), L"sofSize", ERR_NOITEM, __FILE__, __LINE__);
    return (long)0;
  }
}

// method: read
//
// arguments:
//  Sof& sof: (input) sof file object
//  long tag: (input) sof object instance tag
//  String& name: (input) sof object instance name
//
// return: a boolean value indicating status
//
// this method has the object read itself from an Sof file
//
template<class TObject>
boolean Node<TObject>::read(Sof& sof_a, long tag_a, const String& name_a) {
  
  // get the instance of the object from the Sof file
  //
  if (!sof_a.find(name_a, tag_a)) {
    return false;
  }

  // read the actual data from the sof file
  //
  if (!readData(sof_a)) {
    return false;
  }

  // exit gracefully
  //
  return true;
}

// method: write
//
// arguments:
//  Sof& sof: (input) sof file object
//  long tag: (input) sof object instance tag
//  String& name: (input) sof object instance name
//
// return: a boolean value indicating status
//
// this method has the object write itself to an Sof file
//
template<class TObject>
boolean Node<TObject>::write(Sof& sof_a, long tag_a, const String& name_a)
  const {

  // declare a temporary size variable
  //
  long obj_size = 0;

  // switch on ascii or binary mode
  //
  if (sof_a.isText()) {

    // set the size to be dynamic
    //
    obj_size = Sof::ANY_SIZE;
  }
  else {

    // the size of the binary data to write
    //
    obj_size = sofSize();
  }
  
  // put the object into the sof file's index
  //
  if (!sof_a.put(name_a, tag_a, obj_size)) {
    return false;
  }
  
  // exit gracefully
  //
  return writeData(sof_a);
}

// method: readData
//
// arguments:
//  Sof& sof: (input) sof file object
//  String& pname: (input) parameter name
//  long size: (input) size of the object
//  boolean param: (input) is the parameter specified?
//  boolean nested: (input) is this nested?
//
// return: a boolean value indicating status
//
// this method has the object read itself from an Sof file. it assumes
// that the Sof file is already positioned correctly.
//
template<class TObject>
boolean Node<TObject>::readData(Sof& sof_a, const String& pname_a, long size_a,
				boolean param_a, boolean nested_a) {
  
  // if item_d is NULL then create a new one
  //
  if (item_d == (TObject*)NULL) {
    item_d = new TObject();
  }
  
  // read the item
  //
  if (!item_d->readData(sof_a, pname_a, size_a, param_a, nested_a)) {
    return Error::handle(name(), L"readData", Error::READ,
			 __FILE__, __LINE__, Error::WARNING);
  }

  // exit gracefully
  //
  return true;
}

// method: writeData
//
// arguments:
//  Sof& sof: (input) sof file object
//  String& pname: (input) parameter name
//
// return: a boolean value indicating status
//
// this method writes the object to the Sof file. it assumes that the
// Sof file is already positioned correctly.
//
template<class TObject>
boolean Node<TObject>::writeData(Sof& sof_a, const String& pname_a) const {

  // make sure the item is not NULL
  //
  if (item_d != (TObject*)NULL) {
    return item_d->writeData(sof_a, pname_a);
  }
  else {
    return Error::handle(name(), L"writeData", ERR_NOITEM, __FILE__,
			 __LINE__);
  }

  // exit gracefully
  //
  return true;
}

//-----------------------------------------------------------------------------
//
// required equality methods
//
//-----------------------------------------------------------------------------

// method: eq
//
// arguments:
//  const Node<TObject>& arg: (input) the node to compare
//
// return: boolean value indicating test of equivalence
//
// this method compares two nodes for equivalence. two nodes are equivalent
// if their contents are equivalent.
//
template<class TObject>
boolean Node<TObject>::eq(const Node<TObject>& arg_a) const {
  
  // check for the case where the item is NULL
  // 
  if ((item_d != (TObject*)NULL) && (arg_a.item_d != (TObject*)NULL)) {

    // compare the two pointers. they won't often be equivalent, but
    // if they are then this is probably faster than comparing the
    // underlying objects.  if the pointers are not equivalent then
    // call the item compare method
    //
    return ((item_d == arg_a.item_d) || item_d->eq(*(arg_a.item_d)));
  }
  else {

    // if either item is NULL then error and return
    //
    return Error::handle(name(), L"eq", ERR_NOITEM, __FILE__,
			 __LINE__);  
  }
}

//-----------------------------------------------------------------------------
//
//  required memory management methods
//
//-----------------------------------------------------------------------------

// method: clear
//
// arguments:
//  Integral::CMODE cmode_a: (input) clear mode
//
// return: a boolean value indicating status
//
// this method clears the reference to the internal item.
// 
template<class TObject>
boolean Node<TObject>::clear(Integral::CMODE cmode_a) {
  
  // if the cmode_a is RETAIN, RESET or RELEASE
  //
  if ((cmode_a == Integral::RETAIN) ||
      (cmode_a == Integral::RESET) || (cmode_a == Integral::RELEASE)) {

    // clear the reference to the item
    //
    item_d = (TObject*)NULL;
  }

  // if the cmode_a is FREE, then delete all memory held in the structure
  //
  else if (cmode_a == Integral::FREE) {
    
    // clear the internal item
    //
    if (item_d != (TObject*)NULL) {
      
      // clear the lower level memory
      //
      item_d->clear(Integral::FREE);
      delete item_d;
      item_d = (TObject*)NULL;
    }
  }
  
  // exit gracefully
  // 
  return true;
}

// end of include file
//
#endif