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

#include <VOP_OutputInfo.h>

Public Member Functions

 VOP_OutputInfo (VOP_Node *parent_node, const char *output_name)
 
 ~VOP_OutputInfo ()
 
void setDebugMode (EOutputModeType mode)
 Sets the behaviour type for this output in the debug mode. More...
 
void setBypassedMode (EOutputModeType mode)
 Sets the behaviour type for this output in the bypass mode. More...
 
EOutputModeType getDebugMode (void)
 
EOutputModeType getBypassMode (void)
 
UT_OptionsgetDebugValuePtr (void)
 Retrieves the constant value pointer for the debug mode. More...
 
UT_OptionsgetBypassValuePtr (void)
 Retrieves the constant value pointer for the release mode. More...
 
void appendOutputOverrideCode (UT_String &str_code, bool is_in_debug_mode, bool is_in_bypass_mode)
 
int getIndex (void)
 Returns the index of the output this info applies to. More...
 
void getOutputVariableCode (UT_String &var_code)
 
bool save (std::ostream &os, bool is_binary)
 
bool load (UT_IStream &is)
 
const char * getOutputName (void)
 Returns the name of the output this info applies to. More...
 
const char * getDebugCorrespondingInputName (void)
 
const char * getBypassCorrespondingInputName (void)
 
void setDebugCorrespondingInputName (const char *input_name)
 
void setBypassCorrespondingInputName (const char *input_name)
 
void setUseDefaultValue (bool val)
 
bool getUseDefaultValue ()
 
int findCorrespondingInput (bool is_in_debug_mode, bool is_in_bypass_mode)
 

Static Public Member Functions

static int autoFindCorrespondingInput (VOP_Node *node, const char *output_name)
 

Detailed Description

Definition at line 68 of file VOP_OutputInfo.h.

Constructor & Destructor Documentation

VOP_OutputInfo::VOP_OutputInfo ( VOP_Node parent_node,
const char *  output_name 
)
VOP_OutputInfo::~VOP_OutputInfo ( )

Member Function Documentation

void VOP_OutputInfo::appendOutputOverrideCode ( UT_String str_code,
bool  is_in_debug_mode,
bool  is_in_bypass_mode 
)
static int VOP_OutputInfo::autoFindCorrespondingInput ( VOP_Node node,
const char *  output_name 
)
static

Attempts to find an input which best corresponds to the output with the name specified on the given node.

int VOP_OutputInfo::findCorrespondingInput ( bool  is_in_debug_mode,
bool  is_in_bypass_mode 
)

Attempts to find an input which (logically) corresponds to this output, and returns its index if found or -1 otherwise. Note that this looks at any explicit corresponding input names that may be specified, and returns that, if found, first.

const char* VOP_OutputInfo::getBypassCorrespondingInputName ( void  )
EOutputModeType VOP_OutputInfo::getBypassMode ( void  )
UT_Options* VOP_OutputInfo::getBypassValuePtr ( void  )

Retrieves the constant value pointer for the release mode.

const char* VOP_OutputInfo::getDebugCorrespondingInputName ( void  )
EOutputModeType VOP_OutputInfo::getDebugMode ( void  )
UT_Options* VOP_OutputInfo::getDebugValuePtr ( void  )

Retrieves the constant value pointer for the debug mode.

int VOP_OutputInfo::getIndex ( void  )

Returns the index of the output this info applies to.

const char* VOP_OutputInfo::getOutputName ( void  )

Returns the name of the output this info applies to.

void VOP_OutputInfo::getOutputVariableCode ( UT_String var_code)

Returns the variable name that should be used in the override code. The variable may or may not be prefixed with '$', depending if the output variable name is fixed or not. In majority of cases it is, but for vops such as globals or exporting parm vop, it is not.

bool VOP_OutputInfo::getUseDefaultValue ( )
inline

Definition at line 110 of file VOP_OutputInfo.h.

bool VOP_OutputInfo::load ( UT_IStream is)
bool VOP_OutputInfo::save ( std::ostream &  os,
bool  is_binary 
)
void VOP_OutputInfo::setBypassCorrespondingInputName ( const char *  input_name)
void VOP_OutputInfo::setBypassedMode ( EOutputModeType  mode)

Sets the behaviour type for this output in the bypass mode.

void VOP_OutputInfo::setDebugCorrespondingInputName ( const char *  input_name)
void VOP_OutputInfo::setDebugMode ( EOutputModeType  mode)

Sets the behaviour type for this output in the debug mode.

void VOP_OutputInfo::setUseDefaultValue ( bool  val)
inline

Definition at line 109 of file VOP_OutputInfo.h.


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