summaryrefslogtreecommitdiffstats
path: root/Source/cmCableWrapCommand.h
blob: e1397145306ce140f3274213ed62861deb6cd01f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*=========================================================================

  Program:   Insight Segmentation & Registration Toolkit
  Module:    $RCSfile$
  Language:  C++
  Date:      $Date$
  Version:   $Revision$


  Copyright (c) 2000 National Library of Medicine
  All rights reserved.

  See COPYRIGHT.txt for copyright details.

=========================================================================*/
#ifndef cmCableWrapCommand_h
#define cmCableWrapCommand_h

#include "cmStandardIncludes.h"
#include "cmCablePackageEntryCommand.h"

/** \class cmCableWrapCommand
 * \brief Define a command that generates a rule for CABLE-generated wrappers.
 *
 * cmCableWrapCommand is used to generate a rule in a CABLE
 * configuration file to create type wrappers.
 */
class cmCableWrapCommand : public cmCablePackageEntryCommand
{
public:
  /**
   * This is a virtual constructor for the command.
   */
  virtual cmCommand* Clone() 
    {
    return new cmCableWrapCommand;
    }

  /**
   * The name of the command as specified in CMakeList.txt.
   */
  virtual const char* GetName() { return "CABLE_WRAP";}

  /**
   * Succinct documentation.
   */
  virtual const char* GetTerseDocumentation() 
    {
    return "Define CABLE WrapSet in a package.";
    }
  
  /**
   * More documentation.
   */
  virtual const char* GetFullDocumentation()
    {
    return
      "CABLE_WRAP(member1 member2 ...)\n"
      "Generates a WrapSet in the CABLE configuration.";
    }

  virtual bool WriteConfiguration();
  
  cmTypeMacro(cmCableWrapCommand, cmCablePackageCommand);
};



#endif