Logo Search packages:      
Sourcecode: 3depict version File versions  Download package

ExternalProgramFilter Class Reference

#include <filter.h>

Inheritance diagram for ExternalProgramFilter:


List of all members.

Detailed Description

External program filter.

Definition at line 937 of file filter.h.

Public Member Functions

bool canBeHazardous () const
 As this launches external programs, this could be misused.
virtual void clearCache ()
 Erase cache.
FiltercloneUncached () const
 Duplicate filter contents, excluding cache.
std::string getErrString (unsigned int code) const
 Get the human readable error string associated with a particular error code during refresh(...).
unsigned int getNumOutput (unsigned int streamType) const
 Get the number of outputs for the specified type during the filter's last refresh.
void getOutputData (std::vector< FilterStreamData * > *&getOut)
 Get the filter output data from this filter.
void getProperties (FilterProperties &propertyList) const
 Get the properties of the filter, in key-value form. First vector is for each output.
void getSelectionDevices (vector< SelectionDevice * > &devices)
 Get the selection devices for this filter. MUST be called after refresh().
unsigned int getType () const
virtual std::string getUserString () const
 Return a user-specified string, or just the typestring if user set string not active.
bool haveCache () const
 Have cached output data?
bool isEnabled () const
virtual size_t numBytesForCache (size_t nObjects) const
 Returns cache size as a function fo input.
bool readState (xmlNodePtr &node)
 Read the state of the filter from XML file. If this.
unsigned int refresh (const std::vector< const FilterStreamData * > &dataIn, std::vector< const FilterStreamData * > &getOut, unsigned int &progress, bool(*callback)(void))
 Apply filter to new data, updating cache as needed. Vector of returned pointers must be deleted manually, first checking ->cached.
void setCaching (bool enableCache)
 Enable/disable caching for this filter.
bool setProperty (unsigned int set, unsigned int key, const std::string &value, bool &needUpdate)
 Set the properties for the nth filter.
void setPropFromBinding (const SelectionBinding &b)
 Set internal property value using a selection binding (Disabled, this filter has no bindings).
virtual void setUserString (const std::string &str)
 Set a user-specified string.
virtual std::string typeString () const
 Return filter type as std::string.
void updateOutputInfo (const std::vector< const FilterStreamData * > &dataOut)
 Update the output informaiton for this filter.
bool writeState (std::ofstream &f, unsigned int format, unsigned int depth=0) const
 Dump state to output stream, using specified format.

Protected Attributes

bool cache
bool cacheOK
std::vector< SelectionDevice * > devices
 User interaction "Devices" associated with this filter.
bool enabled
 Is this filter active?
std::vector< FilterStreamData * > filterOutputs
unsigned int numStreamsLastRefresh [NUM_STREAM_TYPES]
 Array of the number of streams propagated on last refresh.
unsigned int progress
std::string userString
 User settable labelling string (human readable ID, etc etc).

Private Attributes

bool alwaysCache
 Always cache output from program.
std::string commandLine
 The command line strings; prior to expansion.
std::string workingDir
 Working directory for program.

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

Generated by  Doxygen 1.6.0   Back to index