Operator Reference

HALCON Operator Reference / Control
ClassesClasses | | Operators

Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

Use the tabs on the upper right to switch to a different programming language.

export_defexport_defExportDefExportDefexport_def (Operator)

export_defexport_defExportDefExportDefexport_def — Insert arbitrary text into the export code of a procedure.

Signature

export_def( : : Position, Declaration : )

Herror export_def(const char* Position, const char* Declaration)

Herror T_export_def(const Htuple Position, const Htuple Declaration)

void ExportDef(const HTuple& Position, const HTuple& Declaration)

static void HOperatorSet.ExportDef(HTuple position, HTuple declaration)

def export_def(position: str, declaration: str) -> None

Description

export_defexport_defExportDefExportDefexport_def allows to define code lines or text blocks that are written verbatim into the output file of a procedure or program that is exported.

The parameter PositionPositionPositionpositionposition controls the placement of the text given in DeclarationDeclarationDeclarationdeclarationdeclaration. The following options are supported:

'in_place'"in_place""in_place""in_place""in_place" - #

The text is inserted in the procedure at the actual place, i.e., in between the neighboring program lines.

'at_file_begin'"at_file_begin""at_file_begin""at_file_begin""at_file_begin" - #^^

The text is exported at the very beginning of the exported file.

'before_procedure'"before_procedure""before_procedure""before_procedure""before_procedure" - #^

The text is exported immediately before the procedure it is defined in.

'after_procedure'"after_procedure""after_procedure""after_procedure""after_procedure" - #$

The text is exported immediately after the procedure it is defined in.

'at_file_end'"at_file_end""at_file_end""at_file_end""at_file_end" - #$$

The text is exported at the very end of the exported file.

In the program listing, export_defexport_defExportDefExportDefexport_def is not represented in normal operator syntax but marked by a special character sequence. The first character within the line is the export marker # that can be followed by a position marker as listed above. If entering an export definition in the full text editor, please note that there must not be any spaces before #.

For better readability, the export character sequence may be followed by one space character that is not interpreted as part of the export text. All additional spaces are added to the export.

For lines that are exported within the current procedure, the export gets the same indentation as the current program lines get. There is one exception: if the export text starts with # immediately after the export markers or the optional space, the export text will not be indented at all, e.g.: 

for Index := 1 to 5 by 1
# #ifdef MY_SWITCH
# int cnt = 100;
  * an optional code block
# #endif
endfor
is exported to: 
proc (...)
{
  ...
  for (...)
  {
#ifdef MY_SWITCH
    int cnt = 100;
    // an optional block
#endif
  }
  ...
}
An export definition can be activated and deactivated as any normal operator. Deactivated export definitions are not exported.

Parameters

PositionPositionPositionpositionposition (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Place where the export text is written.

List of values: 'after_procedure'"after_procedure""after_procedure""after_procedure""after_procedure", 'at_file_begin'"at_file_begin""at_file_begin""at_file_begin""at_file_begin", 'at_file_end'"at_file_end""at_file_end""at_file_end""at_file_end", 'before_procedure'"before_procedure""before_procedure""before_procedure""before_procedure", 'in_place'"in_place""in_place""in_place""in_place"

DeclarationDeclarationDeclarationdeclarationdeclaration (input_control)  string → HTuplestrHTupleHtuple (string) (string) (HString) (char*)

Text that is exported.

Result

export_defexport_defExportDefExportDefexport_def is never executed.

See also

commentcommentCommentCommentcomment

Module

Foundation

ClassesClasses | | Operators