#include <otbWrapperParameterGroup.h>

Inheritance diagram for otb::Wrapper::ParameterGroup:

Collaboration diagram for otb::Wrapper::ParameterGroup:

Public Types
typedef itk::SmartPointer < const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef ParameterGroup	Self
typedef Parameter	Superclass

Public Member Functions
virtual void	AddChild (Parameter::Pointer child)
void	AddChoice (std::string paramKey, std::string paramName)
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
void	AddParameter (Parameter::Pointer p)
void	AddParameter (ParameterType type, std::string paramKey, std::string paramName)
virtual void	AutomaticValueOff ()
virtual void	AutomaticValueOn ()
void	ClearChoices (std::string paramKey)
virtual void	ClearValue ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual bool	GetActive () const
virtual bool	GetAutomaticValue () const
virtual std::vector < Parameter::Pointer >	GetChildrenList ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual DefaultValueMode	GetDefaultValueMode () const
virtual const char *	GetDescription () const
virtual const char *	GetKey () const
virtual bool	GetMandatory () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
virtual const char *	GetName () const
virtual const char *	GetNameOfClass () const
unsigned int	GetNumberOfParameters ()
Parameter::Pointer	GetParameterByIndex (unsigned int i)
Parameter::Pointer	GetParameterByKey (std::string name)
std::vector< std::string >	GetParametersKeys (bool recursive=true)
virtual int	GetReferenceCount () const
virtual Role	GetRole () const
virtual const Parameter::Pointer	GetRoot ()
std::vector< int >	GetSelectedItems (std::string paramKey)
virtual UserLevel	GetUserLevel () const
bool	HasObserver (const EventObject &event) const
virtual bool	HasUserValue () const
bool	HasValue () const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual bool	IsChecked ()
virtual bool	IsRoot ()
virtual void	MandatoryOff ()
virtual void	MandatoryOn ()
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	Reset ()
virtual void	SetActive (bool _arg)
virtual void	SetAutomaticValue (bool _arg)
virtual void	SetChecked (const bool value)
void	SetDebug (bool debugFlag) const
virtual void	SetDefaultValueMode (const DefaultValueMode _arg)
virtual void	SetDescription (const char *_arg)
virtual void	SetKey (const char *_arg)
virtual void	SetMandatory (bool _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetName (const char *_arg)
virtual void	SetReferenceCount (int)
virtual void	SetRole (const Role _arg)
virtual void	SetRoot (const Parameter::Pointer root)
virtual void	SetUserLevel (const UserLevel _arg)
virtual void	SetUserValue (bool isUserValue)
virtual void	UnRegister () const

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType
typedef std::vector < Parameter::Pointer >	ParameterListType

Protected Member Functions
	ParameterGroup ()
virtual	~ParameterGroup ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const

Protected Attributes
bool	m_Active
bool	m_AutomaticValue
std::vector< Parameter::Pointer >	m_ChildrenList
DefaultValueMode	m_DefaultValueMode
std::string	m_Description
bool	m_IsChecked
std::string	m_Key
bool	m_Mandatory
std::string	m_Name
ParameterListType	m_ParameterList
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Role	m_Role
Parameter::Pointer	m_Root
UserLevel	m_UserLevel
bool	m_UserValue

Private Member Functions
	ParameterGroup (const ParameterGroup &)
void	operator= (const ParameterGroup &)

Detailed Description

Definition at line 33 of file otbWrapperParameterGroup.h.

Member Typedef Documentation

typedef itk::SmartPointer<const Self> otb::Wrapper::ParameterGroup::ConstPointer

Reimplemented from otb::Wrapper::Parameter.

Definition at line 40 of file otbWrapperParameterGroup.h.

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.h.

typedef std::vector<Parameter::Pointer> otb::Wrapper::ParameterGroup::ParameterListType

protected

Definition at line 80 of file otbWrapperParameterGroup.h.

typedef itk::SmartPointer<Self> otb::Wrapper::ParameterGroup::Pointer

Reimplemented from otb::Wrapper::Parameter.

Definition at line 39 of file otbWrapperParameterGroup.h.

typedef ParameterGroup otb::Wrapper::ParameterGroup::Self

Standard class typedef

Reimplemented from otb::Wrapper::Parameter.

Definition at line 37 of file otbWrapperParameterGroup.h.

typedef Parameter otb::Wrapper::ParameterGroup::Superclass

Reimplemented from otb::Wrapper::Parameter.

Definition at line 38 of file otbWrapperParameterGroup.h.

Constructor & Destructor Documentation

otb::Wrapper::ParameterGroup::ParameterGroup ( )

protected

Definition at line 47 of file otbWrapperParameterGroup.cxx.

otb::Wrapper::ParameterGroup::~ParameterGroup ( )

protectedvirtual

Definition at line 51 of file otbWrapperParameterGroup.cxx.

otb::Wrapper::ParameterGroup::ParameterGroup ( const ParameterGroup & )

private

Member Function Documentation

virtual void otb::Wrapper::Parameter::AddChild ( Parameter::Pointer child )

inlinevirtualinherited

Add a child of this parameter when the param is a Group or a choice

Definition at line 182 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_ChildrenList.

Referenced by otb::Wrapper::ChoiceParameter::AddChoice().

void otb::Wrapper::ParameterGroup::AddChoice	(	std::string	paramKey,
		std::string	paramName
	)

Add a new choice value to an existing choice parameter

Add a new choice value to the parameter group

Definition at line 94 of file otbWrapperParameterGroup.cxx.

References otb::Wrapper::ChoiceParameter::AddChoice(), otb::Wrapper::ListViewParameter::AddChoice(), otb::Wrapper::ParameterKey::GetLastElement(), GetParameterByKey(), itk::SmartPointer< TObjectType >::GetPointer(), otb::Wrapper::ParameterKey::GetRoot(), and otb::Wrapper::ParameterKey::Split().

Referenced by otb::Wrapper::Application::AddChoice().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

inherited

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void otb::Wrapper::ParameterGroup::AddParameter ( Parameter::Pointer p )

Definition at line 367 of file otbWrapperParameterGroup.cxx.

References m_ParameterList.

Referenced by AddParameter(), otb::Wrapper::Application::AddParameter(), otb::Wrapper::Application::AddRAMParameter(), and otb::Wrapper::Application::AddRANDParameter().

void otb::Wrapper::ParameterGroup::AddParameter	(	ParameterType	type,
		std::string	paramKey,
		std::string	paramName
	)

Add a new parameter to the parameter group the parent key of paramKey can be the path to a parameter group or the path to a choice value

Add a new parameter to the parameter group

Definition at line 205 of file otbWrapperParameterGroup.cxx.

virtual void otb::Wrapper::Parameter::AutomaticValueOff ( )

virtualinherited

virtual void otb::Wrapper::Parameter::AutomaticValueOn ( )

virtualinherited

Toogle the parameter mandatory flag

void itk::LightObject::BreakOnError ( )

staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 149 of file itkLightObject.cxx.

void otb::Wrapper::ParameterGroup::ClearChoices ( std::string paramKey )

Remove choices made in ListViewParamter widget

Remove the choices made for the ViewList parameter

Definition at line 133 of file otbWrapperParameterGroup.cxx.

References otb::Wrapper::ListViewParameter::ClearChoices(), GetParameterByKey(), itk::SmartPointer< TObjectType >::GetPointer(), otb::Wrapper::ParameterKey::GetRoot(), and otb::Wrapper::ParameterKey::Split().

Referenced by otb::Wrapper::Application::ClearChoices().

virtual void otb::Wrapper::Parameter::ClearValue ( )

inlinevirtualinherited

Definition at line 157 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::Application::ClearValue().

virtual::itk::LightObject::Pointer otb::Wrapper::ParameterGroup::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from otb::Wrapper::Parameter.

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 88 of file itkLightObject.cxx.

virtual bool otb::Wrapper::Parameter::GetActive ( ) const

virtualinherited

Get the parameter mandatory flag

Reimplemented in otb::Wrapper::RAMParameter, and otb::Wrapper::DirectoryParameter.

Referenced by otb::Wrapper::CommandLineLauncher::DisplayParameterHelp(), otb::Wrapper::Application::IsApplicationReady(), otb::Wrapper::Application::IsParameterEnabled(), otb::Wrapper::CommandLineLauncher::LoadParameters(), and otb::Wrapper::QtWidgetParameterBase::UpdateGUI().

virtual bool otb::Wrapper::Parameter::GetAutomaticValue ( ) const

virtualinherited

Get the parameter mandatory flag

Referenced by otb::Wrapper::Application::HasAutomaticValue().

virtual std::vector<Parameter::Pointer > otb::Wrapper::Parameter::GetChildrenList ( )

inlinevirtualinherited

Get the children pointer list : not const cause we need to alterate the m_Active status and the m_IsCheckbox

Definition at line 190 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_ChildrenList.

Referenced by otb::Wrapper::QtWidgetParameterGroup::DoCreateWidget(), and otb::Wrapper::QtWidgetParameterGroup::ProcessChild().

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

virtual DefaultValueMode otb::Wrapper::Parameter::GetDefaultValueMode ( ) const

virtualinherited

Get the default value mode

virtual const char* otb::Wrapper::Parameter::GetDescription ( ) const

virtualinherited

Get the parameter description

Referenced by otb::Wrapper::Application::GetParameterDescription().

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

virtual const char* otb::Wrapper::Parameter::GetKey ( ) const

virtualinherited

Get the parameter key

Referenced by GetParametersKeys().

virtual bool otb::Wrapper::Parameter::GetMandatory ( ) const

virtualinherited

Get the parameter mandatory flag

Referenced by otb::Wrapper::QtWidgetParameterGroup::DoCreateWidget(), otb::Wrapper::Application::IsMandatory(), and otb::Wrapper::QtWidgetParameterBase::UpdateGUI().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

virtual const char* otb::Wrapper::Parameter::GetName ( ) const

virtualinherited

Get the parameter name

Referenced by otb::Wrapper::QtWidgetParameterGroup::DoCreateWidget(), otb::Wrapper::Application::GetParameterName(), and otb::Wrapper::QtWidgetParameterLabel::QtWidgetParameterLabel().

virtual const char* otb::Wrapper::ParameterGroup::GetNameOfClass ( ) const

virtual

RTTI support

Reimplemented from otb::Wrapper::Parameter.

unsigned int otb::Wrapper::ParameterGroup::GetNumberOfParameters ( )

Definition at line 474 of file otbWrapperParameterGroup.cxx.

References m_ParameterList.

Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByIndex ( unsigned int i )

Definition at line 373 of file otbWrapperParameterGroup.cxx.

References m_ParameterList.

Parameter::Pointer otb::Wrapper::ParameterGroup::GetParameterByKey ( std::string name )

Definition at line 379 of file otbWrapperParameterGroup.cxx.

References otb::Wrapper::ChoiceParameter::GetChoiceParameterGroupByKey(), otb::Wrapper::ParameterKey::GetFirstElement(), GetParameterByKey(), itk::SmartPointer< TObjectType >::GetPointer(), itk::SmartPointer< TObjectType >::IsNull(), m_ParameterList, and otb::Wrapper::ParameterKey::Split().

Referenced by AddChoice(), AddParameter(), ClearChoices(), GetParameterByKey(), otb::Wrapper::Application::GetParameterByKey(), and GetSelectedItems().

std::vector< std::string > otb::Wrapper::ParameterGroup::GetParametersKeys ( bool recursive = true )

Definition at line 56 of file otbWrapperParameterGroup.cxx.

References otb::Wrapper::Parameter::GetKey(), GetParametersKeys(), otb::Wrapper::ChoiceParameter::GetParametersKeys(), and m_ParameterList.

Referenced by otb::Wrapper::ApplicationHtmlDocGenerator::GetDocParameterGroup(), GetParametersKeys(), and otb::Wrapper::Application::GetParametersKeys().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual Role otb::Wrapper::Parameter::GetRole ( ) const

virtualinherited

Get the user access level

Referenced by otb::Wrapper::QtWidgetParameterGroup::DoCreateWidget(), otb::Wrapper::Application::GetOutputParametersSumUp(), otb::Wrapper::Application::GetParameterRole(), and otb::Wrapper::Application::IsApplicationReady().

virtual const Parameter::Pointer otb::Wrapper::Parameter::GetRoot ( )

inlinevirtualinherited

Definition at line 168 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_Root.

Referenced by otb::Wrapper::CommandLineLauncher::DisplayParameterHelp(), otb::Wrapper::Application::IsApplicationReady(), otb::Wrapper::CommandLineLauncher::LoadParameters(), and otb::Wrapper::QtWidgetParameterBase::UpdateGUI().

std::vector< int > otb::Wrapper::ParameterGroup::GetSelectedItems ( std::string paramKey )

Get the choices made in a ListView Parameter widget

Get the choices made in the QListWidget

Definition at line 167 of file otbWrapperParameterGroup.cxx.

References GetParameterByKey(), itk::SmartPointer< TObjectType >::GetPointer(), otb::Wrapper::ParameterKey::GetRoot(), otb::Wrapper::ListViewParameter::GetSelectedItems(), and otb::Wrapper::ParameterKey::Split().

Referenced by otb::Wrapper::Application::GetSelectedItems().

virtual UserLevel otb::Wrapper::Parameter::GetUserLevel ( ) const

virtualinherited

Get the user access level

Referenced by otb::Wrapper::Application::GetParameterUserLevel().

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

virtual bool otb::Wrapper::Parameter::HasUserValue ( ) const

inlinevirtualinherited

Definition at line 147 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::HasValue(), and otb::Wrapper::Parameter::m_UserValue.

Referenced by otb::Wrapper::Application::HasUserValue().

bool otb::Wrapper::ParameterGroup::HasValue ( ) const

inlinevirtual

Reimplemented from otb::Wrapper::Parameter.

Definition at line 71 of file otbWrapperParameterGroup.h.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

virtual bool otb::Wrapper::Parameter::IsChecked ( )

inlinevirtualinherited

Store the state of the check box relative to this parameter (TO BE MOVED to QtWrapper Model )

Definition at line 198 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_IsChecked.

Referenced by otb::Wrapper::QtWidgetParameterGroup::ProcessChild().

virtual bool otb::Wrapper::Parameter::IsRoot ( )

inlinevirtualinherited

Is the paramter a root or a child of another param

Definition at line 174 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_Root.

Referenced by otb::Wrapper::CommandLineLauncher::DisplayParameterHelp(), otb::Wrapper::Application::IsApplicationReady(), and otb::Wrapper::CommandLineLauncher::LoadParameters().

virtual void otb::Wrapper::Parameter::MandatoryOff ( )

virtualinherited

Referenced by otb::Wrapper::EmptyParameter::EmptyParameter().

virtual void otb::Wrapper::Parameter::MandatoryOn ( )

virtualinherited

Toogle the parameter mandatory flag

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

static Pointer otb::Wrapper::ParameterGroup::New ( )

static

Defining ::New() static method

Reimplemented from otb::Wrapper::Parameter.

Referenced by AddParameter().

void otb::Wrapper::ParameterGroup::operator= ( const ParameterGroup & )

private

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

void itk::Object::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::LightObject.

Definition at line 517 of file itkObject.cxx.

References itk::Indent::GetNextIndent().

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

virtual void otb::Wrapper::Parameter::Reset ( )

inlinevirtualinherited

Reset to the the default value. Default implementation does nothing

Reimplemented in otb::Wrapper::RAMParameter, and otb::Wrapper::NumericalParameter< T >.

Definition at line 138 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::QtWidgetParameterBase::Reset().

virtual void otb::Wrapper::Parameter::SetActive ( bool _arg )

virtualinherited

Set the parameter mandatory flag

Reimplemented in otb::Wrapper::RAMParameter, and otb::Wrapper::DirectoryParameter.

virtual void otb::Wrapper::Parameter::SetAutomaticValue ( bool _arg )

virtualinherited

Set the parameter mandatory flag

Referenced by otb::Wrapper::Application::AutomaticValueOff(), otb::Wrapper::Application::AutomaticValueOn(), and otb::Wrapper::QtWidgetParameterBase::Reset().

virtual void otb::Wrapper::Parameter::SetChecked ( const bool value )

inlinevirtualinherited

Modify the state of the checkbox relative to this paramter

Definition at line 204 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_IsChecked.

Referenced by otb::Wrapper::QtWidgetParameterBase::SetActivationState().

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

virtual void otb::Wrapper::Parameter::SetDefaultValueMode ( const DefaultValueMode _arg )

virtualinherited

Set the default value mode

virtual void otb::Wrapper::Parameter::SetDescription ( const char * _arg )

virtualinherited

Set the parameter description

Referenced by otb::Wrapper::RadiusParameter::RadiusParameter(), otb::Wrapper::RAMParameter::RAMParameter(), and otb::Wrapper::Application::SetParameterDescription().

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

virtual void otb::Wrapper::Parameter::SetKey ( const char * _arg )

virtualinherited

Set the parameter key

virtual void otb::Wrapper::Parameter::SetMandatory ( bool _arg )

virtualinherited

Set the parameter mandatory flag

Referenced by otb::Wrapper::Application::MandatoryOff(), and otb::Wrapper::Application::MandatoryOn().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

virtual void otb::Wrapper::Parameter::SetName ( const char * _arg )

virtualinherited

Set the parameter name

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void otb::Wrapper::Parameter::SetRole ( const Role _arg )

virtualinherited

Set the parameter io type

Referenced by otb::Wrapper::Application::SetParameterRole().

virtual void otb::Wrapper::Parameter::SetRoot ( const Parameter::Pointer root )

inlinevirtualinherited

Set/Get the root of the current parameter (direct parent)

Definition at line 163 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_Root.

virtual void otb::Wrapper::Parameter::SetUserLevel ( const UserLevel _arg )

virtualinherited

Set the user access level

virtual void otb::Wrapper::Parameter::SetUserValue ( bool isUserValue )

inlinevirtualinherited

Definition at line 152 of file otbWrapperParameter.h.

References otb::Wrapper::Parameter::m_UserValue.

Referenced by otb::Wrapper::QtWidgetParameterBase::Reset().

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

Member Data Documentation

bool otb::Wrapper::Parameter::m_Active

protectedinherited

True if activated (a mandatory parameter is always active)

Definition at line 242 of file otbWrapperParameter.h.

bool otb::Wrapper::Parameter::m_AutomaticValue

protectedinherited

True if the application change the value of this parameter

Definition at line 248 of file otbWrapperParameter.h.

std::vector<Parameter::Pointer > otb::Wrapper::Parameter::m_ChildrenList

protectedinherited

List of children parameters

Definition at line 262 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::Parameter::AddChild(), and otb::Wrapper::Parameter::GetChildrenList().

DefaultValueMode otb::Wrapper::Parameter::m_DefaultValueMode

protectedinherited

Default value behaviour

Definition at line 251 of file otbWrapperParameter.h.

std::string otb::Wrapper::Parameter::m_Description

protectedinherited

Description of the parameter

Definition at line 233 of file otbWrapperParameter.h.

bool otb::Wrapper::Parameter::m_IsChecked

protectedinherited

Store the status of the checkbox

Definition at line 265 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::Parameter::IsChecked(), and otb::Wrapper::Parameter::SetChecked().

std::string otb::Wrapper::Parameter::m_Key

protectedinherited

Key of the parameter

Definition at line 236 of file otbWrapperParameter.h.

bool otb::Wrapper::Parameter::m_Mandatory

protectedinherited

True if the parameter is mandatory

Definition at line 239 of file otbWrapperParameter.h.

std::string otb::Wrapper::Parameter::m_Name

protectedinherited

Name of the parameter

Definition at line 230 of file otbWrapperParameter.h.

ParameterListType otb::Wrapper::ParameterGroup::m_ParameterList

protected

Definition at line 81 of file otbWrapperParameterGroup.h.

Referenced by AddParameter(), GetNumberOfParameters(), GetParameterByIndex(), GetParameterByKey(), and GetParametersKeys().

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

Role otb::Wrapper::Parameter::m_Role

protectedinherited

Default iotype mode

Definition at line 256 of file otbWrapperParameter.h.

Parameter::Pointer otb::Wrapper::Parameter::m_Root

protectedinherited

List of parents Parameters

Definition at line 259 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::Parameter::GetRoot(), otb::Wrapper::Parameter::IsRoot(), and otb::Wrapper::Parameter::SetRoot().

UserLevel otb::Wrapper::Parameter::m_UserLevel

protectedinherited

Definition at line 253 of file otbWrapperParameter.h.

bool otb::Wrapper::Parameter::m_UserValue

protectedinherited

True if the value is set in user mode

Definition at line 245 of file otbWrapperParameter.h.

Referenced by otb::Wrapper::Parameter::HasUserValue(), and otb::Wrapper::Parameter::SetUserValue().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation