Return to Command.h CVS log | Up to [Pegasus] / pegasus / src / Clients / cliutils |
File: [Pegasus] / pegasus / src / Clients / cliutils / Command.h
(download)
Revision: 1.12, Tue Dec 2 09:00:09 2008 UTC (15 years, 6 months ago) by martin Branch: MAIN CVS Tags: preBug9676, postBug9676, TASK_PEP317_1JUNE_2013, TASK-TASK_PEP362_RestfulService_branch-root, TASK-TASK_PEP362_RestfulService_branch-merged_out_from_trunk, TASK-TASK_PEP362_RestfulService_branch-merged_in_to_trunk, TASK-TASK_PEP362_RestfulService_branch-merged_in_from_branch, TASK-TASK_PEP362_RestfulService_branch-branch, TASK-PEP362_RestfulService-root, TASK-PEP362_RestfulService-merged_out_to_branch, TASK-PEP362_RestfulService-merged_out_from_trunk, TASK-PEP362_RestfulService-merged_in_to_trunk, TASK-PEP362_RestfulService-merged_in_from_branch, TASK-PEP362_RestfulService-branch, TASK-PEP348_SCMO-root, TASK-PEP348_SCMO-merged_out_to_branch, TASK-PEP348_SCMO-merged_out_from_trunk, TASK-PEP348_SCMO-merged_in_to_trunk, TASK-PEP348_SCMO-merged_in_from_branch, TASK-PEP348_SCMO-branch, TASK-PEP317_pullop-root, TASK-PEP317_pullop-merged_out_to_branch, TASK-PEP317_pullop-merged_out_from_trunk, TASK-PEP317_pullop-merged_in_to_trunk, TASK-PEP317_pullop-merged_in_from_branch, TASK-PEP317_pullop-branch, RELEASE_2_9_2-RC2, RELEASE_2_9_2-RC1, RELEASE_2_9_2, RELEASE_2_9_1-RC1, RELEASE_2_9_1, RELEASE_2_9_0-RC1, RELEASE_2_9_0-FC, RELEASE_2_9_0, RELEASE_2_9-root, RELEASE_2_9-branch, RELEASE_2_14_1, RELEASE_2_14_0-RC2, RELEASE_2_14_0-RC1, RELEASE_2_14_0, RELEASE_2_14-root, RELEASE_2_14-branch, RELEASE_2_13_0-RC2, RELEASE_2_13_0-RC1, RELEASE_2_13_0-FC, RELEASE_2_13_0, RELEASE_2_13-root, RELEASE_2_13-branch, RELEASE_2_12_1-RC1, RELEASE_2_12_1, RELEASE_2_12_0-RC1, RELEASE_2_12_0-FC, RELEASE_2_12_0, RELEASE_2_12-root, RELEASE_2_12-branch, RELEASE_2_11_2-RC1, RELEASE_2_11_2, RELEASE_2_11_1-RC1, RELEASE_2_11_1, RELEASE_2_11_0-RC1, RELEASE_2_11_0-FC, RELEASE_2_11_0, RELEASE_2_11-root, RELEASE_2_11-branch, RELEASE_2_10_1-RC1, RELEASE_2_10_1, RELEASE_2_10_0-RC2, RELEASE_2_10_0-RC1, RELEASE_2_10_0, RELEASE_2_10-root, RELEASE_2_10-branch, PREAUG25UPDATE, POSTAUG25UPDATE, HPUX_TEST, HEAD, CIMRS_WORK_20130824, BeforeUpdateToHeadOct82011 Changes since 1.11: +6 -6 lines BUG#: 8123 TITLE: Update copyright/license text DESCRIPTION: Fixing trailing spaces in copyright/license text |
//%LICENSE//////////////////////////////////////////////////////////////// // // Licensed to The Open Group (TOG) under one or more contributor license // agreements. Refer to the OpenPegasusNOTICE.txt file distributed with // this work for additional information regarding copyright ownership. // Each contributor licenses this file to you under the OpenPegasus Open // Source License; you may not use this file except in compliance with the // License. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the "Software"), // to deal in the Software without restriction, including without limitation // the rights to use, copy, modify, merge, publish, distribute, sublicense, // and/or sell copies of the Software, and to permit persons to whom the // Software is furnished to do so, subject to the following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. // IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY // CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, // TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE // SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. // ////////////////////////////////////////////////////////////////////////// // // Author: Carol Ann Krug Graves, Hewlett-Packard Company // (carolann_graves@hp.com) // // Modified By: David Dillard, VERITAS Software Corp. // (david.dillard@veritas.com) // //%///////////////////////////////////////////////////////////////////////////// #ifndef Pegasus_Command_h #define Pegasus_Command_h #include <iostream> #include <Pegasus/Common/String.h> #include <Clients/cliutils/Linkage.h> #include <Clients/cliutils/CommandException.h> #include <Pegasus/Common/MessageLoader.h> //l10n #include <Pegasus/Common/Formatter.h> //l10n PEGASUS_NAMESPACE_BEGIN /** Command is the abstract base class for WBEM and CIM commands. @author Hewlett-Packard Company */ class PEGASUS_CLIUTILS_LINKAGE Command { public: virtual ~Command(); /** Gets command usage string. Usage string may be retrieved and displayed when a CommandFormatException is caught. @return String containing the command usage message */ String& getUsage(); /** Parses the command line, validates the options, and sets instance variables based on the options and arguments. @param argc the number of command line arguments @param argv the string vector of command line arguments @exception CommandFormatException Indicates the command line was improperly formed */ virtual void setCommand(Uint32 argc, char *argv []) = 0; /** Executes the command and writes the results to the output streams. @param outPrintWriter the ostream to which output should be written @param errPrintWriter the ostream to which error output should be written @return 0 if the command is successful 1 if an error occurs in executing the command */ virtual Uint32 execute( PEGASUS_STD(ostream)& outPrintWriter, PEGASUS_STD(ostream)& errPrintWriter) = 0; // // Return codes // /** Return value from the execute method indicating the command executed successfully. */ static const Uint32 RC_SUCCESS; /** Return value from the execute method indicating an error occurred in executing the command. */ static const Uint32 RC_ERROR; String localizeMessage( const char *resource_path, const char * key, const char * default_msg, Formatter::Arg arg0 = Formatter::Arg(), Formatter::Arg arg1 = Formatter::Arg(), Formatter::Arg arg2 = Formatter::Arg(), Formatter::Arg arg3 = Formatter::Arg(), Formatter::Arg arg4 = Formatter::Arg(), Formatter::Arg arg5 = Formatter::Arg(), Formatter::Arg arg6 = Formatter::Arg(), Formatter::Arg arg7 = Formatter::Arg(), Formatter::Arg arg8 = Formatter::Arg(), Formatter::Arg arg9 = Formatter::Arg()); protected: /** Sets command usage string. Usage string should be set by Command subclass constructor. @param usageMessage the command usage message */ void setUsage(String& usageMessage); private: /** The usage string for this command. The value of the string should be set in the command subclass constructor. The string may be retrieved and displayed when a CommandFormatException is caught. */ String _usage; }; PEGASUS_NAMESPACE_END #endif /* Pegasus_Command_h */
No CVS admin address has been configured |
Powered by ViewCVS 0.9.2 |