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

#include <OP_OTLDefinition.h>

Public Member Functions

 OP_OTLDefinition ()
 
 OP_OTLDefinition (const OP_OTLDefinition &definition)
 
virtual ~OP_OTLDefinition ()
 
const UT_StringgetName () const
 
void setName (const char *name)
 
const UT_StringgetLabel () const
 
void setLabel (const char *label)
 
const UT_StringgetPath () const
 
void setPath (const char *path)
 
const UT_StringgetIcon () const
 
void setIcon (const char *icon)
 
const UT_StringgetAuthor () const
 
void setAuthor (const char *author)
 
const UT_StringgetCopyright () const
 
void setCopyright (const char *copyright)
 
const UT_StringgetOpTableName () const
 
void setOpTableName (const char *optablename)
 
const UT_StringgetIndexPath () const
 
void setIndexPath (const char *indexpath)
 
const UT_StringgetIndexFile () const
 
void setIndexFile (const char *indexfile)
 
const UT_StringgetLicenseInfo () const
 
void setLicenseInfo (const char *licenseinfo)
 
const UT_StringgetExtraInfo () const
 
void setExtraInfo (const char *extrainfo)
 
const UT_StringgetUserInfo () const
 
void setUserInfo (const char *userinfo)
 
int getMinInputs () const
 
void setMinInputs (int inputs)
 
int getMaxInputs () const
 
void setMaxInputs (int inputs)
 
int getMaxOutputs () const
 
void setMaxOutputs (int outputs)
 
int getModTime () const
 
void setModTime (int modtime)
 
bool getIsSubnet () const
 
void setIsSubnet (bool issubnet)
 
bool getIsPython () const
 
void setIsPython (bool ispython)
 
bool getIsDummyDefinition () const
 
void setIsDummyDefinition (bool isdummy)
 
OP_OTLLicenseType getCachedLicenseType () const
 
void setCachedLicenseType (OP_OTLLicenseType type)
 
const UT_StringHoldergetErrorMessage () const
 
bool isInternal () const
 
int handleOption (int argc, char *argv[])
 
void getTableAndName (UT_WorkBuffer &name) const
 
void getTableAndName (UT_String &name) const
 
OP_OpTypeId getOpTypeId () const
 
const OP_OTLDefinitionoperator= (const OP_OTLDefinition &src)
 
bool load (UT_IStream &is)
 
bool save (std::ostream &os)
 
void writeTextDescription (UT_WorkBuffer &buffer, const char *indent=0) const
 
void writeFormattedText (UT_WorkBuffer &buffer, const char *format) const
 
bool readTextDescription (UT_IStream &is)
 
void constructDefinitionPath (UT_String &path) const
 
void getDefinitionSectionName (UT_String &sectname) const
 
void getDefinitionSectionName (UT_WorkBuffer &sectname) const
 

Static Public Member Functions

static int getModTimeFromString (const char *str)
 Utility function for converting a string to a modification time. More...
 
static bool isValidOperatorName (const char *name)
 
static bool isMatchingNamespaceScope (const char *op_name, const char *scope_opname)
 

Detailed Description

Definition at line 32 of file OP_OTLDefinition.h.

Constructor & Destructor Documentation

OP_OTLDefinition::OP_OTLDefinition ( )
OP_OTLDefinition::OP_OTLDefinition ( const OP_OTLDefinition definition)
virtual OP_OTLDefinition::~OP_OTLDefinition ( )
virtual

Member Function Documentation

void OP_OTLDefinition::constructDefinitionPath ( UT_String path) const

Returns an official file path that should be used for a given definition, eg "oplib:/Object/hda?Object/hda".

const UT_String& OP_OTLDefinition::getAuthor ( ) const
inline

Definition at line 55 of file OP_OTLDefinition.h.

OP_OTLLicenseType OP_OTLDefinition::getCachedLicenseType ( ) const
inline

Definition at line 115 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getCopyright ( ) const
inline

Definition at line 59 of file OP_OTLDefinition.h.

void OP_OTLDefinition::getDefinitionSectionName ( UT_String sectname) const

Returns an official name of the library section that contains the HDA definition eg "Object/hda", or "artistA::Object/hda::2.0". See UT_OpUtils::getOpTypeDefSectionName() for more details.

void OP_OTLDefinition::getDefinitionSectionName ( UT_WorkBuffer sectname) const

Returns an official name of the library section that contains the HDA definition eg "Object/hda", or "artistA::Object/hda::2.0". See UT_OpUtils::getOpTypeDefSectionName() for more details.

const UT_StringHolder& OP_OTLDefinition::getErrorMessage ( ) const
inline

Definition at line 120 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getExtraInfo ( ) const
inline

Definition at line 79 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getIcon ( ) const
inline

Definition at line 51 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getIndexFile ( ) const
inline

Definition at line 71 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getIndexPath ( ) const
inline

Definition at line 67 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsDummyDefinition ( ) const
inline

Definition at line 111 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsPython ( ) const
inline

Definition at line 107 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsSubnet ( ) const
inline

Definition at line 103 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getLabel ( ) const
inline

Definition at line 43 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getLicenseInfo ( ) const
inline

Definition at line 75 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMaxInputs ( ) const
inline

Definition at line 91 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMaxOutputs ( ) const
inline

Definition at line 95 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMinInputs ( ) const
inline

Definition at line 87 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getModTime ( ) const
inline

Definition at line 99 of file OP_OTLDefinition.h.

static int OP_OTLDefinition::getModTimeFromString ( const char *  str)
static

Utility function for converting a string to a modification time.

const UT_String& OP_OTLDefinition::getName ( void  ) const
inline

Definition at line 39 of file OP_OTLDefinition.h.

const UT_String& OP_OTLDefinition::getOpTableName ( ) const
inline

Definition at line 63 of file OP_OTLDefinition.h.

OP_OpTypeId OP_OTLDefinition::getOpTypeId ( ) const
const UT_String& OP_OTLDefinition::getPath ( ) const
inline

Definition at line 47 of file OP_OTLDefinition.h.

void OP_OTLDefinition::getTableAndName ( UT_WorkBuffer name) const
void OP_OTLDefinition::getTableAndName ( UT_String name) const
const UT_String& OP_OTLDefinition::getUserInfo ( ) const
inline

Definition at line 83 of file OP_OTLDefinition.h.

int OP_OTLDefinition::handleOption ( int  argc,
char *  argv[] 
)
bool OP_OTLDefinition::isInternal ( ) const
static bool OP_OTLDefinition::isMatchingNamespaceScope ( const char *  op_name,
const char *  scope_opname 
)
static

Returns true if op_name includes a namespace and that namesapce matches the given scope_opname, e.g., op_name of "Object/geo::op" matches scope_name of "Object/geo". If op_name does not include a namespace, it is allowed everywhere, so it will match any scope, thus this function will return true. Returns false otherwise.

static bool OP_OTLDefinition::isValidOperatorName ( const char *  name)
static

Returns true if the name is a valid operator name that can be used for an OP_Operator instance.

bool OP_OTLDefinition::load ( UT_IStream is)
const OP_OTLDefinition& OP_OTLDefinition::operator= ( const OP_OTLDefinition src)
bool OP_OTLDefinition::readTextDescription ( UT_IStream is)
bool OP_OTLDefinition::save ( std::ostream &  os)
void OP_OTLDefinition::setAuthor ( const char *  author)
inline

Definition at line 57 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setCachedLicenseType ( OP_OTLLicenseType  type)
inline

Definition at line 117 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setCopyright ( const char *  copyright)
inline

Definition at line 61 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setExtraInfo ( const char *  extrainfo)
inline

Definition at line 81 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIcon ( const char *  icon)
inline

Definition at line 53 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIndexFile ( const char *  indexfile)
inline

Definition at line 73 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIndexPath ( const char *  indexpath)
inline

Definition at line 69 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsDummyDefinition ( bool  isdummy)
inline

Definition at line 113 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsPython ( bool  ispython)
inline

Definition at line 109 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsSubnet ( bool  issubnet)
inline

Definition at line 105 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setLabel ( const char *  label)
inline

Definition at line 45 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setLicenseInfo ( const char *  licenseinfo)
inline

Definition at line 77 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMaxInputs ( int  inputs)
inline

Definition at line 93 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMaxOutputs ( int  outputs)
inline

Definition at line 97 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMinInputs ( int  inputs)
inline

Definition at line 89 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setModTime ( int  modtime)
inline

Definition at line 101 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setName ( const char *  name)
inline

Definition at line 41 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setOpTableName ( const char *  optablename)
inline

Definition at line 65 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setPath ( const char *  path)
inline

Definition at line 49 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setUserInfo ( const char *  userinfo)
inline

Definition at line 85 of file OP_OTLDefinition.h.

void OP_OTLDefinition::writeFormattedText ( UT_WorkBuffer buffer,
const char *  format 
) const
void OP_OTLDefinition::writeTextDescription ( UT_WorkBuffer buffer,
const char *  indent = 0 
) const

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