Published Objects Declaration

Table of Contents

• About
• Declaration
• Further Reading

About

A published object is declared in a header file. Every source code file that includes this header file can then access this published object.

Declaration

A published object is declared with the MAXON_DECLARATION attribute. Only instances of Maxon API data types can be published this way. A custom class has to be registered as a data type using MAXON_DATATYPE and MAXON_DATATYPE_REGISTER (see MAXON Data Type). Implementations of interfaces are a data type so they can be shared as a published object.

// This example declares some custom data type. Individual instances
// of this data type are presented as published objects.
 
// ---------------------------------------------------------------------
// The custom data type SimpleAtom represents a simple atom model.
// ---------------------------------------------------------------------
class SimpleAtom
{
public:
  SimpleAtom()
  {
    _protonCnt   = 1;
    _neutronCnt  = 0;
    _electronCnt = 1;
  };
 
  maxon::Int _protonCnt;    
  maxon::Int _neutronCnt;   
  maxon::Int _electronCnt;  
};
 
// register as MAXON data type
MAXON_DATATYPE(SimpleAtom, "net.maxonexample.datatype.simpleatom");
 
#include "example_declarations1.hxx"
 
// register individual instances of the data type as published objects
 
MAXON_DECLARATION(SimpleAtom, Carbon, "net.maxonexample.atoms.carbon");
MAXON_DECLARATION(SimpleAtom, Oxygen, "net.maxonexample.atoms.oxygen");
MAXON_DECLARATION(SimpleAtom, Iron, "net.maxonexample.atoms.iron");
 
#include "example_declarations2.hxx"

Further Reading

• Published Objects
• Published Objects Implementation
• Published Objects Usage
• MAXON Data Type