Dev Essential
Loading...
Searching...
No Matches
ddl::mapping::datamodel::Target Class Reference

Datamodel target class within MappingConfiguration. More...

#include <datamodel_configuration_items.h>

Inherits ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >, and ddl::dd::datamodel::InfoMap.

Public Types

using Properties = ddl::utility::TypeAccessMap<Property, Target>
 Properties type within the target.
 
using Triggers = ddl::utility::TypeAccessVector<Trigger, Target>
 Triggers type within the target.
 
using Assignments = ddl::utility::TypeAccessList<Assignment, Target>
 Assignments type within the target.
 
- Public Types inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 
typedef TypeAccessMapEventCode event_code_type
 local definition of the event code type
 
typedef T subject_type
 local definition of the subject type
 
typedef ModelObserverUtility< T, TypeAccessMapEventCodeobserver_type
 local definition of the observer type to notify
 

Public Member Functions

 Target ()=delete
 no CTOR
 
 Target (const Target &other)
 copy CTOR
 
 Target (Target &&other)
 move CTOR
 
 Target (const std::string &name, const std::string &type, const std::vector< Property > &properties={})
 CTOR.
 
 ~Target ()
 DTOR.
 
Targetoperator= (const Target &other)
 copy operator
 
Targetoperator= (Target &&other)
 move operator
 
bool operator== (const Target &other) const
 equality operator
 
bool operator!= (const Target &other) const
 inequality operator
 
const std::string & getName () const
 Get the name.
 
void setName (const std::string &name)
 Set the name of the target instance to create.
 
const std::string & getType () const
 Get the type of the target instance to create.
 
void setType (const std::string &type)
 Set the type.
 
const PropertiesgetProperties () const
 Get the Properties.
 
PropertiesgetProperties ()
 Get the Properties.
 
const TriggersgetTriggers () const
 Get the Triggers.
 
TriggersgetTriggers ()
 Get the Triggers.
 
const AssignmentsgetAssignments () const
 Get the Assignments.
 
AssignmentsgetAssignments ()
 Get the Assignments.
 
- Public Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
 ModelSubjectUtility ()=default
 CTOR.
 
 ModelSubjectUtility (const ModelSubjectUtility &)
 copy CTOR which removes the observers in case of!
 
ModelSubjectUtilityoperator= (const ModelSubjectUtility &)
 copy assignment operator which removes the observers in case of!
 
virtual ~ModelSubjectUtility ()=default
 DTOR.
 
void attachObserver (observer_type *observer)
 adda a observer to notify.
 
void detachObserver (observer_type *observer)
 remove a observer if in list.
 
- Public Member Functions inherited from ddl::dd::datamodel::InfoMap
 InfoMap ()=default
 CTOR.
 
 InfoMap (const InfoMap &)
 copy CTOR
 
 InfoMap (InfoMap &&)
 move CTOR
 
InfoMapoperator= (const InfoMap &)
 copy assignment operator
 
InfoMapoperator= (InfoMap &&)
 move assignment operator
 
template<typename INFO_T>
const INFO_T * getInfo () const
 Get the Info Pointer.
 
template<typename INFO_T>
INFO_T * getInfo ()
 Get the Info Pointer.
 
template<typename INFO_T>
void setInfo (const std::shared_ptr< INFO_T > &info)
 Set the Info object as shared pointer.
 

Additional Inherited Members

- Protected Member Functions inherited from ddl::dd::utility::ModelSubjectUtility< T, TypeAccessMapEventCode >
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 
void notifyChanged (event_code_type event_code, subject_type &changed_subject, const std::string &additional_info)
 helper utility function to notify the current observers
 

Detailed Description

Datamodel target class within MappingConfiguration.

Remarks
This class is observable within a ddl::dd::utility::TypeAccessMap

Constructor & Destructor Documentation

◆ Target() [1/3]

ddl::mapping::datamodel::Target::Target ( const Target & other)

copy CTOR

Parameters
otherthe object to copy

◆ Target() [2/3]

ddl::mapping::datamodel::Target::Target ( Target && other)

move CTOR

Parameters
otherthe object to move

◆ Target() [3/3]

ddl::mapping::datamodel::Target::Target ( const std::string & name,
const std::string & type,
const std::vector< Property > & properties = {} )

CTOR.

Parameters
namethe name
typethe type
propertiesthe properties

Member Function Documentation

◆ getAssignments() [1/2]

Assignments & ddl::mapping::datamodel::Target::getAssignments ( )

Get the Assignments.

Returns
Assignments&

◆ getAssignments() [2/2]

const Assignments & ddl::mapping::datamodel::Target::getAssignments ( ) const

Get the Assignments.

Returns
const Assignments&

◆ getName()

const std::string & ddl::mapping::datamodel::Target::getName ( ) const

Get the name.

Returns
const std::string&

◆ getProperties() [1/2]

Properties & ddl::mapping::datamodel::Target::getProperties ( )

Get the Properties.

Returns
Properties&

◆ getProperties() [2/2]

const Properties & ddl::mapping::datamodel::Target::getProperties ( ) const

Get the Properties.

Returns
const Properties&

◆ getTriggers() [1/2]

Triggers & ddl::mapping::datamodel::Target::getTriggers ( )

Get the Triggers.

Returns
Triggers&

◆ getTriggers() [2/2]

const Triggers & ddl::mapping::datamodel::Target::getTriggers ( ) const

Get the Triggers.

Returns
const Triggers&

◆ getType()

const std::string & ddl::mapping::datamodel::Target::getType ( ) const

Get the type of the target instance to create.

Returns
const std::string&

◆ operator!=()

bool ddl::mapping::datamodel::Target::operator!= ( const Target & other) const

inequality operator

Parameters
otherthe other object to compare
Returns
true is not equal
false is equal

◆ operator=() [1/2]

Target & ddl::mapping::datamodel::Target::operator= ( const Target & other)

copy operator

Parameters
otherthe object to copy
Returns
Target&

◆ operator=() [2/2]

Target & ddl::mapping::datamodel::Target::operator= ( Target && other)

move operator

Parameters
otherthe object to move
Returns
Target&

◆ operator==()

bool ddl::mapping::datamodel::Target::operator== ( const Target & other) const

equality operator

Parameters
otherthe other object to compare
Returns
true is equal
false is not equal

◆ setName()

void ddl::mapping::datamodel::Target::setName ( const std::string & name)

Set the name of the target instance to create.

Parameters
namethe name
Remarks
This change is observable

◆ setType()

void ddl::mapping::datamodel::Target::setType ( const std::string & type)

Set the type.

Parameters
typethe type
Remarks
This change is observable

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