POption.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015-2018 Digital Barriers plc. All rights reserved.
 * Contact: http://www.digitalbarriers.com/
 *
 * This file is part of the Papillon SDK.
 *
 * You can't use, modify or distribute any part of this file without
 * the explicit written agreements of Digital Barriers.
 */

#pragma once
#include <PObject.h>

PAPILLON_BEGIN_NAMESPACE

class PGuid;
class PImage;
class PInputVideoStream;
class POutputVideoStream;
class PRectanglei;
class PSizef;
class PSizei;
class PStringList;

class PAPILLON_API_CORE POption : public PObject
{
public:
    POption();

    POption(const PString& commandLine);

    POption(int argc, char** argv);

    POption(const POption& other);

    virtual ~POption();        

    POption& operator=(const POption& other);

    static PStringList Parse(const PString& commandLine);

    bool IsEmpty() const;

    void AddStandardOptions();

    bool Option(const PString& optionName, const PString& description);

    bool Bool(const PString& optionName, bool defaultValue, const PString& description, bool isRequired = false);

    papillon::int32 Int(const PString& optionName, papillon::int32 defaultValue, const PString& description, bool isRequired = false);

    float Float(const PString& optionName, float defaultValue, const PString& description, bool isRequired = false);

    double Double(const PString& optionName, double defaultValue, const PString& description, bool isRequired = false);

    PString String(const PString& optionName, const PString& defaultValue, const PString& description, bool isRequired = false);

    PStringList StringList(const PString& optionName, const PStringList& defaultValue, const PString& description, bool isRequired = false);

    PGuid Guid(const PString& optionName, const PGuid& defaultValue, const PString& description, bool isRequired = false);

    PSizei Sizei(const PString& optionName, const PSizei& defaultValue, const PString& description, bool isRequired = false);

    PSizef Sizef(const PString& optionName, const PSizef& defaultValue, const PString& description, bool isRequired = false);

    PRectanglei Rectanglei(const PString& optionName, const PRectanglei& defaultValue, const PString& description, bool isRequired = false);

    PImage Image(const PString& optionName, const PImage& defaultValue, const PString& description, bool isRequired = false);

    PInputVideoStream InputVideoStream(const PString& optionName, const PInputVideoStream& defaultValue, const PString& description, bool isRequired = false);

    POutputVideoStream OutputVideoStream(const PString& optionName, const POutputVideoStream& defaultValue, const PString& description, bool isRequired = false);

    PResult Check() const;

    PString GetCmdLine() const;

    bool Has(const PString& optionName) const;

    PResult Set(const PString& optionName, const PString& value);

    PString ExportCommandLine() const;

    PString ToStringHelp(papillon::int32 lengthDescription = 50) const;
};


PAPILLON_END_NAMESPACE