![]() |
VR-Forces 4.5 Class Documentation
|
Public Member Functions | |
| DtScriptedTaskMetaData () | |
| default constructor | |
| virtual | ~DtScriptedTaskMetaData () |
| destructor | |
| DtScriptedTaskMetaData (const DtScriptedTaskMetaData &orig) | |
| copy constructor | |
| DtScriptedTaskMetaData & | operator= (const DtScriptedTaskMetaData &orig) |
| assignment operator | |
| virtual bool | load (const DtFilename &) |
| Load data from specified file. | |
| virtual bool | load (const std::string &) |
| Loads the object from the given xml string buffer. | |
| virtual bool | load (std::istream &) |
| Loads the object from the given stream. | |
| virtual bool | hasUserEntryVariables () const |
| Returns true if there is a variable that allows user entry. | |
| virtual bool | save (const DtFilename &) const |
| Save file to given location. | |
| virtual bool | save (std::string &) const |
| Saves the value to the given string buffer. | |
| virtual bool | save (std::ostream &) const |
| Saves the object to the given stream. | |
| virtual bool | save () const |
| Saves to the last loaded filename. If not loaded will not save. | |
| virtual const DtFilename & | filename () const |
| File where this was loaded from. | |
| virtual const std::string & | scriptId () const |
| Accessor for script id. | |
| virtual void | setScriptId (const std::string &) |
| Sets the script id. Use with care as this could effect related referencing items. | |
| virtual void | setScriptType (int) |
| Sets the script type. | |
| virtual int | scriptType () const |
| Retrieves the script type. | |
| virtual bool | variable (const std::string &s, DtScriptedTaskVariable &var) const |
| Returns the variable associated with the given variable. | |
| virtual void | assignNewScriptId () |
| Assigns a new unique id to this meta data. | |
| virtual bool | supports (const DtEntityType &) const |
| Returns true if this script supports the specific entity type. | |
| bool | operator== (const DtScriptedTaskMetaData &) const |
| Equality operators. | |
| bool | operator!= (const DtScriptedTaskMetaData &rhs) const |
| virtual bool | encrypt (const std::string &source, std::string &dest) const |
| Return true if buffer was encrypted. | |
| virtual bool | encryptScript () |
| If there is an encryption routine, encrypt the script back into the myScript member. | |
| virtual bool | encryptSize (const std::string &source, int &size) const |
| Return the size of the encrypted buffer'. | |
| virtual bool | decrypt (const std::string &source, std::string &dest) const |
| Returns true if buffer successfully decrypted. | |
| virtual bool | decryptScript () |
| If the script is encrypted, decrypt into myScript. | |
| virtual std::auto_ptr < DtRwVariableBindings > | upgradeVariables (const DtRwVariableBindings &) const |
| Upgrade the supplied variables and return a pointer to the new variables that will include missing variable parameters. | |
| virtual std::string | removeTrailingLinefeeds (const std::string &) |
| Removes trailing CR/LFs if there are multiple. | |
| virtual void | setMenuText (const std::string &) |
| virtual const std::string & | menuText () const |
| virtual void | setExtendedMenuText (const std::string &) |
| virtual const std::string & | extendedMenuText () const |
| virtual void | setToolTip (const std::string &) |
| virtual const std::string & | toolTip () const |
| virtual void | setMenuIcon (const std::string &) |
| virtual const std::string & | menuIcon () const |
| virtual void | setVersion (double) |
| virtual double | version () const |
| virtual void | setPriority (int) |
| virtual int | priority () const |
| virtual void | setEnabled (bool) |
| virtual bool | enabled () const |
| virtual void | setShortDescription (const std::string &) |
| virtual const std::string & | shortDescription () const |
| virtual void | setScriptEngine (const std::string &) |
| virtual const std::string & | scriptEngine () const |
| virtual bool | isInterpretedScript () const |
| Returns true if the script engine in question is one that is loaded and executed via a parse (such as lua). | |
| virtual void | setComments (const std::string &) |
| virtual const std::string & | comments () const |
| virtual void | setDescription (const std::string &) |
| virtual const std::string & | description () const |
| virtual void | setScriptLocation (const std::string &) |
| virtual const std::string & | scriptLocation () const |
| virtual void | setMenuLocations (const std::vector< std::string > &) |
| virtual void | addMenuLocation (const std::string &) |
| virtual void | removeMenuLocation (const std::string &) |
| virtual void | removeMenuLocation (int) |
| virtual const std::vector < std::string > & | menuLocations () const |
| virtual void | setShowInMenu (bool) |
| virtual bool | showInMenu () const |
| virtual void | setToolbarLocation (const std::string &) |
| virtual const std::string & | toolbarLocation () const |
| virtual void | setShowInToolbar (bool) |
| virtual bool | showInToolbar () const |
| virtual void | setEntityTypes (const std::vector< DtEntityType > &) |
| virtual void | addEntityType (const DtEntityType &) |
| virtual void | removeEntityType (const DtEntityType &) |
| virtual void | removeEntityType (int) |
| virtual std::vector< DtEntityType > | entityTypes () const |
| virtual bool | supportsEntityType (const DtEntityType &) const |
| virtual bool | hasEntityType (const DtEntityType &) const |
| Returns true if the specific entity type is there. | |
| virtual void | setVariables (const std::vector< DtScriptedTaskVariable > &) |
| virtual void | addVariable (const DtScriptedTaskVariable &) |
| virtual void | insertVariableBefore (const DtScriptedTaskVariable &, const std::string &variable) |
| virtual void | insertVariableBefore (const DtScriptedTaskVariable &, int i) |
| virtual void | removeVariable (const std::string &) |
| virtual void | removeVariable (int) |
| virtual std::vector < DtScriptedTaskVariable > | variables () const |
| virtual DtRwVariableBindings * | defaultVariableBindings () const |
| Returns a variable binding list of all the variables default values. | |
| virtual void | setupDefaultsFromBindings (const DtRwVariableBindings &) |
| Sets the default variables from the bindings. | |
| virtual void | setScript (const std::string &) |
| virtual const std::string & | script () const |
| virtual bool | loadScript () |
| Loads the script from the location of this meta data file or from the file defined in scriptLocation. | |
| virtual bool | loadScript (const std::string &) |
| Loads the script from the specified file and replaces the existing script with it. | |
| virtual void | setIsSystemScript (bool) |
| virtual bool | isSystemScript () const |
| virtual void | setActionCategories (const std::set< std::string > &) |
| virtual void | addActionCategory (const std::string &) |
| virtual void | removeActionCategory (const std::string &) |
| virtual bool | hasActionCategory (const std::string &) const |
| virtual const std::set < std::string > & | actionCategories () const |
| virtual void | setDoctrines (const std::set< std::string > &) |
| virtual bool | addDoctrine (const std::string &) |
| virtual bool | removeDoctrine (const std::string &) |
| virtual bool | supportsDoctrine (const std::string &) const |
| virtual const std::set < std::string > & | doctrines () const |
| virtual bool | renameDoctrine (const std::string &from, const std::string &to) |
| virtual void | setAvailableToAllDoctrines (bool) |
| virtual bool | availableToAllDoctrines () const |
| virtual void | setShowOnTopLevelRightClickMenu (bool) |
| virtual bool | showOnTopLevelRightClickMenu () const |
| virtual void | setDirectoryPath (const std::string &) |
| virtual const std::string & | directoryPath () const |
| virtual void | setEncrypted (bool) |
| virtual bool | encrypted () const |
| virtual void | setFlag (int, bool) |
| virtual bool | flagSet (int) const |
| virtual void | loadTranslationFile (const std::string &lang) |
| virtual void | translationData (char *&data, unsigned int &len) const |
| virtual std::string | translationLanguage () const |
| virtual void | clearTranslationData () |
Static Public Member Functions | |
| static void | setEncryptDecryptFunction (DtEncryptDecryptFcn, void *usr) |
| Sets encrypt/decrypt function. | |
| static void | getEncryptDecryptFunction (DtEncryptDecryptFcn &, void *&usr) |
| static void | addInterpretedScriptEngine (const std::string &) |
| static bool | isInterpretedScriptEngine (const std::string &) |
Public Attributes | |
| std::string | myScriptId |
| std::string | myMenuText |
| std::string | myExtendedMenuText |
| std::string | myToolTip |
| std::string | myMenuIcon |
| std::string | myScriptEngine |
| std::string | myComments |
| std::string | myDescription |
| std::string | myScriptLocation |
| std::string | myShortDescription |
| std::string | myScript |
| std::string | myDirectoryPath |
| std::vector< std::string > | myMenuLocations |
| std::vector< std::string > | myEntityTypes |
| std::vector< std::string > | myVariables |
| std::map< std::string, DtScriptedTaskVariable > | myCachedVariables |
| std::string | myActionCategories |
| std::string | myDoctrines |
| bool | myShowInMenu |
| std::string | myToolbarLocation |
| bool | myShowInToolbar |
| std::set< std::string > | myActionCategoriesSet |
| std::set< std::string > | myDoctrinesSet |
| double | myVersion |
| DtFilename | myFile |
| bool | myIsSystemScript |
| bool | myEncrypted |
| int | myScriptType |
| int | myFlags |
| char * | myTranslationData |
| DtU64 | myTranslationDataLen |
| std::string | myTranslationLanguage |
Static Public Attributes | |
| static DtEncryptDecryptFcn | theEncryptDecryptFunction |
| static void * | theEncryptDecryptUserData |
| static std::vector< std::string > | theInterpretedScriptEngines |
Protected Member Functions | |
| template<class Archive > | |
| void | serialize (Archive &ar, const unsigned int version) |
| When the class Archive corresponds to an output archive, the & operator is defined similar to <<. | |
Friends | |
| class | boost::serialization::access |
| Serialization/Deserialization //! | |
| DtScriptedTaskMetaData::DtScriptedTaskMetaData | ( | ) |
default constructor
|
virtual |
destructor
| DtScriptedTaskMetaData::DtScriptedTaskMetaData | ( | const DtScriptedTaskMetaData & | orig | ) |
copy constructor
| DtScriptedTaskMetaData& DtScriptedTaskMetaData::operator= | ( | const DtScriptedTaskMetaData & | orig | ) |
assignment operator
|
virtual |
Load data from specified file.
|
virtual |
Loads the object from the given xml string buffer.
|
virtual |
Loads the object from the given stream.
|
virtual |
Returns true if there is a variable that allows user entry.
|
virtual |
Save file to given location.
If no previously loaded filename will set filename to the supplied name
|
virtual |
Saves the value to the given string buffer.
|
virtual |
Saves the object to the given stream.
|
virtual |
Saves to the last loaded filename. If not loaded will not save.
|
virtual |
File where this was loaded from.
If saved to a different file will not change the location
|
virtual |
Accessor for script id.
Set as part of the constructor and assigned in the copy/equivalence operator
|
virtual |
Sets the script id. Use with care as this could effect related referencing items.
|
virtual |
Sets the script type.
|
virtual |
Retrieves the script type.
|
virtual |
Accessor for menu text. This is the name that will appear on menus
|
virtual |
|
virtual |
Accessor for extended menu text. This is the name that will appear on menus
|
virtual |
|
virtual |
Accessors for menu tool-tip
|
virtual |
|
virtual |
Accessors for menu icon
|
virtual |
|
virtual |
Accessors for version. When the task is sent to the back-end for processing, the version will be packaged as part of the variables available for the task
|
virtual |
|
virtual |
Accessors for priority. If the task is a reactive task then this priority is where it will be executed
|
virtual |
|
virtual |
Accessors for enabled/disabled state. If the task is a reactive task then this will determine if the reactive task is enabled or disabled by default
|
virtual |
|
virtual |
The description that will be used in the plan language or when displaying the current task instead of the stringRep which is the display of all the variables. To display a variable value use the $<var-name> nomenclature, so, Move To Location $location.
|
virtual |
|
virtual |
Returns the variable associated with the given variable.
If no variable of that name returns false
|
virtual |
Accessor for script engine to use when evaluating script. Default is LUA
|
virtual |
|
virtual |
Returns true if the script engine in question is one that is loaded and executed via a parse (such as lua).
Use the static addInterpretedScriptEngine to add a script engine that will return true for this
|
static |
Add an interpreted script engine. Once added cannot be removed
|
static |
|
virtual |
Accessor for comments that can be used to describe this task. Will not be displayed to the user
|
virtual |
|
virtual |
Accessor for comments that can be used to describe this task. Will be displayed to the user on the task data entry form
|
virtual |
|
virtual |
Location where to find the script file to execute. If blank (default) assumes same location as meta-data file
|
virtual |
|
virtual |
Accessor for locations where on the task menu this script should show up. Currently assumed to only be on task menu
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Accessor for location where on the task toolbar this script should show up.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Accessor for entity types that this task is valid for. An empty list will make the assumption it is valid for all entity types (default)
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns true if the specific entity type is there.
|
virtual |
Accessor for the variables that are part of this scripted task. The variables will be referenced by their bound name. The order in which they appear in the UI will be the order in which they appear in the variables list
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns a variable binding list of all the variables default values.
This is to be considered a read-only view into the default values. You must also free the return pointer when you are done with it
|
virtual |
Sets the default variables from the bindings.
|
virtual |
The actual script code loaded from disk or saved with the meta data
|
virtual |
|
virtual |
Loads the script from the location of this meta data file or from the file defined in scriptLocation.
|
virtual |
Loads the script from the specified file and replaces the existing script with it.
|
virtual |
Accessor for whether or not this is a system vs. scenario level script
|
virtual |
|
virtual |
Keeps list of action categories that this script is part of
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Keeps list of doctrine categories that this script is part of
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Whether or not this item is available on the top of the right click menu
|
virtual |
|
virtual |
Accessor for the directory location. The directory location is a path separated by the / marker. A blank directory path means this script is a top-level script.
|
virtual |
|
virtual |
Assigns a new unique id to this meta data.
|
virtual |
Returns true if this script supports the specific entity type.
| bool DtScriptedTaskMetaData::operator== | ( | const DtScriptedTaskMetaData & | ) | const |
Equality operators.
|
inline |
|
static |
Sets encrypt/decrypt function.
|
static |
|
virtual |
Return true if buffer was encrypted.
|
virtual |
If there is an encryption routine, encrypt the script back into the myScript member.
|
virtual |
Return the size of the encrypted buffer'.
|
virtual |
Returns true if buffer successfully decrypted.
|
virtual |
If the script is encrypted, decrypt into myScript.
Note that calling decryptScript on a script that is already decrypted will have unexpected results
|
virtual |
Upgrade the supplied variables and return a pointer to the new variables that will include missing variable parameters.
|
virtual |
Sets/gets whether or not buffer should be encrypted/decrypted. If there is an encrypt/decrypt function set that will be used when saving the scripted task to a scenario to determine if the buffer should be encrypted. If a system script, set as to whether or not the file on disk is encrypted
|
virtual |
|
virtual |
If there is translation data associated with this file it can be set here. Note that this data is not saved with the xml or lua file. It will be transported over the network, however, if requested. The language file is expectd to be of the format <script_id>_<lang>.qm. Only one language at a time will be stored. If another language is loaded the data from the previous language will be removed
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Removes trailing CR/LFs if there are multiple.
|
inlineprotected |
When the class Archive corresponds to an output archive, the & operator is defined similar to <<.
Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.
References DtScriptedTask_AvailableToAllDoctrines, and DtScriptedTaskScriptedTask.
|
friend |
Serialization/Deserialization //!
| std::string DtScriptedTaskMetaData::myScriptId |
| std::string DtScriptedTaskMetaData::myMenuText |
| std::string DtScriptedTaskMetaData::myExtendedMenuText |
| std::string DtScriptedTaskMetaData::myToolTip |
| std::string DtScriptedTaskMetaData::myMenuIcon |
| std::string DtScriptedTaskMetaData::myScriptEngine |
| std::string DtScriptedTaskMetaData::myComments |
| std::string DtScriptedTaskMetaData::myDescription |
| std::string DtScriptedTaskMetaData::myScriptLocation |
| std::string DtScriptedTaskMetaData::myShortDescription |
|
mutable |
| std::string DtScriptedTaskMetaData::myDirectoryPath |
| std::vector<std::string> DtScriptedTaskMetaData::myMenuLocations |
| std::vector<std::string> DtScriptedTaskMetaData::myEntityTypes |
| std::vector<std::string> DtScriptedTaskMetaData::myVariables |
|
mutable |
| std::string DtScriptedTaskMetaData::myActionCategories |
| std::string DtScriptedTaskMetaData::myDoctrines |
| bool DtScriptedTaskMetaData::myShowInMenu |
| std::string DtScriptedTaskMetaData::myToolbarLocation |
| bool DtScriptedTaskMetaData::myShowInToolbar |
|
mutable |
|
mutable |
| double DtScriptedTaskMetaData::myVersion |
|
mutable |
| bool DtScriptedTaskMetaData::myIsSystemScript |
|
mutable |
|
static |
|
static |
| int DtScriptedTaskMetaData::myScriptType |
| int DtScriptedTaskMetaData::myFlags |
| char* DtScriptedTaskMetaData::myTranslationData |
| DtU64 DtScriptedTaskMetaData::myTranslationDataLen |
| std::string DtScriptedTaskMetaData::myTranslationLanguage |
|
static |