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

#include <PXL_DeepChannelList.h>

+ Inheritance diagram for PXL_DeepChannelList:

Classes

class  ChannelInfo
 

Public Member Functions

 PXL_DeepChannelList ()
 
 ~PXL_DeepChannelList ()
 
void addChannel (const UT_StringHolder &name, int size, bool ord=false)
 Add a channel to the channel list. More...
 
int channelCount () const
 Number of channels in the channel list. More...
 
const UT_StringHoldername (int i) const
 Return the name of the given channel. More...
 
int tupleSize (int i) const
 Return tuple size of the given channel. More...
 
int offset (int i) const
 
bool isOrdinal (int i) const
 Return whether the channel data can be interpolated. More...
 
int maxSize () const
 Return the maximum tuple size of all channels. More...
 
int totalSize () const
 Return the sum of the sizes of all channels. More...
 
int findChannel (const char *name) const
 Return -1 if channel isn't found. More...
 
void dump (const char *msg="") const
 Dump the channel list to stdout. More...
 
bool isEqual (const PXL_DeepChannelList &src) const
 
bool operator== (const PXL_DeepChannelList &s)
 
bool operator!= (const PXL_DeepChannelList &s)
 
- Public Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepChannelList >
SYS_FORCE_INLINE UT_IntrusiveRefCounter ()
 Default constructor: Sets counter to 0. More...
 
SYS_FORCE_INLINE UT_IntrusiveRefCounter (const UT_IntrusiveRefCounter &)
 Copy constructor: Sets counter to 0. More...
 
UT_IntrusiveRefCounteroperator= (const UT_IntrusiveRefCounter &)
 Assignment operator: Does not modify counter. More...
 
SYS_FORCE_INLINE uint32 use_count () const
 Return current counter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from UT_IntrusiveRefCounter< PXL_DeepChannelList >
SYS_FORCE_INLINE ~UT_IntrusiveRefCounter ()
 Destructor: Only derived classes can destruct this. More...
 

Detailed Description

Definition at line 19 of file PXL_DeepChannelList.h.

Constructor & Destructor Documentation

PXL_DeepChannelList::PXL_DeepChannelList ( )
inline

Definition at line 52 of file PXL_DeepChannelList.h.

PXL_DeepChannelList::~PXL_DeepChannelList ( )
inline

Definition at line 57 of file PXL_DeepChannelList.h.

Member Function Documentation

void PXL_DeepChannelList::addChannel ( const UT_StringHolder name,
int  size,
bool  ord = false 
)
inline

Add a channel to the channel list.

Definition at line 60 of file PXL_DeepChannelList.h.

int PXL_DeepChannelList::channelCount ( ) const
inline

Number of channels in the channel list.

Definition at line 76 of file PXL_DeepChannelList.h.

void PXL_DeepChannelList::dump ( const char *  msg = "") const

Dump the channel list to stdout.

int PXL_DeepChannelList::findChannel ( const char *  name) const

Return -1 if channel isn't found.

bool PXL_DeepChannelList::isEqual ( const PXL_DeepChannelList src) const

Comparison

bool PXL_DeepChannelList::isOrdinal ( int  i) const
inline

Return whether the channel data can be interpolated.

Definition at line 89 of file PXL_DeepChannelList.h.

int PXL_DeepChannelList::maxSize ( ) const
inline

Return the maximum tuple size of all channels.

Definition at line 92 of file PXL_DeepChannelList.h.

const UT_StringHolder& PXL_DeepChannelList::name ( int  i) const
inline

Return the name of the given channel.

Definition at line 79 of file PXL_DeepChannelList.h.

int PXL_DeepChannelList::offset ( int  i) const
inline

Return the "offset" of a given channel. This assumes a linear array of interleaved channel data.

Definition at line 86 of file PXL_DeepChannelList.h.

Comparison

Definition at line 72 of file PXL_DeepChannelList.h.

bool PXL_DeepChannelList::operator== ( const PXL_DeepChannelList s)
inline

Comparison

Definition at line 71 of file PXL_DeepChannelList.h.

int PXL_DeepChannelList::totalSize ( ) const
inline

Return the sum of the sizes of all channels.

Definition at line 94 of file PXL_DeepChannelList.h.

int PXL_DeepChannelList::tupleSize ( int  i) const
inline

Return tuple size of the given channel.

Definition at line 82 of file PXL_DeepChannelList.h.


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