HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
GA_AIFStat Class Reference

Class to fill GA_Stat information about an attribute. This AIF is used to fill GA_Stat type information about an attribute. The string generated by the info() method will be appended to the GA_Stat::myPointAttributes (or other attribute lists). More...

#include <GA_AIFStat.h>

Public Member Functions

 GA_AIFStat ()
 
virtual ~GA_AIFStat ()
 
virtual bool info (const GA_Attribute *attrib, UT_WorkBuffer &info, uint level) const
 

Detailed Description

Class to fill GA_Stat information about an attribute. This AIF is used to fill GA_Stat type information about an attribute. The string generated by the info() method will be appended to the GA_Stat::myPointAttributes (or other attribute lists).

The default method is typically sufficient for most attributes.

Definition at line 30 of file GA_AIFStat.h.

Constructor & Destructor Documentation

GA_AIFStat::GA_AIFStat ( )
virtual GA_AIFStat::~GA_AIFStat ( )
virtual

Member Function Documentation

virtual bool GA_AIFStat::info ( const GA_Attribute attrib,
UT_WorkBuffer info,
uint  level 
) const
virtual

Fill out GA_Stat information about the given attribute.

Parameters
attrib- The attribute to stat
info- The buffer containing the resulting stat information
level- The verbosity level (see GA_STAT_LEVEL)
Returns
false if no stat information was filled out

The base class implementation will be sufficient for most attributes.

  • If the attribute has no GA_AIFJSON implementation (that is, the attribute can't be saved or loaded), then the info() method will return false.
  • If the attribute has a GA_AIFTuple interface, the info will be
    info.sprintf("%s %s::%s[%d]", tuple->getStorage(),
    getType().getName(), getName(), tuple->getTupleSize());
  • Otherwise, the format will be
    info.sprintf("%s::%s", getType().getName(), getName());

The documentation for this class was generated from the following file: