fwActivities::registry::ActivityInfo Struct Reference

Holds Activities configuration. More...

#include <Activities.hpp>

Collaboration diagram for fwActivities::registry::ActivityInfo:

Public Types
typedef std::vector< ActivityRequirement >	RequirementsType
typedef std::pair< unsigned int, unsigned int >	MinMaxType
typedef std::map< std::string, MinMaxType >	RequirementsMinMaxCount
typedef std::map< std::string, unsigned int >	DataCountType

Public Member Functions
FWACTIVITIES_API	ActivityInfo (const std::shared_ptr< ::fwRuntime::Extension > &ext)
FWACTIVITIES_API bool	usableWith (DataCountType dataCount) const

Public Attributes
std::string	id
std::string	title
std::string	description
std::string	icon
std::string	tabInfo
RequirementsType	requirements
std::string	builderImpl
std::string	bundleId
	Identifier of the bundle containing the activity.
std::string	bundleVersion
	Version of the bundle containing the activity.
std::vector< std::string >	validatorsImpl
	Validator implementations.
ActivityAppConfig	appConfig

Protected Attributes
RequirementsMinMaxCount	m_requirementCount

Detailed Description

Holds Activities configuration.

Activity parameters are (in this order) :

• id : activity id
• title : activity title (displayed in tab if tabinfo isn't specified)
• tabinfo : activity title (displayed in tab)
• desc : activity description
• icon : path to the icon activity
• requirements : required elements to launch specified activity (must be present in vector selection)
  • requirement : a required element
    • name : element key in ActivitySeries composite
    • type : object type
    • minOccurs (optional, default value = 1) : minimal number of object (with specified type) in vector
    • maxOccurs (optional, default value = 1) : maximal number of object (with specified type) in vector
      • key : if maxOccurs > 1, then you must defined keys for each objects
    • container (optional, default value = composite) : container type (vector or composite) to store required parameters
    • create (optional) : true if the data must be created if it is not present (only available if minOccurs = 0 and maxOccurs = 1)
    • desc (optional) : description of the requirement
    • validator (optional) : validate the current data
• builder (optional): implementation of builder associate to the activity, the builder creates ActivitySeries.
  • default builder is fwActivities::builder::ActivitySeries
• validator (optional): check if specified activity can be launched with selected objects
• validators (optional) : defines validators implementations instantiated to validate activity launch
  • validator : implementation name for a validator
• appConfig : defined AppConfig launched by this activity
  • id : AppConfig id
  • parameters : parameters required by the AppConfig
    • parameter : defined an AppConfig parameter
      • replace : parameter name to replace in AppConfig
      • by : value to use for replacement (can be a string or sesh@ path)

Example of activity configuration:

 <extension implements="::fwActivities::registry::Activities">
     <id>3DVisualization</id>
     <title>3D Visu</title>
     <tabinfo>3D MPR - !values.modelSeries.patient.name</tabinfo>
     <desc>Activity description ...</desc>
     <icon>media-0.1/icons/icon-3D.png</icon>
     <requirements>
         <requirement name="param1" type="::fwData::Image" /> <!-- defaults : minOccurs = 1, maxOccurs = 1-->
         <requirement name="param2" type="::fwData::Mesh" maxOccurs="3" >
             <key>Item1</key>
             <key>Item2</key>
             <key>Item3</key>
         </requirement>
         <requirement name="param3" type="::fwData::Mesh" maxOccurs="*" container="vector" />
         <requirement name="imageSeries" type="::fwMedData::ImageSeries" minOccurs="0" maxOccurs="2" />
         <requirement name="modelSeries" type="::fwMedData::ModelSeries" minOccurs="1" maxOccurs="1">
              <desc>Description of the required data....</desc>
              <validator>::fwActivities::validator::ImageProperties</validator>
         </requirement>
         <requirement name="transformationMatrix" type="::fwData::TransformationMatrix3D" minOccurs="0" maxOccurs="1"
create="true" />
         <!--# ...-->
     </requirements>
     <builder>::fwActivities::builder::ActivitySeries</builder>
     <validators>
         <validator>::fwActivities::validator::RelatedStudy</validator>
     </validators>
     <appConfig id="3DVisualization">
         <parameters>
             <parameter replace="registeredImageUid" by="@values.param1" />
             <parameter replace="orientation" by="frontal" />
             <!--# ...-->
         </parameters>
     </appConfig>
 </extension>

Definition at line 175 of file Activities.hpp.

---

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

• Activities.hpp
• Activities.cpp