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

#include <OP_OTLDefinition.h>

Public Member Functions

 OP_OTLDefinition ()
 
 OP_OTLDefinition (const OP_OTLDefinition &definition)=default
 
OP_OTLDefinitionoperator= (const OP_OTLDefinition &src)=default
 
const UT_StringHoldergetName () const
 
void setName (const UT_StringHolder &name)
 
const UT_StringHoldergetLabel () const
 
void setLabel (const UT_StringHolder &label)
 
const UT_StringHoldergetPath () const
 
void setPath (const UT_StringHolder &path)
 
const UT_StringHoldergetIcon () const
 
void setIcon (const UT_StringHolder &icon)
 
const UT_StringHoldergetAuthor () const
 
void setAuthor (const UT_StringHolder &author)
 
const UT_StringHoldergetCopyright () const
 
void setCopyright (const UT_StringHolder &copyright)
 
const UT_StringHoldergetOpTableName () const
 
void setOpTableName (const UT_StringHolder &optablename)
 
const UT_StringHoldergetIndexPath () const
 
void setIndexPath (const UT_StringHolder &indexpath)
 
const UT_StringHoldergetIndexFile () const
 
void setIndexFile (const UT_StringHolder &indexfile)
 
const UT_StringHoldergetLicenseInfo () const
 
void setLicenseInfo (const UT_StringHolder &licenseinfo)
 
const UT_StringHoldergetExtraInfo () const
 
void setExtraInfo (const UT_StringHolder &extrainfo)
 
const UT_StringHoldergetUserInfo () const
 
void setUserInfo (const UT_StringHolder &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)
 
bool isInternal () const
 Return if this is an internally defined operator. More...
 
void setPathToInternal ()
 Mark as internal. More...
 
int handleOption (int argc, char *argv[])
 
void getTableAndName (UT_WorkBuffer &name) const
 
void getTableAndName (UT_String &name) const
 
OP_OpTypeId getOpTypeId () const
 
bool load (UT_IStream &is, UT_StringHolder *errors=nullptr)
 
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 34 of file OP_OTLDefinition.h.

Constructor & Destructor Documentation

OP_OTLDefinition::OP_OTLDefinition ( )
OP_OTLDefinition::OP_OTLDefinition ( const OP_OTLDefinition definition)
default

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_StringHolder& OP_OTLDefinition::getAuthor ( ) const
inline

Definition at line 58 of file OP_OTLDefinition.h.

OP_OTLLicenseType OP_OTLDefinition::getCachedLicenseType ( ) const
inline

Definition at line 118 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getCopyright ( ) const
inline

Definition at line 62 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::getExtraInfo ( ) const
inline

Definition at line 82 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getIcon ( ) const
inline

Definition at line 54 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getIndexFile ( ) const
inline

Definition at line 74 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getIndexPath ( ) const
inline

Definition at line 70 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsDummyDefinition ( ) const
inline

Definition at line 114 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsPython ( ) const
inline

Definition at line 110 of file OP_OTLDefinition.h.

bool OP_OTLDefinition::getIsSubnet ( ) const
inline

Definition at line 106 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getLabel ( ) const
inline

Definition at line 46 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getLicenseInfo ( ) const
inline

Definition at line 78 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMaxInputs ( ) const
inline

Definition at line 94 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMaxOutputs ( ) const
inline

Definition at line 98 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getMinInputs ( ) const
inline

Definition at line 90 of file OP_OTLDefinition.h.

int OP_OTLDefinition::getModTime ( ) const
inline

Definition at line 102 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_StringHolder& OP_OTLDefinition::getName ( void  ) const
inline

Definition at line 42 of file OP_OTLDefinition.h.

const UT_StringHolder& OP_OTLDefinition::getOpTableName ( ) const
inline

Definition at line 66 of file OP_OTLDefinition.h.

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

Definition at line 50 of file OP_OTLDefinition.h.

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

Definition at line 86 of file OP_OTLDefinition.h.

int OP_OTLDefinition::handleOption ( int  argc,
char *  argv[] 
)
bool OP_OTLDefinition::isInternal ( ) const
inline

Return if this is an internally defined operator.

Definition at line 124 of file OP_OTLDefinition.h.

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,
UT_StringHolder errors = nullptr 
)
OP_OTLDefinition& OP_OTLDefinition::operator= ( const OP_OTLDefinition src)
default
bool OP_OTLDefinition::readTextDescription ( UT_IStream is)
bool OP_OTLDefinition::save ( std::ostream &  os)
void OP_OTLDefinition::setAuthor ( const UT_StringHolder author)
inline

Definition at line 60 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setCachedLicenseType ( OP_OTLLicenseType  type)
inline

Definition at line 120 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setCopyright ( const UT_StringHolder copyright)
inline

Definition at line 64 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setExtraInfo ( const UT_StringHolder extrainfo)
inline

Definition at line 84 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIcon ( const UT_StringHolder icon)
inline

Definition at line 56 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIndexFile ( const UT_StringHolder indexfile)
inline

Definition at line 76 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIndexPath ( const UT_StringHolder indexpath)
inline

Definition at line 72 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsDummyDefinition ( bool  isdummy)
inline

Definition at line 116 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsPython ( bool  ispython)
inline

Definition at line 112 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setIsSubnet ( bool  issubnet)
inline

Definition at line 108 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setLabel ( const UT_StringHolder label)
inline

Definition at line 48 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setLicenseInfo ( const UT_StringHolder licenseinfo)
inline

Definition at line 80 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMaxInputs ( int  inputs)
inline

Definition at line 96 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMaxOutputs ( int  outputs)
inline

Definition at line 100 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setMinInputs ( int  inputs)
inline

Definition at line 92 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setModTime ( int  modtime)
inline

Definition at line 104 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setName ( const UT_StringHolder name)
inline

Definition at line 44 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setOpTableName ( const UT_StringHolder optablename)
inline

Definition at line 68 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setPath ( const UT_StringHolder path)
inline

Definition at line 52 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setPathToInternal ( )
inline

Mark as internal.

Definition at line 128 of file OP_OTLDefinition.h.

void OP_OTLDefinition::setUserInfo ( const UT_StringHolder userinfo)
inline

Definition at line 88 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: