PackageEnvironmentVariableItemData Struct Reference

#include <Package/packageenvironmentvariableitemdata.h>

Inheritance diagram for PackageEnvironmentVariableItemData:

Public Member Functions
	PackageEnvironmentVariableItemData ()
bool	addToCMakePackScript (QStringList &) const override
PackageItem *	clone () const override
void	ensureHasData ()
QList< EnvironmentVariableDetails >	getEnvironmentVariables () const override
bool	haveAllData () const
Public Member Functions inherited from PackageItem
virtual bool	addToCMakePackScript (QStringList &cmakeScript) const =0
PackageItem *	clone () const override=0
virtual QList< ApplicationIconDetails >	getApplicationIcons () const
virtual QList< EnvironmentVariableDetails >	getEnvironmentVariables () const
virtual QList< ExecutableDetails >	getExecutables () const
Public Member Functions inherited from Clonable
virtual	~Clonable ()=default
virtual Clonable *	clone () const =0

Public Attributes
CSIRO::DataExecution::TypedObject< bool >	dataIncludeInPackage_
CSIRO::DataExecution::TypedObject< QString >	dataVariableName_
CSIRO::DataExecution::TypedObject< QString >	dataVariableValue_

Constructor & Destructor Documentation

PackageEnvironmentVariableItemData()

PackageEnvironmentVariableItemData ( )

inline

Member Function Documentation

addToCMakePackScript()

bool addToCMakePackScript ( QStringList &  cmakeScript ) const

inlineoverridevirtual

Parameters

cmakeScript

Upon entry, this will hold the contents of the CMake script that have been assembled so far. These contents would normally not be modified, but this is permitted if required. Normally, the subclass implementation would simply append to cmakeScript and in some circumstances, it may search for things in cmakeScript to customize entries that will be appended.

Returns

True upon success, or false if an error was encountered that results in the CMake script incomplete or invalid.

Implements PackageItem.

clone()

PackageItem * clone ( ) const

inlineoverridevirtual

Returns

A clone of this object.

Note

Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

We redeclare this function only so that the more derived return type is available without casting.

Implements PackageItem.

ensureHasData()

void ensureHasData ( )

inline

getEnvironmentVariables()

QList< EnvironmentVariableDetails > getEnvironmentVariables ( ) const

inlineoverridevirtual

Returns

A list of EnvironmentVariableDetails objects for this package item.

The default implementation returns an empty list.

Reimplemented from PackageItem.

haveAllData()

bool haveAllData ( ) const

inline

Member Data Documentation

dataIncludeInPackage_

CSIRO::DataExecution::TypedObject<bool> dataIncludeInPackage_

dataVariableName_

CSIRO::DataExecution::TypedObject<QString> dataVariableName_

dataVariableValue_

CSIRO::DataExecution::TypedObject<QString> dataVariableValue_